From 1bc055935e1aa16f739b66c8785d43f50e6e88b6 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Sun, 30 Jul 2023 15:13:44 +0200 Subject: [PATCH] docs: update badges --- docs/content/2.elements/4.badge.md | 6 +++--- docs/content/3.forms/4.select-menu.md | 4 ++-- docs/content/3.forms/9.form-group.md | 2 +- docs/content/4.data/1.table.md | 4 ++-- docs/content/6.overlays/1.modal.md | 2 +- docs/content/6.overlays/2.slideover.md | 2 +- docs/content/6.overlays/6.notification.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/content/2.elements/4.badge.md b/docs/content/2.elements/4.badge.md index ebc4b937..6a9b5e80 100644 --- a/docs/content/2.elements/4.badge.md +++ b/docs/content/2.elements/4.badge.md @@ -45,7 +45,7 @@ Badge Besides all the colors from the `ui.colors` object, you can also use the `white` and `black` colors with their pre-defined variants. -#### White :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full"} +#### White :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} ::component-card --- @@ -62,7 +62,7 @@ excludedProps: Badge :: -#### Gray :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full"} +#### Gray :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} ::component-card --- @@ -79,7 +79,7 @@ excludedProps: Badge :: -#### Black :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full"} +#### Black :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} ::component-card --- diff --git a/docs/content/3.forms/4.select-menu.md b/docs/content/3.forms/4.select-menu.md index e3561d5a..3c49ad93 100644 --- a/docs/content/3.forms/4.select-menu.md +++ b/docs/content/3.forms/4.select-menu.md @@ -108,7 +108,7 @@ const selected = ref(people[0]) ``` :: -If you only want to select a single object property rather than the whole object as value, you can set the `value-attribute` property. This prop defaults to `null`. +If you only want to select a single object property rather than the whole object as value, you can set the `value-attribute` property. This prop defaults to `null`. :u-badge{label="Edge" class="!rounded-full" variant="subtle"} ::component-example #default @@ -193,7 +193,7 @@ props: --- :: -### Async search :u-badge{label="New" class="ml-2 align-text-bottom !rounded-full"} +### Async search :u-badge{label="New" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} Pass a function to the `searchable` prop to customize the search behavior and filter options according to your needs. The function will receive the query as its first argument and should return an array. diff --git a/docs/content/3.forms/9.form-group.md b/docs/content/3.forms/9.form-group.md index b47d7a92..5d28915b 100644 --- a/docs/content/3.forms/9.form-group.md +++ b/docs/content/3.forms/9.form-group.md @@ -134,7 +134,7 @@ You can also use the `error` prop as a boolean to mark the form element as inval The `error` prop will automatically set the `color` prop of the form element to `red`. :: -### Size +### Size :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} Use the `size` prop to change the size of the label and the form element. diff --git a/docs/content/4.data/1.table.md b/docs/content/4.data/1.table.md index 959823d0..c3418ff6 100644 --- a/docs/content/4.data/1.table.md +++ b/docs/content/4.data/1.table.md @@ -75,7 +75,7 @@ Use the `columns` prop to configure which columns to display. It's an array of o - `key` - The field to display from the row data. - `sortable` - Whether the column is sortable. Defaults to `false`. - `direction` - The sort direction to use on first click. Defaults to `asc`. -- `class` :u-badge{label="New" class="!rounded-full"} - The class to apply to the column cells. +- `class` :u-badge{label="New" class="!rounded-full" variant="subtle"} - The class to apply to the column cells. ::component-example{class="grid"} --- @@ -327,7 +327,7 @@ const selected = ref([people[1]]) You can use the `by` prop to compare objects by a field instead of comparing object instances. We've replicated the behavior of Headless UI [Combobox](https://headlessui.com/vue/combobox#binding-objects-as-values). :: -You can also add a `select` listener on your Table to make the rows clickable. The function will receive the row as the first argument. :u-badge{label="New" class="!rounded-full"} +You can also add a `select` listener on your Table to make the rows clickable. The function will receive the row as the first argument. :u-badge{label="New" class="!rounded-full" variant="subtle"} You can use this to navigate to a page, open a modal or even to select the row manually. diff --git a/docs/content/6.overlays/1.modal.md b/docs/content/6.overlays/1.modal.md index 28ed67ea..505c2f55 100644 --- a/docs/content/6.overlays/1.modal.md +++ b/docs/content/6.overlays/1.modal.md @@ -125,7 +125,7 @@ const isOpen = ref(false) ``` :: -### Prevent close :u-badge{label="New" class="ml-2 align-text-bottom !rounded-full"} +### Prevent close :u-badge{label="New" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} Use the `prevent-close` prop to disable the outside click alongside the `esc` keyboard shortcut. diff --git a/docs/content/6.overlays/2.slideover.md b/docs/content/6.overlays/2.slideover.md index 3ca4b186..132a17bb 100644 --- a/docs/content/6.overlays/2.slideover.md +++ b/docs/content/6.overlays/2.slideover.md @@ -124,7 +124,7 @@ const isOpen = ref(false) ``` :: -### Prevent close :u-badge{label="New" class="ml-2 align-text-bottom !rounded-full"} +### Prevent close :u-badge{label="New" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} Use the `prevent-close` prop to disable the outside click alongside the `esc` keyboard shortcut. diff --git a/docs/content/6.overlays/6.notification.md b/docs/content/6.overlays/6.notification.md index ca4e9b7b..99bac5d4 100644 --- a/docs/content/6.overlays/6.notification.md +++ b/docs/content/6.overlays/6.notification.md @@ -316,7 +316,7 @@ excludedProps: ## Slots -### `title` / `description` +### `title` / `description` :u-badge{label="Edge" class="ml-2 align-text-bottom !rounded-full" variant="subtle"} Use the `#title` and `#description` slots to customize the Notification.