Skip to content

Commit

Permalink
docs(list): enhance displayMode prop (#11041)
Browse files Browse the repository at this point in the history
**Related Issue:** #10947 

## Summary

Enhance the `list`'s `displayMode` prop to account for the `"flat"` and
`"nested"` values, and consistency of the value when defined on the
parent element for its children.
  • Loading branch information
geospatialem authored Dec 12, 2024
1 parent 18db2e2 commit 659a53e
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion packages/calcite-components/src/components/list/list.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,16 @@ export class List
*/
messages = useT9n<typeof T9nStrings>({ blocking: true });

/** Specifies the nesting behavior. */
/**
* Specifies the nesting behavior of `calcite-list-item`s, where
*
* `"flat"` displays `calcite-list-item`s in a uniform list, and
*
* `"nested"` displays `calcite-list-item`s under their parent element.
*
* The parent component's behavior should follow throughout its child elements.
*
*/
@property({ reflect: true }) displayMode: ListDisplayMode = "flat";

/** Specifies the Unicode numeral system used by the component for localization. */
Expand Down

0 comments on commit 659a53e

Please sign in to comment.