From b2f7a2274bc3ce12f4fec869dc10825a9a1b313a Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 3 May 2025 11:12:07 -0700 Subject: [PATCH] docs(unordered-list): improve docs --- docs/src/pages/components/UnorderedList.svx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/src/pages/components/UnorderedList.svx b/docs/src/pages/components/UnorderedList.svx index 7fb0e16e..49d80bb4 100644 --- a/docs/src/pages/components/UnorderedList.svx +++ b/docs/src/pages/components/UnorderedList.svx @@ -7,6 +7,8 @@ components: ["UnorderedList", "ListItem"] import Preview from "../../components/Preview.svelte"; +`UnorderedList` provides a styled unordered list component that supports nested lists, links, and expressive typography. It's ideal for displaying bulleted content in your interface. +
Consider using the RecursiveList component for rendering tree structured data. @@ -15,6 +17,8 @@ components: ["UnorderedList", "ListItem"] ## Default +Create a basic unordered list with `ListItem` components. + Unordered list item Unordered list item @@ -23,6 +27,8 @@ components: ["UnorderedList", "ListItem"] ## With links +Add links to list items by wrapping them in `Link` components. + Unordered list item @@ -37,6 +43,8 @@ components: ["UnorderedList", "ListItem"] ## Nested +Create nested lists by setting `nested` to `true` on child `UnorderedList` components. + Unordered list level 1 @@ -57,7 +65,7 @@ components: ["UnorderedList", "ListItem"] ## Expressive styles -Set `expressive` to `true` to use Carbon's expressive typesetting. +Use Carbon's expressive typesetting by setting `expressive` to `true`. Unordered list item