docs: add component API information

2025-09-15 10:21:05 +00:00 · 2020-10-16 18:20:39 -07:00 · 2020-10-16 18:20:39 -07:00 · 0d0d35e715
commit 0d0d35e715
parent 0472c1ad23
36 changed files with 18462 additions and 5 deletions
--- a/docs/src/pages/_layout.svelte
+++ b/docs/src/pages/_layout.svelte
@ -184,7 +184,6 @@
        icon="{{ render: LogoGithub20 }}"
        href="https://github.com/IBM/carbon-components-svelte"
        target="_blank"
-        rel="noopener"
      />
      <HeaderAction bind:isOpen>
        <HeaderPanelLinks>
@ -217,7 +216,7 @@
  <SideNav bind:isOpen="{isSideNavOpen}">
    <SideNavItems>
      <SideNavMenu
-        expanded="{$isActive($url('/components'))}"
+        expanded="{$isActive($url('')) || $isActive($url('/components'))}"
        text="Components"
      >
        {#each components.children as child, i (child.path)}
--- a/docs/src/pages/components/Accordion.svx
+++ b/docs/src/pages/components/Accordion.svx
@ -1,3 +1,7 @@
+---
+components: ["Accordion", "AccordionItem", "AccordionSkeleton"]
+---
+
 <script>
  import {
    Accordion,
--- a/docs/src/pages/components/Breadcrumb.svx
+++ b/docs/src/pages/components/Breadcrumb.svx
@ -1,3 +1,7 @@
+---
+components: ["Breadcrumb", "BreadcrumbItem"]
+---
+
 <script>
  import {
    Breadcrumb,
--- a/docs/src/pages/components/ComposedModal.svx
+++ b/docs/src/pages/components/ComposedModal.svx
@ -1,3 +1,7 @@
+---
+components: ["ComposedModal", "ModalHeader", "ModalBody", "ModalFooter", "Checkbox"]
+---
+
 <script>
  import Preview from "../../components/Preview.svelte";
 </script>
--- a/docs/src/pages/components/ContentSwitcher.svx
+++ b/docs/src/pages/components/ContentSwitcher.svx
@ -1,3 +1,7 @@
+---
+components: ["ContentSwitcher", "Switch"]
+---
+
 <script>
  import { ContentSwitcher, Switch } from "carbon-components-svelte";
  import Add16 from "carbon-icons-svelte/lib/Add16";
--- a/docs/src/pages/components/DatePicker.svx
+++ b/docs/src/pages/components/DatePicker.svx
@ -1,3 +1,7 @@
+---
+components: ["DatePicker", "DatePickerInput", "DatePickerSkeleton"]
+---
+
 <script>
  import { DatePicker, DatePickerSkeleton, DatePickerInput } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/Dropdown.svx
+++ b/docs/src/pages/components/Dropdown.svx
@ -1,3 +1,7 @@
+---
+components: ["Dropdown", "DropdownSkeleton"]
+---
+
 <script>
  import { Dropdown, DropdownSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/FileUploader.svx
+++ b/docs/src/pages/components/FileUploader.svx
@ -1,3 +1,7 @@
+---
+components: ["FileUploaderButton", "FileUploader", "FileUploaderDropContainer", "FileUploaderItem", "FileUploaderSkeleton"]
+---
+
 <script>
  import { FileUploaderButton, FileUploader, FileUploaderDropContainer, FileUploaderItem, FileUploaderSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/Form.svx
+++ b/docs/src/pages/components/Form.svx
@ -1,3 +1,7 @@
+---
+components: ["Form", "FormGroup"]
+---
+
 <script>
  import { Form,
    FormGroup,
--- a/docs/src/pages/components/Grid.svx
+++ b/docs/src/pages/components/Grid.svx
@ -1,3 +1,7 @@
+---
+components: ["Grid", "Row", "Column"]
+---
+
 <script>
  import Preview from "../../components/Preview.svelte";
 </script>
--- a/docs/src/pages/components/NumberInput.svx
+++ b/docs/src/pages/components/NumberInput.svx
@ -1,3 +1,7 @@
+---
+components: ["NumberInput", "NumberInputSkeleton"]
+---
+
 <script>
  import { NumberInput, NumberInputSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/OrderedList.svx
+++ b/docs/src/pages/components/OrderedList.svx
@ -1,3 +1,7 @@
+---
+components: ["OrderedList", "ListItem"]
+---
+
 <script>
  import { OrderedList, ListItem, Link } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/OverflowMenu.svx
+++ b/docs/src/pages/components/OverflowMenu.svx
@ -1,3 +1,7 @@
+---
+components: ["OverflowMenu", "OverflowMenuItem"]
+---
+
 <script>
  import { OverflowMenu, OverflowMenuItem } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/Pagination.svx
+++ b/docs/src/pages/components/Pagination.svx
@ -1,3 +1,7 @@
+---
+components: ["Pagination", "PaginationSkeleton"]
+---
+
 <script>
  import { Pagination, PaginationSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/ProgressIndicator.svx
+++ b/docs/src/pages/components/ProgressIndicator.svx
@ -1,3 +1,7 @@
+---
+components: ["ProgressIndicator", "ProgressStep", "ProgressIndicatorSkeleton"]
+---
+
 <script>
  import { ProgressIndicator, ProgressStep, ProgressIndicatorSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/RadioButton.svx
+++ b/docs/src/pages/components/RadioButton.svx
@ -1,3 +1,7 @@
+---
+components: ["RadioButtonGroup", "RadioButton", "RadioButtonSkeleton"]
+---
+
 <script>
  import { FormGroup, RadioButton, RadioButtonSkeleton, RadioButtonGroup } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/RadioTile.svx
+++ b/docs/src/pages/components/RadioTile.svx
@ -1,3 +1,7 @@
+---
+components: ["TileGroup", "RadioTile"]
+---
+
 <script>
  import { TileGroup, RadioTile } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/Select.svx
+++ b/docs/src/pages/components/Select.svx
@ -1,3 +1,7 @@
+---
+components: ["Select", "SelectItem", "SelectItemGroup", "SelectSkeleton"]
+---
+
 <script>
  import { Select, SelectItem, SelectItemGroup, SelectSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/SelectableTile.svx
+++ b/docs/src/pages/components/SelectableTile.svx
@ -1,3 +1,7 @@
+---
+components: ["TileGroup", "SelectableTile"]
+---
+
 <script>
  import { TileGroup, SelectableTile } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/Slider.svx
+++ b/docs/src/pages/components/Slider.svx
@ -1,3 +1,7 @@
+---
+components: ["Slider", "SliderSkeleton"]
+---
+
 <script>
  import { Slider, SliderSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/StructuredList.svx
+++ b/docs/src/pages/components/StructuredList.svx
@ -1,3 +1,7 @@
+---
+components: ["StructuredList", "StructuredListSkeleton", "StructuredListBody", "StructuredListHead", "StructuredListCell", "StructuredListRow", "StructuredListInput"]
+---
+
 <script>
  import { StructuredList, StructuredListSkeleton, StructuredListBody, StructuredListHead, StructuredListCell ,StructuredListRow, StructuredListInput } from "carbon-components-svelte";
  import CheckmarkFilled16 from "carbon-icons-svelte/lib/CheckmarkFilled16";
--- a/docs/src/pages/components/Tabs.svx
+++ b/docs/src/pages/components/Tabs.svx
@ -1,3 +1,7 @@
+---
+components: ["Tabs", "Tab", "TabContent", "TabsSkeleton"]
+---
+
 <script>
  import { Tabs, Tab, TabContent, TabsSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/TextArea.svx
+++ b/docs/src/pages/components/TextArea.svx
@ -1,3 +1,7 @@
+---
+components: ["TextArea", "TextAreaSkeleton"]
+---
+
 <script>
  import { TextArea, TextAreaSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/TextInput.svx
+++ b/docs/src/pages/components/TextInput.svx
@ -1,3 +1,7 @@
+---
+components: ["TextInput", "TextInputSkeleton"]
+---
+
 <script>
  import { TextInput, TextInputSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/TimePicker.svx
+++ b/docs/src/pages/components/TimePicker.svx
@ -1,3 +1,7 @@
+---
+components: ["TimePicker", "TimePickerSelect", "SelectItem"]
+---
+
 <script>
  import { TimePicker, TimePickerSelect, SelectItem } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/Toggle.svx
+++ b/docs/src/pages/components/Toggle.svx
@ -1,3 +1,7 @@
+---
+components: ["Toggle", "ToggleSkeleton"]
+---
+
 <script>
  import { Toggle, ToggleSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/ToggleSmall.svx
+++ b/docs/src/pages/components/ToggleSmall.svx
@ -1,3 +1,7 @@
+---
+components: ["ToggleSmall", "ToggleSmallSkeleton"]
+---
+
 <script>
  import { ToggleSmall, ToggleSmallSkeleton } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";
--- a/docs/src/pages/components/UIShell.svx
+++ b/docs/src/pages/components/UIShell.svx
@ -1,3 +1,27 @@
+
+
+---
+components: ["Header",
+"HeaderAction",
+"HeaderActionLink",
+"HeaderActionSearch",
+"HeaderNav",
+"HeaderNavItem",
+"HeaderNavMenu",
+"HeaderPanelDivider",
+"HeaderPanelLink",
+"HeaderPanelLinks",
+"HeaderUtilities",
+"SideNav",
+"SideNavItems",
+"SideNavLink",
+"SideNavMenu",
+"SideNavMenuItem",
+"Content",
+"SkipToContent",
+"HeaderGlobalAction"]
+---
+
 <script>
  import Preview from "../../components/Preview.svelte";
 </script>
--- a/docs/src/pages/components/UnorderedList.svx
+++ b/docs/src/pages/components/UnorderedList.svx
@ -1,3 +1,7 @@
+---
+components: ["UnorderedList", "ListItem"]
+---
+
 <script>
  import { UnorderedList, ListItem, Link } from "carbon-components-svelte";
  import Preview from "../../components/Preview.svelte";