From 9fde47651b3e90a9caaac34d4be14308c6690e4e Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 3 May 2025 10:38:34 -0700 Subject: [PATCH] docs(recursive-list): improve docs --- docs/src/pages/components/RecursiveList.svx | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/src/pages/components/RecursiveList.svx b/docs/src/pages/components/RecursiveList.svx index fba581d1..fd0f3191 100644 --- a/docs/src/pages/components/RecursiveList.svx +++ b/docs/src/pages/components/RecursiveList.svx @@ -3,9 +3,7 @@ import Preview from "../../components/Preview.svelte"; -This component uses the [svelte:self API](https://svelte.dev/docs#svelte_self) to render the [UnorderedList](/components/UnorderedList) and [OrderedList](/components/OrderedList) components with tree structured data. - -A child node can render text, a link, HTML content, and other child nodes. +`RecursiveList` provides a flexible way to render hierarchical data structures using either unordered or ordered lists. It supports nested nodes, links, and HTML content, making it ideal for displaying complex data hierarchies.
@@ -19,29 +17,26 @@ A child node can render text, a link, HTML content, and other child nodes.
-## Unordered +## Default -The `nodes` prop accepts an array of child nodes. - -By default, the list type is unordered. +Create a hierarchical list using the `nodes` prop. Each node can contain text, links, HTML content, and nested nodes. ## Ordered -Set `type` to `"ordered"` to use the ordered list variant. +Set `type` to `"ordered"` to use numbered lists with proper indentation. ## Ordered (native styles) -Set `type` to `"ordered-native"` to use the native styles for an ordered list. +Set `type` to `"ordered-native"` to use browser-native numbering styles. ## Flat data structure -If working with a flat data structure, use the `toHierarchy` utility -to convert a flat data structure into a hierarchical array accepted by the `nodes` prop. +Convert flat data structures to hierarchical arrays using the `toHierarchy` utility function.