title | description | author | ms.author | ms.topic | ms.date | ms.reviewer | audience | ms.search.region |
---|---|---|---|---|---|---|---|---|
ListDesign type |
Learn about the list design object type, which includes the alignItems, alignSelf, allowScroll, background, bindings, and other properties. |
jasongre |
jasongre |
article |
05/24/2022 |
johnmichalak |
Developer |
Global |
[!include banner] [!include mobile app deprecated]
List design object type.
ContainerControlDesign
└─ ListDesign
- alignItems
- alignSelf
- allowScroll
- background
- bindings
- border
- color
- design
- flexFlow
- flexSize
- fontSize
- fontWeight
- hideArrow
- hideSearchBar
- itemBorder
- items
- justifyItems
- label
- labelPosition
- name
- padding
- type
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: string (optional)
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: 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:
Inherited from ContainerControlDesign.background
bindings: any (optional)
border: "none" | "solid" | "left" | "right" | "top" | "bottom" (optional)
The border behavior of a control. This property will not be inherited by the children.
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:
design: GroupDesign (optional)
The design object that will be applied to each row.
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.
flexSize: string (optional)
One number or two numbers written as a string. For example, "(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.
fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (optional)
The proportional text size
fontWeight: "normal" | "bold" (optional)
Normal or bold text.
Inherited from Design.fontWeight
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: boolean (optional)
If true, the search bar will be hidden.
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: string | Design [ ] (optional)
An array containing the components to place inside of the container.
Inherited from ContainerControlDesign.items
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: string (optional)
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: string (optional)
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.
type: ControlType (optional)
The type of the control as a string.
[!INCLUDEfooter-include]