docs: add info about existing shoelace components

hotosm · Jun 27, 2024 · 9e9a07f · 9e9a07f
1 parent 8d39d17
commit 9e9a07f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/components/shoelace-components.md b/docs/components/shoelace-components.md
@@ -0,0 +1,14 @@
+# Existing Shoelace Components
+
+Many components exist already in Shoelace and will be styled if imported
+via this library.
+
+Useful components of note:
+- **Accordion**: use a group of `sl-details`: https://shoelace.style/components/details#grouping-details
+- **Chip**: called `sl-tag` in shoelace.
+- **Kebab Menu**: a simple `sl-menu` in shoelace.
+- **Progress Bar**: available in shoelace.
+- **Modal**: called `sl-dialog` in shoelace.
+
+Explore all available components here: 
+[https://shoelace.style](https://shoelace.style)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -61,6 +61,7 @@ nav:
   - Home: index.md
   - About: about.md
   - Custom Components:
+      - Shoelace Components: components/shoelace-components.md
       - Header: components/hot-header.md
       - Toolbar: components/hot-toolbar.md
       - Tracking: components/hot-tracking.md