mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-14 12:14:41 +01:00
docs(alert): update
This commit is contained in:
@@ -1,13 +1,153 @@
|
||||
---
|
||||
description: Display an alert element to draw attention.
|
||||
description: Display a callout to draw user attention.
|
||||
links:
|
||||
- label: GitHub
|
||||
icon: i-simple-icons-github
|
||||
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Alert.vue
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
## Examples
|
||||
Use the `title` prop to set the title of the Alert.
|
||||
|
||||
::component-code
|
||||
---
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
---
|
||||
::
|
||||
|
||||
Use the `description` prop to set the description of the Alert.
|
||||
|
||||
::component-code
|
||||
---
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
---
|
||||
::
|
||||
|
||||
### Icon
|
||||
|
||||
Use the `icon` prop to show an [Icon](/components/icon).
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- title
|
||||
- description
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
icon: 'i-heroicons-command-line'
|
||||
---
|
||||
::
|
||||
|
||||
### Avatar
|
||||
|
||||
Use the `avatar` prop to show an [Avatar](/components/avatar).
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- title
|
||||
- description
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
avatar.src: 'https://avatars.githubusercontent.com/u/739984?v=4'
|
||||
---
|
||||
::
|
||||
|
||||
### Close
|
||||
|
||||
Use the `close` prop to display a [Button](/components/button) to dismiss the Alert.
|
||||
|
||||
::note
|
||||
A `close` event will be emitted when the close button is clicked.
|
||||
::
|
||||
|
||||
Use the `close-icon` prop to customize the close button icon. Defaults to `i-heroicons-x-mark-20-solid`.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- title
|
||||
- description
|
||||
- close
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
close: true
|
||||
close-icon: ''
|
||||
---
|
||||
::
|
||||
|
||||
::tip
|
||||
You can customize this icon globally in your `app.config.ts` under `ui.icons.loading` key.
|
||||
::
|
||||
|
||||
You can pass all the props of the [Button](/components/button) component to customize it.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- title
|
||||
- description
|
||||
- close.color
|
||||
- close.variant
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
close:
|
||||
color: primary
|
||||
variant: outline
|
||||
class: 'rounded-full'
|
||||
---
|
||||
::
|
||||
|
||||
### Actions
|
||||
|
||||
Use the `actions` prop to add some [Button](/components/button) actions to the Alert.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- title
|
||||
- actions
|
||||
props:
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
actions:
|
||||
- label: Action 1
|
||||
- label: Action 2
|
||||
color: gray
|
||||
variant: subtle
|
||||
---
|
||||
::
|
||||
|
||||
::tip
|
||||
Actions will render differently when the description is not set. You can try to remove it.
|
||||
::
|
||||
|
||||
### Style
|
||||
|
||||
Use the `color` and `variant` props to change the style of the Alert.
|
||||
|
||||
::component-code
|
||||
---
|
||||
ignore:
|
||||
- title
|
||||
- description
|
||||
- icon
|
||||
props:
|
||||
color: gray
|
||||
variant: outline
|
||||
title: 'Heads up!'
|
||||
description: 'You can change the primary color in your app config.'
|
||||
icon: 'i-heroicons-command-line'
|
||||
---
|
||||
::
|
||||
|
||||
## API
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ A `span` will be rendered instead of a link when the `to` property is not define
|
||||
|
||||
### Separator
|
||||
|
||||
Use the `separatorIcon` prop to customize the icon between each item. Defaults to `i-heroicons-chevron-right-20-solid`.
|
||||
Use the `separator-icon` prop to customize the [Icon](/components/icon) between each item. Defaults to `i-heroicons-chevron-right-20-solid`.
|
||||
|
||||
:component-example{name="breadcrumb-separator-example"}
|
||||
|
||||
|
||||
@@ -72,7 +72,7 @@ slots:
|
||||
|
||||
### Icon
|
||||
|
||||
Use the `icon` prop to show any icon from [Iconify](https://icones.js.org).
|
||||
Use the `icon` prop to show an [Icon](/components/icon) inside the Button.
|
||||
|
||||
::component-code
|
||||
---
|
||||
@@ -115,7 +115,7 @@ props:
|
||||
|
||||
Use the `loading` prop to show a loading icon and disable the Button.
|
||||
|
||||
Use the `loading-icon` prop or globally in `appConfig.ui.icons.loading` to set a different icon.
|
||||
Use the `loading-icon` prop to customize this icon. Defaults to `i-heroicons-arrow-path-20-solid`.
|
||||
|
||||
::component-code
|
||||
---
|
||||
@@ -130,6 +130,10 @@ slots:
|
||||
Button
|
||||
::
|
||||
|
||||
::tip
|
||||
You can customize this icon globally in your `app.config.ts` under `ui.icons.loading` key.
|
||||
::
|
||||
|
||||
### Disabled
|
||||
|
||||
Use the `disabled` prop to disable the Button.
|
||||
|
||||
@@ -117,6 +117,7 @@ export default defineNuxtConfig({
|
||||
hooks: {
|
||||
'components:extend': (components) => {
|
||||
const globals = components.filter(c => [
|
||||
'UAlert',
|
||||
'UBadge',
|
||||
'UButton',
|
||||
'UIcon',
|
||||
|
||||
@@ -13,7 +13,7 @@ const actions = (color: string) => [{
|
||||
|
||||
const data = {
|
||||
title: 'Heads up!',
|
||||
description: 'You can add components to your app using the cli.',
|
||||
description: 'You can change the primary color in your app config.',
|
||||
icon: 'i-heroicons-command-line',
|
||||
close: true
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user