divkit.dsl.Pager.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-json-builder Show documentation
Show all versions of kotlin-json-builder Show documentation
DivKit is an open source Server-Driven UI (SDUI) framework. SDUI is a an emerging technique that leverage the server to build the user interfaces of their mobile app.
@file:Suppress(
"unused",
"UNUSED_PARAMETER",
)
package divkit.dsl
import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonValue
import divkit.dsl.annotation.*
import divkit.dsl.core.*
import divkit.dsl.scope.*
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map
/**
* Pager. It contains a horizontal set of cards that can be scrolled page by page. It shows the main page and the beginning of the next one.
*
* Can be created using the method [pager].
*
* Required parameters: `type, layout_mode`.
*/
@Generated
class Pager internal constructor(
@JsonIgnore
val properties: Properties,
) : Div {
@JsonAnyGetter
internal fun getJsonProperties(): Map = properties.mergeWith(
mapOf("type" to "pager")
)
operator fun plus(additive: Properties): Pager = Pager(
Properties(
accessibility = additive.accessibility ?: properties.accessibility,
alignmentHorizontal = additive.alignmentHorizontal ?: properties.alignmentHorizontal,
alignmentVertical = additive.alignmentVertical ?: properties.alignmentVertical,
alpha = additive.alpha ?: properties.alpha,
background = additive.background ?: properties.background,
border = additive.border ?: properties.border,
columnSpan = additive.columnSpan ?: properties.columnSpan,
defaultItem = additive.defaultItem ?: properties.defaultItem,
disappearActions = additive.disappearActions ?: properties.disappearActions,
extensions = additive.extensions ?: properties.extensions,
focus = additive.focus ?: properties.focus,
height = additive.height ?: properties.height,
id = additive.id ?: properties.id,
infiniteScroll = additive.infiniteScroll ?: properties.infiniteScroll,
itemBuilder = additive.itemBuilder ?: properties.itemBuilder,
itemSpacing = additive.itemSpacing ?: properties.itemSpacing,
items = additive.items ?: properties.items,
layoutMode = additive.layoutMode ?: properties.layoutMode,
layoutProvider = additive.layoutProvider ?: properties.layoutProvider,
margins = additive.margins ?: properties.margins,
orientation = additive.orientation ?: properties.orientation,
paddings = additive.paddings ?: properties.paddings,
pageTransformation = additive.pageTransformation ?: properties.pageTransformation,
restrictParentScroll = additive.restrictParentScroll ?: properties.restrictParentScroll,
reuseId = additive.reuseId ?: properties.reuseId,
rowSpan = additive.rowSpan ?: properties.rowSpan,
selectedActions = additive.selectedActions ?: properties.selectedActions,
tooltips = additive.tooltips ?: properties.tooltips,
transform = additive.transform ?: properties.transform,
transitionChange = additive.transitionChange ?: properties.transitionChange,
transitionIn = additive.transitionIn ?: properties.transitionIn,
transitionOut = additive.transitionOut ?: properties.transitionOut,
transitionTriggers = additive.transitionTriggers ?: properties.transitionTriggers,
variables = additive.variables ?: properties.variables,
visibility = additive.visibility ?: properties.visibility,
visibilityAction = additive.visibilityAction ?: properties.visibilityAction,
visibilityActions = additive.visibilityActions ?: properties.visibilityActions,
width = additive.width ?: properties.width,
)
)
class Properties internal constructor(
/**
* Accessibility settings.
*/
val accessibility: Property?,
/**
* Horizontal alignment of an element inside the parent element.
*/
val alignmentHorizontal: Property?,
/**
* Vertical alignment of an element inside the parent element.
*/
val alignmentVertical: Property?,
/**
* Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* Default value: `1.0`.
*/
val alpha: Property?,
/**
* Element background. It can contain multiple layers.
*/
val background: Property>?,
/**
* Element stroke.
*/
val border: Property?,
/**
* Merges cells in a column of the [grid](div-grid.md) element.
*/
val columnSpan: Property?,
/**
* Ordinal number of the pager element that will be opened by default.
* Default value: `0`.
*/
val defaultItem: Property?,
/**
* Actions when an element disappears from the screen.
*/
val disappearActions: Property>?,
/**
* Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
*/
val extensions: Property>?,
/**
* Parameters when focusing on an element or losing focus.
*/
val focus: Property?,
/**
* Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* Default value: `{"type": "wrap_content"}`.
*/
val height: Property?,
/**
* Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
*/
val id: Property?,
/**
* Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* Default value: `false`.
*/
val infiniteScroll: Property?,
/**
* Sets collection elements dynamically using `data` and `prototypes`.
*/
val itemBuilder: Property?,
/**
* Spacing between elements.
* Default value: `{"type": "fixed","value":0}`.
*/
val itemSpacing: Property?,
/**
* Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
*/
val items: Property>?,
/**
* Type of calculation of the main page width:`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
*/
val layoutMode: Property?,
/**
* Provides element real size values after a layout cycle.
*/
val layoutProvider: Property?,
/**
* External margins from the element stroke.
*/
val margins: Property?,
/**
* Pager orientation.
* Default value: `horizontal`.
*/
val orientation: Property?,
/**
* Internal margins from the element stroke.
*/
val paddings: Property?,
/**
* Page transformation during movement.
*/
val pageTransformation: Property?,
/**
* If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* Default value: `false`.
*/
val restrictParentScroll: Property?,
/**
* Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
*/
val reuseId: Property?,
/**
* Merges cells in a string of the [grid](div-grid.md) element.
*/
val rowSpan: Property?,
/**
* List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
*/
val selectedActions: Property>?,
/**
* Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
*/
val tooltips: Property>?,
/**
* Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
*/
val transform: Property?,
/**
* Change animation. It is played when the position or size of an element changes in the new layout.
*/
val transitionChange: Property?,
/**
* Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
*/
val transitionIn: Property?,
/**
* Disappearance animation. It is played when an element disappears in the new layout.
*/
val transitionOut: Property?,
/**
* Animation starting triggers. Default value: `[state_change, visibility_change]`.
*/
val transitionTriggers: Property>>?,
/**
* Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
*/
val variables: Property>?,
/**
* Element visibility.
* Default value: `visible`.
*/
val visibility: Property?,
/**
* Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
*/
val visibilityAction: Property?,
/**
* Actions when an element appears on the screen.
*/
val visibilityActions: Property>?,
/**
* Element width.
* Default value: `{"type": "match_parent"}`.
*/
val width: Property?,
) {
internal fun mergeWith(properties: Map): Map {
val result = mutableMapOf()
result.putAll(properties)
result.tryPutProperty("accessibility", accessibility)
result.tryPutProperty("alignment_horizontal", alignmentHorizontal)
result.tryPutProperty("alignment_vertical", alignmentVertical)
result.tryPutProperty("alpha", alpha)
result.tryPutProperty("background", background)
result.tryPutProperty("border", border)
result.tryPutProperty("column_span", columnSpan)
result.tryPutProperty("default_item", defaultItem)
result.tryPutProperty("disappear_actions", disappearActions)
result.tryPutProperty("extensions", extensions)
result.tryPutProperty("focus", focus)
result.tryPutProperty("height", height)
result.tryPutProperty("id", id)
result.tryPutProperty("infinite_scroll", infiniteScroll)
result.tryPutProperty("item_builder", itemBuilder)
result.tryPutProperty("item_spacing", itemSpacing)
result.tryPutProperty("items", items)
result.tryPutProperty("layout_mode", layoutMode)
result.tryPutProperty("layout_provider", layoutProvider)
result.tryPutProperty("margins", margins)
result.tryPutProperty("orientation", orientation)
result.tryPutProperty("paddings", paddings)
result.tryPutProperty("page_transformation", pageTransformation)
result.tryPutProperty("restrict_parent_scroll", restrictParentScroll)
result.tryPutProperty("reuse_id", reuseId)
result.tryPutProperty("row_span", rowSpan)
result.tryPutProperty("selected_actions", selectedActions)
result.tryPutProperty("tooltips", tooltips)
result.tryPutProperty("transform", transform)
result.tryPutProperty("transition_change", transitionChange)
result.tryPutProperty("transition_in", transitionIn)
result.tryPutProperty("transition_out", transitionOut)
result.tryPutProperty("transition_triggers", transitionTriggers)
result.tryPutProperty("variables", variables)
result.tryPutProperty("visibility", visibility)
result.tryPutProperty("visibility_action", visibilityAction)
result.tryPutProperty("visibility_actions", visibilityActions)
result.tryPutProperty("width", width)
return result
}
}
/**
* Pager orientation.
*
* Possible values: [horizontal], [vertical].
*/
@Generated
sealed interface Orientation
}
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`.
The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun DivScope.pager(
`use named arguments`: Guard = Guard.instance,
accessibility: Accessibility? = null,
alignmentHorizontal: AlignmentHorizontal? = null,
alignmentVertical: AlignmentVertical? = null,
alpha: Double? = null,
background: List? = null,
border: Border? = null,
columnSpan: Int? = null,
defaultItem: Int? = null,
disappearActions: List? = null,
extensions: List? = null,
focus: Focus? = null,
height: Size? = null,
id: String? = null,
infiniteScroll: Boolean? = null,
itemBuilder: CollectionItemBuilder? = null,
itemSpacing: FixedSize? = null,
items: List? = null,
layoutMode: PagerLayoutMode? = null,
layoutProvider: LayoutProvider? = null,
margins: EdgeInsets? = null,
orientation: Pager.Orientation? = null,
paddings: EdgeInsets? = null,
pageTransformation: PageTransformation? = null,
restrictParentScroll: Boolean? = null,
reuseId: String? = null,
rowSpan: Int? = null,
selectedActions: List? = null,
tooltips: List? = null,
transform: Transform? = null,
transitionChange: ChangeTransition? = null,
transitionIn: AppearanceTransition? = null,
transitionOut: AppearanceTransition? = null,
transitionTriggers: List>? = null,
variables: List? = null,
visibility: Visibility? = null,
visibilityAction: VisibilityAction? = null,
visibilityActions: List? = null,
width: Size? = null,
): Pager = Pager(
Pager.Properties(
accessibility = valueOrNull(accessibility),
alignmentHorizontal = valueOrNull(alignmentHorizontal),
alignmentVertical = valueOrNull(alignmentVertical),
alpha = valueOrNull(alpha),
background = valueOrNull(background),
border = valueOrNull(border),
columnSpan = valueOrNull(columnSpan),
defaultItem = valueOrNull(defaultItem),
disappearActions = valueOrNull(disappearActions),
extensions = valueOrNull(extensions),
focus = valueOrNull(focus),
height = valueOrNull(height),
id = valueOrNull(id),
infiniteScroll = valueOrNull(infiniteScroll),
itemBuilder = valueOrNull(itemBuilder),
itemSpacing = valueOrNull(itemSpacing),
items = valueOrNull(items),
layoutMode = valueOrNull(layoutMode),
layoutProvider = valueOrNull(layoutProvider),
margins = valueOrNull(margins),
orientation = valueOrNull(orientation),
paddings = valueOrNull(paddings),
pageTransformation = valueOrNull(pageTransformation),
restrictParentScroll = valueOrNull(restrictParentScroll),
reuseId = valueOrNull(reuseId),
rowSpan = valueOrNull(rowSpan),
selectedActions = valueOrNull(selectedActions),
tooltips = valueOrNull(tooltips),
transform = valueOrNull(transform),
transitionChange = valueOrNull(transitionChange),
transitionIn = valueOrNull(transitionIn),
transitionOut = valueOrNull(transitionOut),
transitionTriggers = valueOrNull(transitionTriggers),
variables = valueOrNull(variables),
visibility = valueOrNull(visibility),
visibilityAction = valueOrNull(visibilityAction),
visibilityActions = valueOrNull(visibilityActions),
width = valueOrNull(width),
)
)
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun DivScope.pagerProps(
`use named arguments`: Guard = Guard.instance,
accessibility: Accessibility? = null,
alignmentHorizontal: AlignmentHorizontal? = null,
alignmentVertical: AlignmentVertical? = null,
alpha: Double? = null,
background: List? = null,
border: Border? = null,
columnSpan: Int? = null,
defaultItem: Int? = null,
disappearActions: List? = null,
extensions: List? = null,
focus: Focus? = null,
height: Size? = null,
id: String? = null,
infiniteScroll: Boolean? = null,
itemBuilder: CollectionItemBuilder? = null,
itemSpacing: FixedSize? = null,
items: List? = null,
layoutMode: PagerLayoutMode? = null,
layoutProvider: LayoutProvider? = null,
margins: EdgeInsets? = null,
orientation: Pager.Orientation? = null,
paddings: EdgeInsets? = null,
pageTransformation: PageTransformation? = null,
restrictParentScroll: Boolean? = null,
reuseId: String? = null,
rowSpan: Int? = null,
selectedActions: List? = null,
tooltips: List? = null,
transform: Transform? = null,
transitionChange: ChangeTransition? = null,
transitionIn: AppearanceTransition? = null,
transitionOut: AppearanceTransition? = null,
transitionTriggers: List>? = null,
variables: List? = null,
visibility: Visibility? = null,
visibilityAction: VisibilityAction? = null,
visibilityActions: List? = null,
width: Size? = null,
) = Pager.Properties(
accessibility = valueOrNull(accessibility),
alignmentHorizontal = valueOrNull(alignmentHorizontal),
alignmentVertical = valueOrNull(alignmentVertical),
alpha = valueOrNull(alpha),
background = valueOrNull(background),
border = valueOrNull(border),
columnSpan = valueOrNull(columnSpan),
defaultItem = valueOrNull(defaultItem),
disappearActions = valueOrNull(disappearActions),
extensions = valueOrNull(extensions),
focus = valueOrNull(focus),
height = valueOrNull(height),
id = valueOrNull(id),
infiniteScroll = valueOrNull(infiniteScroll),
itemBuilder = valueOrNull(itemBuilder),
itemSpacing = valueOrNull(itemSpacing),
items = valueOrNull(items),
layoutMode = valueOrNull(layoutMode),
layoutProvider = valueOrNull(layoutProvider),
margins = valueOrNull(margins),
orientation = valueOrNull(orientation),
paddings = valueOrNull(paddings),
pageTransformation = valueOrNull(pageTransformation),
restrictParentScroll = valueOrNull(restrictParentScroll),
reuseId = valueOrNull(reuseId),
rowSpan = valueOrNull(rowSpan),
selectedActions = valueOrNull(selectedActions),
tooltips = valueOrNull(tooltips),
transform = valueOrNull(transform),
transitionChange = valueOrNull(transitionChange),
transitionIn = valueOrNull(transitionIn),
transitionOut = valueOrNull(transitionOut),
transitionTriggers = valueOrNull(transitionTriggers),
variables = valueOrNull(variables),
visibility = valueOrNull(visibility),
visibilityAction = valueOrNull(visibilityAction),
visibilityActions = valueOrNull(visibilityActions),
width = valueOrNull(width),
)
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun TemplateScope.pagerRefs(
`use named arguments`: Guard = Guard.instance,
accessibility: ReferenceProperty? = null,
alignmentHorizontal: ReferenceProperty? = null,
alignmentVertical: ReferenceProperty? = null,
alpha: ReferenceProperty? = null,
background: ReferenceProperty>? = null,
border: ReferenceProperty? = null,
columnSpan: ReferenceProperty? = null,
defaultItem: ReferenceProperty? = null,
disappearActions: ReferenceProperty>? = null,
extensions: ReferenceProperty>? = null,
focus: ReferenceProperty? = null,
height: ReferenceProperty? = null,
id: ReferenceProperty? = null,
infiniteScroll: ReferenceProperty? = null,
itemBuilder: ReferenceProperty? = null,
itemSpacing: ReferenceProperty? = null,
items: ReferenceProperty>? = null,
layoutMode: ReferenceProperty? = null,
layoutProvider: ReferenceProperty? = null,
margins: ReferenceProperty? = null,
orientation: ReferenceProperty? = null,
paddings: ReferenceProperty? = null,
pageTransformation: ReferenceProperty? = null,
restrictParentScroll: ReferenceProperty? = null,
reuseId: ReferenceProperty? = null,
rowSpan: ReferenceProperty? = null,
selectedActions: ReferenceProperty>? = null,
tooltips: ReferenceProperty>? = null,
transform: ReferenceProperty? = null,
transitionChange: ReferenceProperty? = null,
transitionIn: ReferenceProperty? = null,
transitionOut: ReferenceProperty? = null,
transitionTriggers: ReferenceProperty>>? = null,
variables: ReferenceProperty>? = null,
visibility: ReferenceProperty? = null,
visibilityAction: ReferenceProperty? = null,
visibilityActions: ReferenceProperty>? = null,
width: ReferenceProperty? = null,
) = Pager.Properties(
accessibility = accessibility,
alignmentHorizontal = alignmentHorizontal,
alignmentVertical = alignmentVertical,
alpha = alpha,
background = background,
border = border,
columnSpan = columnSpan,
defaultItem = defaultItem,
disappearActions = disappearActions,
extensions = extensions,
focus = focus,
height = height,
id = id,
infiniteScroll = infiniteScroll,
itemBuilder = itemBuilder,
itemSpacing = itemSpacing,
items = items,
layoutMode = layoutMode,
layoutProvider = layoutProvider,
margins = margins,
orientation = orientation,
paddings = paddings,
pageTransformation = pageTransformation,
restrictParentScroll = restrictParentScroll,
reuseId = reuseId,
rowSpan = rowSpan,
selectedActions = selectedActions,
tooltips = tooltips,
transform = transform,
transitionChange = transitionChange,
transitionIn = transitionIn,
transitionOut = transitionOut,
transitionTriggers = transitionTriggers,
variables = variables,
visibility = visibility,
visibilityAction = visibilityAction,
visibilityActions = visibilityActions,
width = width,
)
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun Pager.override(
`use named arguments`: Guard = Guard.instance,
accessibility: Accessibility? = null,
alignmentHorizontal: AlignmentHorizontal? = null,
alignmentVertical: AlignmentVertical? = null,
alpha: Double? = null,
background: List? = null,
border: Border? = null,
columnSpan: Int? = null,
defaultItem: Int? = null,
disappearActions: List? = null,
extensions: List? = null,
focus: Focus? = null,
height: Size? = null,
id: String? = null,
infiniteScroll: Boolean? = null,
itemBuilder: CollectionItemBuilder? = null,
itemSpacing: FixedSize? = null,
items: List? = null,
layoutMode: PagerLayoutMode? = null,
layoutProvider: LayoutProvider? = null,
margins: EdgeInsets? = null,
orientation: Pager.Orientation? = null,
paddings: EdgeInsets? = null,
pageTransformation: PageTransformation? = null,
restrictParentScroll: Boolean? = null,
reuseId: String? = null,
rowSpan: Int? = null,
selectedActions: List? = null,
tooltips: List? = null,
transform: Transform? = null,
transitionChange: ChangeTransition? = null,
transitionIn: AppearanceTransition? = null,
transitionOut: AppearanceTransition? = null,
transitionTriggers: List>? = null,
variables: List? = null,
visibility: Visibility? = null,
visibilityAction: VisibilityAction? = null,
visibilityActions: List? = null,
width: Size? = null,
): Pager = Pager(
Pager.Properties(
accessibility = valueOrNull(accessibility) ?: properties.accessibility,
alignmentHorizontal = valueOrNull(alignmentHorizontal) ?: properties.alignmentHorizontal,
alignmentVertical = valueOrNull(alignmentVertical) ?: properties.alignmentVertical,
alpha = valueOrNull(alpha) ?: properties.alpha,
background = valueOrNull(background) ?: properties.background,
border = valueOrNull(border) ?: properties.border,
columnSpan = valueOrNull(columnSpan) ?: properties.columnSpan,
defaultItem = valueOrNull(defaultItem) ?: properties.defaultItem,
disappearActions = valueOrNull(disappearActions) ?: properties.disappearActions,
extensions = valueOrNull(extensions) ?: properties.extensions,
focus = valueOrNull(focus) ?: properties.focus,
height = valueOrNull(height) ?: properties.height,
id = valueOrNull(id) ?: properties.id,
infiniteScroll = valueOrNull(infiniteScroll) ?: properties.infiniteScroll,
itemBuilder = valueOrNull(itemBuilder) ?: properties.itemBuilder,
itemSpacing = valueOrNull(itemSpacing) ?: properties.itemSpacing,
items = valueOrNull(items) ?: properties.items,
layoutMode = valueOrNull(layoutMode) ?: properties.layoutMode,
layoutProvider = valueOrNull(layoutProvider) ?: properties.layoutProvider,
margins = valueOrNull(margins) ?: properties.margins,
orientation = valueOrNull(orientation) ?: properties.orientation,
paddings = valueOrNull(paddings) ?: properties.paddings,
pageTransformation = valueOrNull(pageTransformation) ?: properties.pageTransformation,
restrictParentScroll = valueOrNull(restrictParentScroll) ?: properties.restrictParentScroll,
reuseId = valueOrNull(reuseId) ?: properties.reuseId,
rowSpan = valueOrNull(rowSpan) ?: properties.rowSpan,
selectedActions = valueOrNull(selectedActions) ?: properties.selectedActions,
tooltips = valueOrNull(tooltips) ?: properties.tooltips,
transform = valueOrNull(transform) ?: properties.transform,
transitionChange = valueOrNull(transitionChange) ?: properties.transitionChange,
transitionIn = valueOrNull(transitionIn) ?: properties.transitionIn,
transitionOut = valueOrNull(transitionOut) ?: properties.transitionOut,
transitionTriggers = valueOrNull(transitionTriggers) ?: properties.transitionTriggers,
variables = valueOrNull(variables) ?: properties.variables,
visibility = valueOrNull(visibility) ?: properties.visibility,
visibilityAction = valueOrNull(visibilityAction) ?: properties.visibilityAction,
visibilityActions = valueOrNull(visibilityActions) ?: properties.visibilityActions,
width = valueOrNull(width) ?: properties.width,
)
)
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun Pager.defer(
`use named arguments`: Guard = Guard.instance,
accessibility: ReferenceProperty? = null,
alignmentHorizontal: ReferenceProperty? = null,
alignmentVertical: ReferenceProperty? = null,
alpha: ReferenceProperty? = null,
background: ReferenceProperty>? = null,
border: ReferenceProperty? = null,
columnSpan: ReferenceProperty? = null,
defaultItem: ReferenceProperty? = null,
disappearActions: ReferenceProperty>? = null,
extensions: ReferenceProperty>? = null,
focus: ReferenceProperty? = null,
height: ReferenceProperty? = null,
id: ReferenceProperty? = null,
infiniteScroll: ReferenceProperty? = null,
itemBuilder: ReferenceProperty? = null,
itemSpacing: ReferenceProperty? = null,
items: ReferenceProperty>? = null,
layoutMode: ReferenceProperty? = null,
layoutProvider: ReferenceProperty? = null,
margins: ReferenceProperty? = null,
orientation: ReferenceProperty? = null,
paddings: ReferenceProperty? = null,
pageTransformation: ReferenceProperty? = null,
restrictParentScroll: ReferenceProperty? = null,
reuseId: ReferenceProperty? = null,
rowSpan: ReferenceProperty? = null,
selectedActions: ReferenceProperty>? = null,
tooltips: ReferenceProperty>? = null,
transform: ReferenceProperty? = null,
transitionChange: ReferenceProperty? = null,
transitionIn: ReferenceProperty? = null,
transitionOut: ReferenceProperty? = null,
transitionTriggers: ReferenceProperty>>? = null,
variables: ReferenceProperty>? = null,
visibility: ReferenceProperty? = null,
visibilityAction: ReferenceProperty? = null,
visibilityActions: ReferenceProperty>? = null,
width: ReferenceProperty? = null,
): Pager = Pager(
Pager.Properties(
accessibility = accessibility ?: properties.accessibility,
alignmentHorizontal = alignmentHorizontal ?: properties.alignmentHorizontal,
alignmentVertical = alignmentVertical ?: properties.alignmentVertical,
alpha = alpha ?: properties.alpha,
background = background ?: properties.background,
border = border ?: properties.border,
columnSpan = columnSpan ?: properties.columnSpan,
defaultItem = defaultItem ?: properties.defaultItem,
disappearActions = disappearActions ?: properties.disappearActions,
extensions = extensions ?: properties.extensions,
focus = focus ?: properties.focus,
height = height ?: properties.height,
id = id ?: properties.id,
infiniteScroll = infiniteScroll ?: properties.infiniteScroll,
itemBuilder = itemBuilder ?: properties.itemBuilder,
itemSpacing = itemSpacing ?: properties.itemSpacing,
items = items ?: properties.items,
layoutMode = layoutMode ?: properties.layoutMode,
layoutProvider = layoutProvider ?: properties.layoutProvider,
margins = margins ?: properties.margins,
orientation = orientation ?: properties.orientation,
paddings = paddings ?: properties.paddings,
pageTransformation = pageTransformation ?: properties.pageTransformation,
restrictParentScroll = restrictParentScroll ?: properties.restrictParentScroll,
reuseId = reuseId ?: properties.reuseId,
rowSpan = rowSpan ?: properties.rowSpan,
selectedActions = selectedActions ?: properties.selectedActions,
tooltips = tooltips ?: properties.tooltips,
transform = transform ?: properties.transform,
transitionChange = transitionChange ?: properties.transitionChange,
transitionIn = transitionIn ?: properties.transitionIn,
transitionOut = transitionOut ?: properties.transitionOut,
transitionTriggers = transitionTriggers ?: properties.transitionTriggers,
variables = variables ?: properties.variables,
visibility = visibility ?: properties.visibility,
visibilityAction = visibilityAction ?: properties.visibilityAction,
visibilityActions = visibilityActions ?: properties.visibilityActions,
width = width ?: properties.width,
)
)
/**
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param orientation Pager orientation.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param visibility Element visibility.
*/
@Generated
fun Pager.evaluate(
`use named arguments`: Guard = Guard.instance,
alignmentHorizontal: ExpressionProperty? = null,
alignmentVertical: ExpressionProperty? = null,
alpha: ExpressionProperty? = null,
columnSpan: ExpressionProperty? = null,
defaultItem: ExpressionProperty? = null,
infiniteScroll: ExpressionProperty? = null,
orientation: ExpressionProperty? = null,
restrictParentScroll: ExpressionProperty? = null,
reuseId: ExpressionProperty? = null,
rowSpan: ExpressionProperty? = null,
visibility: ExpressionProperty? = null,
): Pager = Pager(
Pager.Properties(
accessibility = properties.accessibility,
alignmentHorizontal = alignmentHorizontal ?: properties.alignmentHorizontal,
alignmentVertical = alignmentVertical ?: properties.alignmentVertical,
alpha = alpha ?: properties.alpha,
background = properties.background,
border = properties.border,
columnSpan = columnSpan ?: properties.columnSpan,
defaultItem = defaultItem ?: properties.defaultItem,
disappearActions = properties.disappearActions,
extensions = properties.extensions,
focus = properties.focus,
height = properties.height,
id = properties.id,
infiniteScroll = infiniteScroll ?: properties.infiniteScroll,
itemBuilder = properties.itemBuilder,
itemSpacing = properties.itemSpacing,
items = properties.items,
layoutMode = properties.layoutMode,
layoutProvider = properties.layoutProvider,
margins = properties.margins,
orientation = orientation ?: properties.orientation,
paddings = properties.paddings,
pageTransformation = properties.pageTransformation,
restrictParentScroll = restrictParentScroll ?: properties.restrictParentScroll,
reuseId = reuseId ?: properties.reuseId,
rowSpan = rowSpan ?: properties.rowSpan,
selectedActions = properties.selectedActions,
tooltips = properties.tooltips,
transform = properties.transform,
transitionChange = properties.transitionChange,
transitionIn = properties.transitionIn,
transitionOut = properties.transitionOut,
transitionTriggers = properties.transitionTriggers,
variables = properties.variables,
visibility = visibility ?: properties.visibility,
visibilityAction = properties.visibilityAction,
visibilityActions = properties.visibilityActions,
width = properties.width,
)
)
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun Component.override(
`use named arguments`: Guard = Guard.instance,
accessibility: Accessibility? = null,
alignmentHorizontal: AlignmentHorizontal? = null,
alignmentVertical: AlignmentVertical? = null,
alpha: Double? = null,
background: List? = null,
border: Border? = null,
columnSpan: Int? = null,
defaultItem: Int? = null,
disappearActions: List? = null,
extensions: List? = null,
focus: Focus? = null,
height: Size? = null,
id: String? = null,
infiniteScroll: Boolean? = null,
itemBuilder: CollectionItemBuilder? = null,
itemSpacing: FixedSize? = null,
items: List? = null,
layoutMode: PagerLayoutMode? = null,
layoutProvider: LayoutProvider? = null,
margins: EdgeInsets? = null,
orientation: Pager.Orientation? = null,
paddings: EdgeInsets? = null,
pageTransformation: PageTransformation? = null,
restrictParentScroll: Boolean? = null,
reuseId: String? = null,
rowSpan: Int? = null,
selectedActions: List? = null,
tooltips: List? = null,
transform: Transform? = null,
transitionChange: ChangeTransition? = null,
transitionIn: AppearanceTransition? = null,
transitionOut: AppearanceTransition? = null,
transitionTriggers: List>? = null,
variables: List? = null,
visibility: Visibility? = null,
visibilityAction: VisibilityAction? = null,
visibilityActions: List? = null,
width: Size? = null,
): Component = Component(
template = template,
properties = Pager.Properties(
accessibility = valueOrNull(accessibility),
alignmentHorizontal = valueOrNull(alignmentHorizontal),
alignmentVertical = valueOrNull(alignmentVertical),
alpha = valueOrNull(alpha),
background = valueOrNull(background),
border = valueOrNull(border),
columnSpan = valueOrNull(columnSpan),
defaultItem = valueOrNull(defaultItem),
disappearActions = valueOrNull(disappearActions),
extensions = valueOrNull(extensions),
focus = valueOrNull(focus),
height = valueOrNull(height),
id = valueOrNull(id),
infiniteScroll = valueOrNull(infiniteScroll),
itemBuilder = valueOrNull(itemBuilder),
itemSpacing = valueOrNull(itemSpacing),
items = valueOrNull(items),
layoutMode = valueOrNull(layoutMode),
layoutProvider = valueOrNull(layoutProvider),
margins = valueOrNull(margins),
orientation = valueOrNull(orientation),
paddings = valueOrNull(paddings),
pageTransformation = valueOrNull(pageTransformation),
restrictParentScroll = valueOrNull(restrictParentScroll),
reuseId = valueOrNull(reuseId),
rowSpan = valueOrNull(rowSpan),
selectedActions = valueOrNull(selectedActions),
tooltips = valueOrNull(tooltips),
transform = valueOrNull(transform),
transitionChange = valueOrNull(transitionChange),
transitionIn = valueOrNull(transitionIn),
transitionOut = valueOrNull(transitionOut),
transitionTriggers = valueOrNull(transitionTriggers),
variables = valueOrNull(variables),
visibility = valueOrNull(visibility),
visibilityAction = valueOrNull(visibilityAction),
visibilityActions = valueOrNull(visibilityActions),
width = valueOrNull(width),
).mergeWith(properties)
)
/**
* @param accessibility Accessibility settings.
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param background Element background. It can contain multiple layers.
* @param border Element stroke.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param disappearActions Actions when an element disappears from the screen.
* @param extensions Extensions for additional processing of an element. The list of extensions is given in [DivExtension](../../extensions).
* @param focus Parameters when focusing on an element or losing focus.
* @param height Element height. For Android: if there is text in this or in a child element, specify height in `sp` to scale the element together with the text. To learn more about units of size measurement, see [Layout inside the card](../../layout).
* @param id Element ID. It must be unique within the root element. It is used as `accessibilityIdentifier` on iOS.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param itemBuilder Sets collection elements dynamically using `data` and `prototypes`.
* @param itemSpacing Spacing between elements.
* @param items Pager elements. Page-by-page transition options can be implemented using:`div-action://set_current_item?id=&item=` — set the current page with an ordinal number `item` inside an element, with the specified `id`; `div-action://set_next_item?id=[&overflow={clamp\|ring}]` — go to the next page inside an element, with the specified `id`; `div-action://set_previous_item?id=[&overflow={clamp\|ring}]` — go to the previous page inside an element, with the specified `id`. The optional `overflow` parameter is used to set navigation when the first or last element is reached:
`clamp` — transition will stop at the border element; `ring` — go to the beginning or end, depending on the current element. By default, `clamp`.
* @param layoutMode Type of calculation of the main page width:
`fixed` — from the fixed width of the next page `neighbour_page_width`; `percentage` — from the percentage value `page_width`.
* @param layoutProvider Provides element real size values after a layout cycle.
* @param margins External margins from the element stroke.
* @param orientation Pager orientation.
* @param paddings Internal margins from the element stroke.
* @param pageTransformation Page transformation during movement.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param selectedActions List of [actions](div-action.md) to be executed when selecting an element in [pager](div-pager.md).
* @param tooltips Tooltips linked to an element. A tooltip can be shown by `div-action://show_tooltip?id=`, hidden by `div-action://hide_tooltip?id=` where `id` — tooltip id.
* @param transform Applies the passed transformation to the element. Content that doesn't fit into the original view area is cut off.
* @param transitionChange Change animation. It is played when the position or size of an element changes in the new layout.
* @param transitionIn Appearance animation. It is played when an element with a new ID appears. To learn more about the concept of transitions, see [Animated transitions](../../interaction#animation/transition-animation).
* @param transitionOut Disappearance animation. It is played when an element disappears in the new layout.
* @param transitionTriggers Animation starting triggers. Default value: `[state_change, visibility_change]`.
* @param variables Definition of variables that can be used within this element. These variables, defined in the array, can only be used inside this element and its children.
* @param visibility Element visibility.
* @param visibilityAction Tracking visibility of a single element. Not used if the `visibility_actions` parameter is set.
* @param visibilityActions Actions when an element appears on the screen.
* @param width Element width.
*/
@Generated
fun Component.defer(
`use named arguments`: Guard = Guard.instance,
accessibility: ReferenceProperty? = null,
alignmentHorizontal: ReferenceProperty? = null,
alignmentVertical: ReferenceProperty? = null,
alpha: ReferenceProperty? = null,
background: ReferenceProperty>? = null,
border: ReferenceProperty? = null,
columnSpan: ReferenceProperty? = null,
defaultItem: ReferenceProperty? = null,
disappearActions: ReferenceProperty>? = null,
extensions: ReferenceProperty>? = null,
focus: ReferenceProperty? = null,
height: ReferenceProperty? = null,
id: ReferenceProperty? = null,
infiniteScroll: ReferenceProperty? = null,
itemBuilder: ReferenceProperty? = null,
itemSpacing: ReferenceProperty? = null,
items: ReferenceProperty>? = null,
layoutMode: ReferenceProperty? = null,
layoutProvider: ReferenceProperty? = null,
margins: ReferenceProperty? = null,
orientation: ReferenceProperty? = null,
paddings: ReferenceProperty? = null,
pageTransformation: ReferenceProperty? = null,
restrictParentScroll: ReferenceProperty? = null,
reuseId: ReferenceProperty? = null,
rowSpan: ReferenceProperty? = null,
selectedActions: ReferenceProperty>? = null,
tooltips: ReferenceProperty>? = null,
transform: ReferenceProperty? = null,
transitionChange: ReferenceProperty? = null,
transitionIn: ReferenceProperty? = null,
transitionOut: ReferenceProperty? = null,
transitionTriggers: ReferenceProperty>>? = null,
variables: ReferenceProperty>? = null,
visibility: ReferenceProperty? = null,
visibilityAction: ReferenceProperty? = null,
visibilityActions: ReferenceProperty>? = null,
width: ReferenceProperty? = null,
): Component = Component(
template = template,
properties = Pager.Properties(
accessibility = accessibility,
alignmentHorizontal = alignmentHorizontal,
alignmentVertical = alignmentVertical,
alpha = alpha,
background = background,
border = border,
columnSpan = columnSpan,
defaultItem = defaultItem,
disappearActions = disappearActions,
extensions = extensions,
focus = focus,
height = height,
id = id,
infiniteScroll = infiniteScroll,
itemBuilder = itemBuilder,
itemSpacing = itemSpacing,
items = items,
layoutMode = layoutMode,
layoutProvider = layoutProvider,
margins = margins,
orientation = orientation,
paddings = paddings,
pageTransformation = pageTransformation,
restrictParentScroll = restrictParentScroll,
reuseId = reuseId,
rowSpan = rowSpan,
selectedActions = selectedActions,
tooltips = tooltips,
transform = transform,
transitionChange = transitionChange,
transitionIn = transitionIn,
transitionOut = transitionOut,
transitionTriggers = transitionTriggers,
variables = variables,
visibility = visibility,
visibilityAction = visibilityAction,
visibilityActions = visibilityActions,
width = width,
).mergeWith(properties)
)
/**
* @param alignmentHorizontal Horizontal alignment of an element inside the parent element.
* @param alignmentVertical Vertical alignment of an element inside the parent element.
* @param alpha Sets transparency of the entire element: `0` — completely transparent, `1` — opaque.
* @param columnSpan Merges cells in a column of the [grid](div-grid.md) element.
* @param defaultItem Ordinal number of the pager element that will be opened by default.
* @param infiniteScroll Enables infinite scrolling of cards. Scrolling is looped: after the last card is displayed, it starts over again.
* @param orientation Pager orientation.
* @param restrictParentScroll If the parameter is enabled, the pager won't transmit the scroll gesture to the parent element.
* @param reuseId Id for the div structure. Used for more optimal reuse of blocks. See [reusing blocks](../../reuse/reuse.md)
* @param rowSpan Merges cells in a string of the [grid](div-grid.md) element.
* @param visibility Element visibility.
*/
@Generated
fun Component.evaluate(
`use named arguments`: Guard = Guard.instance,
alignmentHorizontal: ExpressionProperty? = null,
alignmentVertical: ExpressionProperty? = null,
alpha: ExpressionProperty? = null,
columnSpan: ExpressionProperty? = null,
defaultItem: ExpressionProperty? = null,
infiniteScroll: ExpressionProperty? = null,
orientation: ExpressionProperty? = null,
restrictParentScroll: ExpressionProperty? = null,
reuseId: ExpressionProperty? = null,
rowSpan: ExpressionProperty? = null,
visibility: ExpressionProperty? = null,
): Component = Component(
template = template,
properties = Pager.Properties(
accessibility = null,
alignmentHorizontal = alignmentHorizontal,
alignmentVertical = alignmentVertical,
alpha = alpha,
background = null,
border = null,
columnSpan = columnSpan,
defaultItem = defaultItem,
disappearActions = null,
extensions = null,
focus = null,
height = null,
id = null,
infiniteScroll = infiniteScroll,
itemBuilder = null,
itemSpacing = null,
items = null,
layoutMode = null,
layoutProvider = null,
margins = null,
orientation = orientation,
paddings = null,
pageTransformation = null,
restrictParentScroll = restrictParentScroll,
reuseId = reuseId,
rowSpan = rowSpan,
selectedActions = null,
tooltips = null,
transform = null,
transitionChange = null,
transitionIn = null,
transitionOut = null,
transitionTriggers = null,
variables = null,
visibility = visibility,
visibilityAction = null,
visibilityActions = null,
width = null,
).mergeWith(properties)
)
@Generated
operator fun Component.plus(additive: Pager.Properties): Component = Component(
template = template,
properties = additive.mergeWith(properties)
)
@Generated
fun Pager.asList() = listOf(this)
@Generated
fun Pager.Orientation.asList() = listOf(this)
© 2015 - 2024 Weber Informatics LLC | Privacy Policy