List
A component for displaying lists with optional styling and custom rendering.Prop | Required | Description | Type |
---|---|---|---|
children | — | Component children | string | number | false | true | ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] | string & ReactElement<any, string | JSXElementConstructor<any>> | string & Iterable<ReactNode> | string & ReactPortal | number & ReactElement<any, string | JSXElementConstructor<any>> | number & Iterable<ReactNode> | number & ReactPortal | false & ReactElement<any, string | JSXElementConstructor<any>> | false & Iterable<ReactNode> | false & ReactPortal | true & ReactElement<any, string | JSXElementConstructor<any>> | true & Iterable<ReactNode> | true & ReactPortal | ReactElement<any, string | JSXElementConstructor<any>> & string | ReactElement<any, string | JSXElementConstructor<any>> & number | ReactElement<any, string | JSXElementConstructor<any>> & false | ReactElement<any, string | JSXElementConstructor<any>> & true | ReactElement<any, string | JSXElementConstructor<any>> & Iterable<ReactNode> | ReactElement<any, string | JSXElementConstructor<any>> & ReactPortal | ReactPortal & string | ReactPortal & number | ReactPortal & false | ReactPortal & true | ReactPortal & ReactElement<any, string | JSXElementConstructor<any>> | ReactPortal & Iterable<ReactNode> | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & string | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & number | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & false | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & true | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & ReactElement<any, string | JSXElementConstructor<...>> | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & Iterable<ReactNode> | { key?: string | number; ref?: null; props?: { children?: boolean | ReactChild | ReactPortal | StrictReactFragment; }; } & ReactPortal | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & string | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & number | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & false | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & true | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & ReactElement<any, string | JSXElementConstructor<any>> | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & Iterable<ReactNode> | (boolean | ReactChild | ReactPortal | StrictReactFragment)[] & ReactPortal |
type | — | (optional) Render as an unordered list or and ordered list. Defaults to ul. | "ul" | "ol" |
listStyle | — | (optional) Render with or without list styling - will render with aria roles if without to remain accessible. Defaults to initial. | "none" | "initial" |
color | — | The color property sets the text color of an element. | "themePrimaryBase" | "themePrimary100" | "themePrimary200" | "themePrimary300" | "themePrimary400" | "themePrimary500" | "themePrimary600" | "themeAccentBase" | "themeAccent100" | "themeAccent200" | "themeAccent300" | "themeAccent400" | "themeAccent500" | "themeAccent600" | "neutralSubtle" | "neutralBold" | "neutralBoldInverted" | "neutralDisabled" | "positive" | "informative" | "caution" | "critical"Supports responsive prop syntax |
height | — | The height property sets an element's height. | string | numberSupports responsive prop syntax |
width | — | The width property sets an element's width. | string | numberSupports responsive prop syntax |
minHeight | — | The minHeight property sets the minimum height of an element. It prevents the used value of the height property from becoming smaller than the value specified for minHeight. | string | numberSupports responsive prop syntax |
minWidth | — | The minWidth property sets the minimum width of an element. It prevents the used value of the width property from becoming smaller than the value specified for minWidth. | string | numberSupports responsive prop syntax |
maxHeight | — | The maxHeight CSS property sets the maximum height of an element. It prevents the used value of the height property from becoming larger than the value specified for maxHeight. | string | numberSupports responsive prop syntax |
maxWidth | — | The maxWidth CSS property sets the maximum width of an element. It prevents the used value of the width property from becoming larger than the value specified by maxWidth. | string | numberSupports responsive prop syntax |
position | — | The position property sets how an element is positioned in a document. The top, right, bottom, and left properties determine the final location of positioned elements. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "-webkit-sticky" | "absolute" | "fixed" | "relative" | "static" | "sticky"Supports responsive prop syntax |
top | — | The top property participates in specifying the vertical position of a positioned element. It has no effect on non-positioned elements. | string | numberSupports responsive prop syntax |
right | — | The right property participates in specifying the horizontal position of a positioned element. It has no effect on non-positioned elements. | string | numberSupports responsive prop syntax |
bottom | — | The bottom property participates in setting the vertical position of a positioned element. It has no effect on non-positioned elements. | string | numberSupports responsive prop syntax |
left | — | The left property participates in specifying the horizontal position of a positioned element. It has no effect on non-positioned elements. | string | numberSupports responsive prop syntax |
zIndex | — | The zIndex property sets the "z-order" of a positioned element and its descendants or flex items. Overlapping elements with a larger z-index cover those with a smaller one. | "card" | "dropdown" | "menu" | "blanket" | "modal" | "toast"Supports responsive prop syntax |
scrollMarginTop | — | The scroll-margin-top property defines the top margin of the scroll snap area that is used for snapping this box to the snapport. The scroll snap area is determined by taking the transformed border box, finding its rectangular bounding box (axis-aligned in the scroll container's coordinate space), then adding the specified outsets. | string | number |
transform | — | The transform property lets you rotate, scale, skew, or translate an element. It modifies the coordinate space of the CSS visual formatting model. | "none" | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset"Supports responsive prop syntax |
flex | — | The flex shorthand property sets how a flex item will grow or shrink to fit the space available in its flex container. | string | numberSupports responsive prop syntax |
flexBasis | — | The flexBasis property sets the initial main size of a flex item. | string | numberSupports responsive prop syntax |
flexDirection | — | Defines the main axis, or how the children are placed. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "column" | "column-reverse" | "row" | "row-reverse"Supports responsive prop syntax |
flexFlow | — | The flexFlow shorthand property specifies the direction of a flex container, as well as its wrapping behavior. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "column" | "column-reverse" | "row" | "row-reverse" | "nowrap" | "wrap" | "wrap-reverse"Supports responsive prop syntax |
flexGrow | — | The flexGrow property sets the flex grow factor of a flex item main size. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset"Supports responsive prop syntax |
flexShrink | — | The flexShrink property sets the flex shrink factor of a flex item. If the size of all flex items is larger than the flex container, items shrink to fit according to flex-shrink. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset"Supports responsive prop syntax |
flexWrap | — | Allow flex items to flow (wrap) onto multiple lines. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "nowrap" | "wrap" | "wrap-reverse"Supports responsive prop syntax |
margin | — | The margin shorthand property sets the margin area on all four sides of an element at once. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
marginTop | — | The marginTop property sets the margin area on the top side of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
marginRight | — | The marginRight property sets the margin area on the right side of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
marginBottom | — | The marginBottom property sets the margin area on the bottom side of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
marginLeft | — | The marginLeft property sets the margin area on the left side of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
marginY | — | The marginY shorthand property sets the margin area on the top and bottom of the element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
marginX | — | The marginY shorthand property sets the margin area on the left and right of the element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
padding | — | The padding shorthand property sets the padding area on all four sides of an element at once. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
paddingTop | — | The paddingTop property sets the height of the padding area on the top of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
paddingRight | — | The paddingRight property sets the width of the padding area on the right of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
paddingBottom | — | The paddingBottom property sets the height of the padding area on the bottom of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
paddingLeft | — | The paddingLeft property sets the width of the padding area on the left of an element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
paddingY | — | The paddingY shorthand property sets the padding area on the top and bottom of the element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
paddingX | — | The paddingX shorthand property sets the padding area on the left and right of the element. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
fontFamily | — | "sans" | "mono"Supports responsive prop syntax | |
fontSize | — | "xsmall" | "small" | "medium" | "large" | "xlarge" | "xxsmall" | "xxlarge" | "standard"Supports responsive prop syntax | |
fontWeight | — | "medium" | "regular" | "bold"Supports responsive prop syntax | |
lineHeight | — | "nospace" | "tight" | "loose"Supports responsive prop syntax | |
containerType | — | Declare container type | "size" | "inline-size" |
backgroundColor | — | The backgroundColor property sets the background color of an element. | "themePrimaryBase" | "themePrimary100" | "themePrimary200" | "themePrimary300" | "themePrimary400" | "themePrimary500" | "themePrimary600" | "themeAccentBase" | "themeAccent100" | "themeAccent200" | "themeAccent300" | "themeAccent400" | "themeAccent500" | "themeAccent600" | "neutralSubtle" | "neutralBold" | "neutralDisabled" | "neutral" | "neutralInverted" | "neutralHover" | "neutralPressed" | "input" | "inputDisabled" | "positiveSubtle" | "positiveBold" | "informativeSubtle" | "informativeBold" | "cautionSubtle" | "cautionBold" | "criticalSubtle" | "criticalBold" | "criticalBoldHover" | "criticalBoldPressed"Supports responsive prop syntax |
borderColor | — | The border property sets the color of an element's border. | "themePrimaryBase" | "themePrimary100" | "themePrimary200" | "themePrimary300" | "themePrimary400" | "themePrimary500" | "themePrimary600" | "themeAccentBase" | "themeAccent100" | "themeAccent200" | "themeAccent300" | "themeAccent400" | "themeAccent500" | "themeAccent600" | "neutralSubtle" | "neutralBold" | "neutralBoldInverted" | "neutralDisabled" | "positive" | "informative" | "caution" | "critical" | "input" | "inputCritical"Supports responsive prop syntax |
borderRadius | — | The borderRadius property rounds the corners of an element's outer border edge. | "none" | "small" | "medium" | "large" | "xlarge" | "full"Supports responsive prop syntax |
borderStyle | — | The borderStyle property controls what style the border is displayed in | "solid" | "dashed" |
borderWidth | — | The borderWidth shorthand property sets the width of an element's border. | "thin" | "thick"Supports responsive prop syntax |
boxShadow | — | The boxShadow property adds shadow effects around an element's frame. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge"Supports responsive prop syntax |
className | — | The className prop can be used to add CSS classes to the box. | string |
cursor | — | The cursor property sets the type of mouse cursor, if any, to show when the mouse pointer is over an element. | "none" | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "-moz-grab" | "-webkit-grab" | "alias" | "all-scroll" | "cell" | "col-resize" | "context-menu" | "copy" | "crosshair" | "default" | "e-resize" | "ew-resize" | "grab" | "grabbing" | "help" | "move" | "n-resize" | "ne-resize" | "nesw-resize" | "no-drop" | "not-allowed" | "ns-resize" | "nw-resize" | "nwse-resize" | "pointer" | "progress" | "row-resize" | "s-resize" | "se-resize" | "sw-resize" | "text" | "vertical-text" | "w-resize" | "wait" | "zoom-in" | "zoom-out"Supports responsive prop syntax |
overflow | — | The overflow shorthand property sets the desired behavior for an element's overflow — i.e. when an element's content is too big to fit in its block formatting context — in both directions. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "-moz-hidden-unscrollable" | "clip" | "hidden" | "scroll" | "visible"Supports responsive prop syntax |
overflowX | — | The overflowY property sets what shows when content overflows a block-level element's left and right edges. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "-moz-hidden-unscrollable" | "clip" | "hidden" | "scroll" | "visible"Supports responsive prop syntax |
overflowY | — | The overflowY property sets what shows when content overflows a block-level element's top and bottom edges. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "-moz-hidden-unscrollable" | "clip" | "hidden" | "scroll" | "visible"Supports responsive prop syntax |
overflowWrap | — | Configures the wrapping behaviour for overflowing content | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "anywhere" | "break-word" | "normal"Supports responsive prop syntax |
hyphens | — | Configures the hyphen behaviour for overflowing content | "none" | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "manual"Supports responsive prop syntax |
userSelect | — | The userSelect property controls whether the user can select text. This doesn't have any effect on content loaded as part of a browser's user interface (its chrome), except in textboxes. | "none" | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "text" | "-moz-none" | "all" | "contain" | "element"Supports responsive prop syntax |
alignContent | — | The alignContent property sets the distribution of space between and around content items along a flexbox's cross-axis or a grid's block axis. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "normal" | "space-around" | "space-between" | "space-evenly" | "stretch" | "center" | "end" | "flex-end" | "flex-start" | "start" | "baseline"Supports responsive prop syntax |
alignItems | — | The alignItems property sets the align-self value on all direct children as a group. In Flexbox, it controls the alignment of items on the Cross Axis. In Grid Layout, it controls the alignment of items on the Block Axis within their grid area. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "normal" | "stretch" | "center" | "end" | "flex-end" | "flex-start" | "start" | "baseline" | "self-end" | "self-start"Supports responsive prop syntax |
alignSelf | — | The alignSelf property overrides a grid or flex item's align-items value. In Grid, it aligns the item inside the grid area. In Flexbox, it aligns the item on the cross axis. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "auto" | "normal" | "stretch" | "center" | "end" | "flex-end" | "flex-start" | "start" | "baseline" | "self-end" | "self-start"Supports responsive prop syntax |
textAlign | — | The textAlign property specifies the horizontal alignment of text in an element. It also allows the centering of elements inside a Box while preserving the display: block property | "right" | "left" | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "center" | "end" | "start" | "-webkit-match-parent" | "justify" | "match-parent"Supports responsive prop syntax |
gap | — | The gap property sets the gaps (gutters) between rows and columns. It is a shorthand for row-gap and column-gap. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
columnGap | — | The columnGap property sets the gaps (gutters) between columns. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
rowGap | — | The rowGap property sets the gaps (gutters) between rows. | "none" | "xsmall" | "small" | "medium" | "large" | "xlarge" | "auto" | "xxsmall" | "xxlarge"Supports responsive prop syntax |
justifyContent | — | The justifyContent property defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container. | "right" | "left" | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset" | "normal" | "space-around" | "space-between" | "space-evenly" | "stretch" | "center" | "end" | "flex-end" | "flex-start" | "start"Supports responsive prop syntax |
order | — | The order property sets the order to lay out an item in a flex or grid container. Items in a container are sorted by ascending order value and then by their source code order. | "initial" | "-moz-initial" | "inherit" | "revert" | "revert-layer" | "unset"Supports responsive prop syntax |
inline | — | Display as an inline-level flex container. | boolean |