ListDesign Type

List design object type.

Hierarchy

ContainerControlDesign
   └─ ListDesign

Index

Properties

Properties

alignItems

alignItems: string (optional)

This property is an alias for the CSS property "align-items". Please refer to this web page for documentation on the "align-items" property.

Inherited from Design.alignItems

alignSelf

alignSelf: string (optional)

Inherited from Design.alignSelf

allowScroll

allowScroll: string (optional)

True if the container will allow scrolling when its items do not fit into the container's available space. If a container has an item which may scroll, then set this property to false to prevent nested scrolling areas.

Inherited from ContainerControlDesign.allowScroll

background

background: string (optional)

The background color of the container. Consider modifying the color attribute in the same container so that fonts overlaying the background color will appear appropriately. Note: if background is set to "theme", the theme color of the app will be used. The following colors are available:
sample image

Inherited from ContainerControlDesign.background

bindings

bindings: any (optional)

Inherited from Design.bindings

border

border: "none" | "solid" | "left" | "right" | "top" | "bottom" (optional)

The border behavior of a control. This property will not be inherited by the children.

Inherited from Design.border

color

color: string (optional)

The foreground color of the container. This will modify the color of all headers, items, labels, and icons within the container.
Consider setting the background color at the same time as necessary when setting this attribute.
Note: if color is set to "theme", the theme color of the app will be used.
The following colors are available:
sample image

Inherited from Design.color

design

design: GroupDesign (optional)

The design object that will be applied to each row.

flexFlow

flexFlow: string (optional)

Specifying this property makes the component a flex container component. This property is an alias for the CSS property "flex-flow". Please refer to this web page for documentation on the "flex-flow" property.

Inherited from Design.flexFlow

flexSize

flexSize: string (optional)

One number or two numbers written as a string. E.g. "(size to grow) [(size-to-shrink)]" to accommodate available space in the immediate flex container. This property is an alias for the CSS property "flex". Please refer to this web page for documentation on the "flex" property.

Inherited from Design.flexSize

fontSize

fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (optional)

The proportional text size

Inherited from Design.fontSize

fontWeight

fontWeight: "normal" | "bold" (optional)

Normal or bold text.

Inherited from Design.fontWeight

hideArrow

hideArrow: boolean (optional)

Allows an arrow ( > ) on a default styled navigation control to be hidden. Note that if the list has DetailsPageId, navigationHandler, or OnNavigate in the metadata then by default the arrows are present in each row of the list to show that the rows are clickable.


This property can only be added through the design object.

hideSearchBar

hideSearchBar: boolean (optional)

If true, the search bar will be hidden.

itemBorder

itemBorder: "solid" | "none" (optional)

If true, a border will appear around each row in the list. This property is equivalent to applying the border property individually to all items in the container.

Inherited from ContainerControlDesign.itemBorder

items

items: string | Design [ ] (optional)

An array containing the components to place inside of the container.

Inherited from ContainerControlDesign.items

justifyItems

justifyItems: "flex-start" | "flex-end" | "center" | "space-between" (optional)

This property is an alias for the CSS property "justify-content". Please refer to this web page for documentation on the "justify-content" property.

Inherited from Design.justifyItems

label

label: string (optional)

Inherited from Design.label

labelPosition

labelPosition: "stacked" | "hidden" | "inline" (optional)

Determines how a label is positioned, if at all. By default, labelPosition is set to stacked.

Inherited from Design.labelPosition

name

name: string (optional)

Inherited from Design.name

padding

padding: "none" | "small" | "std" (optional)

Allows specifying the component's padding behavior. A component will inherit the padding behavior specified by its parent container components.

Inherited from Design.padding

type

type: ControlType (optional)

The type of the control as a string.

Inherited from Design.type