Pages Component

From KickApps Documentation

Jump to: navigation, search

The Pages component works like a Powerpoint deck. It contains multiple "pages," but only one of them is shown at a time. Each page can be filled with other components. Actions enable you to change which page is showing. The Pages component makes it much easier to encapsulate rich interactions, where many components need to be shown, hidden, or transformed.

Contents

Pages

  • The table lists the pages in your Pages component by their titles. Click on a page in the list to edit its title.
  • To add a page, type a new title into the text input beneath the table, and click Add Page.
  • Unload pages when leaving them
    • By default, once a page loads it will stay in the cache, so that it loads right away when a user comes back to it. If you would like pages to re-load (rather than load from the cache) every time the user returns to them, select "Unload pages when leaving them." This option is useful when a page is loading in dynamic content like a Twitter feed, which may have been updated in the seconds or minutes between the time when a user first loads the page and the time when they return to it. It's also useful when the Pages component is designed so that the user can't return to pages that have already loaded, and in Pages components that have many, many pages.

Settings

  • Background colors
  • Background Opacities
  • Gradient Rotation
  • Border Thickness
  • Border Colors
  • Corner Radius
  • Mask Content

Layout

There are two types of containers: the widget canvas itself (background of the entire widget) is considered a container, and you can also create containers that enclose components within your widget. Like any standard component, containers that you create can be moved around the stage, resized, and styled. The most powerful feature of Containers, though, is their ability to fix the positions of their constituent components via layout constraints, which we'll cover below. To create a container, select multiple components, right-click, and select "Group in new container".

group_in_container.png

You can configure a container's background color, opacity, border color, border thickness, corner radius, and background image in its Properties panel:

container_properties.png

You can also mask content in a container by selecting the Mask Content checkbox at the bottom of the panel above. With masking enabled, components that belong to the container but fall outside its bounds will be hidden. To indicate this, when you're editing a container that has masking enabled in Design mode, and then add a component outside the bounds of the container you're in, that component will be translucent:

component_outside_container_mask.png

Masking is useful for situations in which you want to animate a component into a container after it loads initially.

Layout Constraints

Layout constraints let you anchor components a certain distance away from the sides and axes of their containers. Components with layout constraints enabled maintain their offset distances when their containers are resized. To set layout constraints, double click on your container, then single click on a component within it. The Layout Constraints panel will appear:

layout_panel.png

The checkboxes along the top side of the square in the Layout Constraints panel can be used to anchor the selected component to the left, vertical center, and right sides of its container. The checkboxes along the left side of the square can be used to anchor the selected component to the top, horizontal center, and bottom sides of its container.

When you select a checkbox, a text input field appears across the box from it. The number in this field represents the offset distance, in pixels, from the selected side of the container. For example, this is what it looks like when you anchor to the left side:

left_narrow.png

If you then resize this container, the component maintains its distance from the left side:

left_wide.png

Similarly, you can anchor a component to the top of its container, and it will maintain its distance from the top when its container is resized:

top_short.png

top_tall.png

You can also anchor components to the horizontal and vertical center lines of their containers. This component is anchored to the horizontal center of its container. It maintains its distance from the horizontal center when its container is resized.

horz_cntr_short.png

horz_cntr_tall.png

This component is anchored to the vertical center of its container. It maintains its distance from the vertical center when its container is resized.

vert_cntr_narrow.png

vert_cntr_wide.png


Components anchored to opposite sides of their containers expand and contract to maintain their offsets. Below is a component anchored to both the left and right sides of its container. Note how it expands to maintain its distances from the left and right sides.

left_and_right_narrow.png left_and_right_wide.png

The component below is anchored to both the top and bottom sides of its container. It contracts when its container is resized.

top_bottom_tall.png


Events

Standard Events

  • Click Html-icon.png
  • Component hidden Html-icon.png
  • Component loaded Html-icon.png
  • Component shown Html-icon.png
  • Double click Html-icon.png
  • Mouse down Html-icon.png
  • Mouse up Html-icon.png
  • Roll out Html-icon.png
  • Roll over Html-icon.png

Actions

Standard Actions

  • Drag/Stop Drag
  • Set depth
  • Show/Hide Grey-apple-icon.png
  • Tween Blur
  • Tween Color
  • Tween Drop Shadow
  • Tween Glow
  • Tween Property
  • Update Property Grey-apple-icon.png


Pages Component Actions

  • Change selected page to