From 659a53eeceaa4f0e09774409d356d2b180f98bd5 Mon Sep 17 00:00:00 2001 From: Kitty Hurley Date: Thu, 12 Dec 2024 17:37:01 -0600 Subject: [PATCH] docs(list): enhance displayMode prop (#11041) **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. --- .../calcite-components/src/components/list/list.tsx | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/packages/calcite-components/src/components/list/list.tsx b/packages/calcite-components/src/components/list/list.tsx index 324d654ed49..4db51d740f2 100755 --- a/packages/calcite-components/src/components/list/list.tsx +++ b/packages/calcite-components/src/components/list/list.tsx @@ -253,7 +253,16 @@ export class List */ messages = useT9n({ 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. */