From 6a3306a91f784676fa888d74219d6b0b2874e2b4 Mon Sep 17 00:00:00 2001 From: Eric Liu Date: Sat, 3 May 2025 11:11:28 -0700 Subject: [PATCH] docs(ui-shell): improve docs --- docs/src/pages/components/UIShell.svx | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/src/pages/components/UIShell.svx b/docs/src/pages/components/UIShell.svx index d5c650ef..63677c91 100644 --- a/docs/src/pages/components/UIShell.svx +++ b/docs/src/pages/components/UIShell.svx @@ -1,5 +1,3 @@ - - --- components: ["Header", "HeaderAction", @@ -27,6 +25,8 @@ components: ["Header", import Preview from "../../components/Preview.svelte"; +`UIShell` provides a collection of components for building application shells and navigation structures. It includes header, side navigation, and content components that work together to create a cohesive user interface. +
Currently, the UI Shell is not themable and only supports dark mode. @@ -37,6 +37,8 @@ Open the following examples in a new tab to experience them in full. ## Header +Create a basic header with the `Header` component. + ## Header with side navigation @@ -71,12 +73,18 @@ Note that providing `text` overrides the tooltip. ## Header with global search +Add a global search component to the header. + ## Header with utilities +Include utility components in the header using `HeaderUtilities`. + ## Header with persisted hamburger menu +Create a header with a persistent hamburger menu state. + \ No newline at end of file