Favorites
Scrubber
From KickApps Documentation
The scrubber component is used in conjunction with the video and audio players to change positions in the video or audio track that's currently playing.
Contents |
Properties
Properties are configurable aspects of a component that let you customize the way it looks and how it works by changing their values in its configuration panel in the App Studio. You can also use JavaScript to change widget properties after the widget loads on a page using the setComponentProperty() method method of the Widget JavaScript API. Finally, you can use widget property values in Actions using our bracket literal syntax. For a listing of all properties on components, see our Properties Reference.
- Layout
- Horizontal
- Vertical
- Handle Dimensions
- Width
- Height
Background & Border
The play progress bar, load progress bar, handle, and background elements of the scrubber can all be styled individually, with the following options:
- Icon URL
- Enter the URL to an image file in .jpg, .gif, or .png format, or click Browse to open the App Studio Assets window. You can select an image from your App Studio Assets by double-clicking on its icon, or upload a new image by clicking Add. Your selected image will be centered horizontally and vertically within the selected component.
The scrubber component is used in conjunction with the video and audio players to change positions in the video or audio track that's currently playing.
Properties
- Layout
- Horizontal
- Vertical
- Handle Dimensions
- Width
- Height
Background & Border
The play progress bar, load progress bar, handle, and background elements of the scrubber can all be styled individually, with the following options:
- Icon URL
- Enter the URL to an image file in .jpg, .gif, or .png format, or click Browse to open the App Studio Assets window. You can select an image from your App Studio Assets by double-clicking on its icon, or upload a new image by clicking Add. Your selected image will be centered horizontally and vertically within the selected component.
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".
You can configure a container's background color, opacity, border color, border thickness, corner radius, and background image in its Properties panel:
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:
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:
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:
If you then resize this container, the component maintains its distance from the left side:
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:
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.
This component is anchored to the vertical center of its container. It maintains its distance from the vertical center when its container is resized.
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.
The component below is anchored to both the top and bottom sides of its container. It contracts when its container is resized.
Events
Standard Events
- Click
- Component hidden
- Component loaded
- Component shown
- Double click
- Mouse down
- Mouse up
- Roll out
- Roll over
Actions
Standard Actions
- Drag/Stop Drag
- Set depth
- Show/Hide
- Tween Blur
- Tween Color
- Tween Drop Shadow
- Tween Glow
- Tween Property
- Update Property
- For a listing of all properties on components, see our Properties Reference.
Note on the play progress bar's size
The length of the play progress bar depends on whether there is a scrubber handle. If you'd rather not have a scrubber handle (you don't need one; users can click anywhere in the scrubber to move around), you can set the scrubber handle's width to zero. If you do have a scrubber handle, the play progress bar will extend halfway into that handle. The play progress bar is designed this way so that you can make spherical or other scrubber handles that require transparency on the right side of the handle, without having the play progress bar show through that right side, which makes it look like the handle is behind the playhead.
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".
You can configure a container's background color, opacity, border color, border thickness, corner radius, and background image in its Properties panel:
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:
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:
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:
If you then resize this container, the component maintains its distance from the left side:
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:
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.
This component is anchored to the vertical center of its container. It maintains its distance from the vertical center when its container is resized.
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.
The component below is anchored to both the top and bottom sides of its container. It contracts when its container is resized.
Events
Standard Events
- Click
- Component hidden
- Component loaded
- Component shown
- Double click
- Mouse down
- Mouse up
- Roll out
- Roll over
Actions
Standard Actions
- Drag/Stop Drag
- Set depth
- Show/Hide
- Tween Blur
- Tween Color
- Tween Drop Shadow
- Tween Glow
- Tween Property
- Update Property
- For a listing of all properties on components, see our Properties Reference.
