docs(components): update github links to nuxt/ui repository

This commit is contained in:
Benjamin Canac
2024-09-10 15:34:09 +02:00
parent c578acbb88
commit d8d7b8fcc5
45 changed files with 74 additions and 53 deletions

View File

@@ -54,7 +54,7 @@ export default defineAppConfig(${json5.stringify(component.value, null, 2).repla
${strippedCompoundVariants.value ${strippedCompoundVariants.value
? ` ? `
::callout{icon="i-simple-icons-github" to="https://github.com/benjamincanac/ui3/blob/dev/src/theme/${name}.ts"} ::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/v3/src/theme/${name}.ts"}
Some colors in \`compoundVariants\` are omitted for readability. Check out the source code on GitHub. Some colors in \`compoundVariants\` are omitted for readability. Check out the source code on GitHub.
::` ::`
: ''} : ''}

View File

@@ -4,7 +4,7 @@ description: Wraps your app to provide global configurations and more.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/App.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/App.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/accordion.html to: https://www.radix-vue.com/components/accordion.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Accordion.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Accordion.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A callout to draw user's attention.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Alert.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Alert.vue
--- ---
## Usage ## Usage

View File

@@ -4,7 +4,7 @@ description: Stack multiple avatars in a group.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/AvatarGroup.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/AvatarGroup.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/avatar.html to: https://www.radix-vue.com/components/avatar.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Avatar.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Avatar.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A short text to represent a status or a category.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Badge.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Badge.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A hierarchy of links to navigate through a website.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Breadcrumb.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Breadcrumb.vue
--- ---
## Usage ## Usage

View File

@@ -4,7 +4,7 @@ description: Group multiple button-like elements together.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/ButtonGroup.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/ButtonGroup.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A button element that can act as a link or trigger an action.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Button.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Button.vue
--- ---
## Usage ## Usage
@@ -232,7 +232,7 @@ ignore:
--- ---
:: ::
::callout{icon="i-simple-icons-github" to="https://github.com/benjamincanac/ui3/blob/dev/src/runtime/components/Link.vue#L13"} ::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/v3/src/runtime/components/Link.vue#L13"}
The `Button` component extends the `Link` component. Check out the source code on GitHub. The `Button` component extends the `Link` component. Check out the source code on GitHub.
:: ::

View File

@@ -3,7 +3,7 @@ description: Display content in a card with a header, body and footer.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Card.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Card.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A carousel with motion and swipe support.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Carousel.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Carousel.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/checkbox.html to: https://www.radix-vue.com/components/checkbox.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Checkbox.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Checkbox.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: An indicator of a numeric value or a state.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Chip.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Chip.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/collapsible.html to: https://www.radix-vue.com/components/collapsible.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Collapsible.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Collapsible.vue
--- ---
## Usage ## Usage

View File

@@ -7,16 +7,37 @@ links:
to: https://www.radix-vue.com/components/combobox.html to: https://www.radix-vue.com/components/combobox.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/CommandPalette.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/CommandPalette.vue
navigation:
badge:
label: Todo
--- ---
## Usage ## Usage
## Examples ## Examples
### Control search term
### Control selected value
### With fetched items
### With filtered items
### Within a modal
### Within a drawer
### Within a popover
### Listen open state
### With custom search
### With highlighted search
### With custom slot
### With empty slot
## API ## API
### Props ### Props

View File

@@ -3,7 +3,7 @@ description: A container lets you center and constrain the width of your content
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Container.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Container.vue
--- ---
## Usage ## Usage

View File

@@ -7,7 +7,7 @@ links:
to: https://www.radix-vue.com/components/context-menu.html to: https://www.radix-vue.com/components/context-menu.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/ContextMenu.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/ContextMenu.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://github.com/radix-vue/vaul-vue to: https://github.com/radix-vue/vaul-vue
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Drawer.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Drawer.vue
--- ---
## Usage ## Usage

View File

@@ -7,7 +7,7 @@ links:
to: https://www.radix-vue.com/components/dropdown-menu.html to: https://www.radix-vue.com/components/dropdown-menu.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/DropdownMenu.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/DropdownMenu.vue
--- ---
## Usage ## Usage

View File

@@ -4,7 +4,7 @@ description: A wrapper for form elements that provides validation and error hand
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/FormField.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/FormField.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A form element that provides validation and submission handling.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Form.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Form.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo

View File

@@ -7,7 +7,7 @@ links:
to: https://www.radix-vue.com/components/combobox.html to: https://www.radix-vue.com/components/combobox.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/InputMenu.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/InputMenu.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo

View File

@@ -3,7 +3,7 @@ description: An input element to enter text.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Input.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Input.vue
--- ---
## Usage ## Usage

View File

@@ -4,7 +4,7 @@ description: A kbd element to display a keyboard key.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Kbd.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Kbd.vue
navigation: navigation:
title: Kbd title: Kbd
--- ---
@@ -31,7 +31,7 @@ props:
--- ---
:: ::
You can pass special keys to the `value` prop that goes through the [`useKbd`](https://github.com/benjamincanac/ui3/blob/dev/src/runtime/composables/useKbd.ts) composable. For example, the `meta` key displays as `⌘` on macOS and `Ctrl` on other platforms. You can pass special keys to the `value` prop that goes through the [`useKbd`](https://github.com/nuxt/ui/blob/v3/src/runtime/composables/useKbd.ts) composable. For example, the `meta` key displays as `⌘` on macOS and `Ctrl` on other platforms.
::component-code ::component-code
--- ---

View File

@@ -3,7 +3,7 @@ description: A wrapper around <NuxtLink> with extra props.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Link.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Link.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A gauge meter that fills or depletes.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Meter.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Meter.vue
navigation: false navigation: false
--- ---

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/dialog.html to: https://www.radix-vue.com/components/dialog.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Modal.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Modal.vue
--- ---
## Usage ## Usage
@@ -281,7 +281,7 @@ This allows you to move the trigger outside of the Modal or remove it entirely.
You can use the [`useModal`](/composables/use-modal) composable to open a Modal programatically. You can use the [`useModal`](/composables/use-modal) composable to open a Modal programatically.
::important ::important
Make sure to wrap your app with the [App](/components/app) component which uses the [ModalProvider](https://github.com/benjamincanac/ui3/blob/dev/src/runtime/components/ModalProvider.vue) component. Make sure to wrap your app with the [App](/components/app) component which uses the [ModalProvider](https://github.com/nuxt/ui/blob/v3/src/runtime/components/ModalProvider.vue) component.
:: ::
First, create a modal component that will be opened programatically: First, create a modal component that will be opened programatically:

View File

@@ -7,7 +7,7 @@ links:
to: https://www.radix-vue.com/components/navigation-menu.html to: https://www.radix-vue.com/components/navigation-menu.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/NavigationMenu.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/NavigationMenu.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/pagination.html to: https://www.radix-vue.com/components/pagination.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Pagination.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Pagination.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/popover.html to: https://www.radix-vue.com/components/popover.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Popover.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Popover.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/progress.html to: https://www.radix-vue.com/components/progress.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Progress.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Progress.vue
--- ---
## Usage ## Usage

View File

@@ -7,7 +7,7 @@ links:
to: https://www.radix-vue.com/components/radio-group.html to: https://www.radix-vue.com/components/radio-group.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/RadioGroup.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/RadioGroup.vue
--- ---
## Usage ## Usage

View File

@@ -7,7 +7,7 @@ links:
to: https://www.radix-vue.com/components/combobox.html to: https://www.radix-vue.com/components/combobox.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/SelectMenu.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/SelectMenu.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/select.html to: https://www.radix-vue.com/components/select.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Select.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Select.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/separator.html to: https://www.radix-vue.com/components/separator.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Separator.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Separator.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A placeholder to show while content is loading.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Skeleton.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Skeleton.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/dialog.html to: https://www.radix-vue.com/components/dialog.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slideover.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Slideover.vue
--- ---
## Usage ## Usage
@@ -280,7 +280,7 @@ This allows you to move the trigger outside of the Slideover or remove it entire
You can use the [`useSlideover`](/composables/use-slideover) composable to open a Slideover programatically. You can use the [`useSlideover`](/composables/use-slideover) composable to open a Slideover programatically.
::important ::important
Make sure to wrap your app with the [App](/components/app) component which uses the [SlideoverProvider](https://github.com/benjamincanac/ui3/blob/dev/src/runtime/components/SlideoverProvider.vue) component. Make sure to wrap your app with the [App](/components/app) component which uses the [SlideoverProvider](https://github.com/nuxt/ui/blob/v3/src/runtime/components/SlideoverProvider.vue) component.
:: ::
First, create a slideover component that will be opened programatically: First, create a slideover component that will be opened programatically:

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/slider.html to: https://www.radix-vue.com/components/slider.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Slider.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Slider.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/switch.html to: https://www.radix-vue.com/components/switch.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Switch.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Switch.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A responsive table element to display data in rows and columns.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Table.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Table.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/tabs.html to: https://www.radix-vue.com/components/tabs.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Tabs.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Tabs.vue
--- ---
## Usage ## Usage

View File

@@ -3,7 +3,7 @@ description: A textarea element to input multi-line text.
links: links:
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Textarea.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Textarea.vue
--- ---
## Usage ## Usage

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/toast.html to: https://www.radix-vue.com/components/toast.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Toast.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Toast.vue
navigation: navigation:
badge: badge:
label: Todo label: Todo
@@ -17,7 +17,7 @@ navigation:
Use the [useToast](/composables/use-toast) composable to display a toast in your application. Use the [useToast](/composables/use-toast) composable to display a toast in your application.
::important ::important
Make sure to wrap your app with the [App](/components/app) component which uses our [Toaster](https://github.com/benjamincanac/ui3/blob/dev/src/runtime/components/Toaster.vue) component which uses the [ToastProvider](https://www.radix-vue.com/components/toast.html#provider) component from Radix Vue. Make sure to wrap your app with the [App](/components/app) component which uses our [Toaster](https://github.com/nuxt/ui/blob/v3/src/runtime/components/Toaster.vue) component which uses the [ToastProvider](https://www.radix-vue.com/components/toast.html#provider) component from Radix Vue.
:: ::
::tip{to="/components/app#props"} ::tip{to="/components/app#props"}

View File

@@ -6,7 +6,7 @@ links:
to: https://www.radix-vue.com/components/tooltip.html to: https://www.radix-vue.com/components/tooltip.html
- label: GitHub - label: GitHub
icon: i-simple-icons-github icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Tooltip.vue to: https://github.com/nuxt/ui/tree/v3/src/runtime/components/Tooltip.vue
--- ---
## Usage ## Usage