mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-26 18:00:43 +01:00
docs(separator): update
This commit is contained in:
@@ -62,7 +62,7 @@ ignore:
|
|||||||
props:
|
props:
|
||||||
title: 'Heads up!'
|
title: 'Heads up!'
|
||||||
description: 'You can change the primary color in your app config.'
|
description: 'You can change the primary color in your app config.'
|
||||||
avatar.src: 'https://avatars.githubusercontent.com/u/739984?v=4'
|
avatar.src: 'https://github.com/benjamincanac.png'
|
||||||
---
|
---
|
||||||
::
|
::
|
||||||
|
|
||||||
|
|||||||
@@ -17,13 +17,13 @@ prettier: true
|
|||||||
slots:
|
slots:
|
||||||
default: |
|
default: |
|
||||||
|
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac" />
|
<UAvatar src="https://github.com/benjamincanac.png" alt="Benjamin Canac" />
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel" />
|
<UAvatar src="https://github.com/romhml.png" alt="Romain Hamel" />
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter" />
|
<UAvatar src="https://github.com/noook.png" alt="Neil Richter" />
|
||||||
---
|
---
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac"}
|
:u-avatar{src="https://github.com/benjamincanac.png" alt="Benjamin Canac"}
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel"}
|
:u-avatar{src="https://github.com/romhml.png" alt="Romain Hamel"}
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter"}
|
:u-avatar{src="https://github.com/noook.png" alt="Neil Richter"}
|
||||||
::
|
::
|
||||||
|
|
||||||
### Size
|
### Size
|
||||||
@@ -38,13 +38,13 @@ props:
|
|||||||
slots:
|
slots:
|
||||||
default: |
|
default: |
|
||||||
|
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac" />
|
<UAvatar src="https://github.com/benjamincanac.png" alt="Benjamin Canac" />
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel" />
|
<UAvatar src="https://github.com/romhml.png" alt="Romain Hamel" />
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter" />
|
<UAvatar src="https://github.com/noook.png" alt="Neil Richter" />
|
||||||
---
|
---
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac"}
|
:u-avatar{src="https://github.com/benjamincanac.png" alt="Benjamin Canac"}
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel"}
|
:u-avatar{src="https://github.com/romhml.png" alt="Romain Hamel"}
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter"}
|
:u-avatar{src="https://github.com/noook.png" alt="Neil Richter"}
|
||||||
::
|
::
|
||||||
|
|
||||||
### Max
|
### Max
|
||||||
@@ -59,13 +59,13 @@ props:
|
|||||||
slots:
|
slots:
|
||||||
default: |
|
default: |
|
||||||
|
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac" />
|
<UAvatar src="https://github.com/benjamincanac.png" alt="Benjamin Canac" />
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel" />
|
<UAvatar src="https://github.com/romhml.png" alt="Romain Hamel" />
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter" />
|
<UAvatar src="https://github.com/noook.png" alt="Neil Richter" />
|
||||||
---
|
---
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac"}
|
:u-avatar{src="https://github.com/benjamincanac.png" alt="Benjamin Canac"}
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel"}
|
:u-avatar{src="https://github.com/romhml.png" alt="Romain Hamel"}
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter"}
|
:u-avatar{src="https://github.com/noook.png" alt="Neil Richter"}
|
||||||
::
|
::
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ Use the `src` prop to set the image URL. You can pass any property from HTML `<i
|
|||||||
::component-code
|
::component-code
|
||||||
---
|
---
|
||||||
props:
|
props:
|
||||||
src: 'https://avatars.githubusercontent.com/u/739984?v=4'
|
src: 'https://github.com/benjamincanac.png'
|
||||||
---
|
---
|
||||||
::
|
::
|
||||||
|
|
||||||
@@ -31,7 +31,7 @@ Use the `size` prop to set the size of the Avatar.
|
|||||||
ignore:
|
ignore:
|
||||||
- src
|
- src
|
||||||
props:
|
props:
|
||||||
src: 'https://avatars.githubusercontent.com/u/739984?v=4'
|
src: 'https://github.com/benjamincanac.png'
|
||||||
size: xl
|
size: xl
|
||||||
---
|
---
|
||||||
::
|
::
|
||||||
|
|||||||
@@ -102,9 +102,9 @@ props:
|
|||||||
slots:
|
slots:
|
||||||
default: |
|
default: |
|
||||||
|
|
||||||
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" />
|
<UAvatar src="https://github.com/benjamincanac.png" />
|
||||||
---
|
---
|
||||||
:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4"}
|
:u-avatar{src="https://github.com/benjamincanac.png"}
|
||||||
::
|
::
|
||||||
|
|
||||||
### Standalone
|
### Standalone
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ props:
|
|||||||
items:
|
items:
|
||||||
- - label: Benjamin
|
- - label: Benjamin
|
||||||
avatar:
|
avatar:
|
||||||
src: 'https://avatars.githubusercontent.com/u/739984?v=4'
|
src: 'https://github.com/benjamincanac.png'
|
||||||
type: label
|
type: label
|
||||||
- - label: Profile
|
- - label: Profile
|
||||||
icon: i-heroicons-user
|
icon: i-heroicons-user
|
||||||
|
|||||||
@@ -7,14 +7,107 @@ 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/Divider.vue
|
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Divider.vue
|
||||||
navigation:
|
|
||||||
badge:
|
|
||||||
label: Todo
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
## Examples
|
Use the Separator component as-is to separate content.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
class: 'p-8'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Orientation
|
||||||
|
|
||||||
|
Use the `orientation` prop to change the orientation of the Separator. Defaults to `horizontal`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
ignore:
|
||||||
|
- class
|
||||||
|
class: 'p-8 justify-center'
|
||||||
|
props:
|
||||||
|
orientation: vertical
|
||||||
|
class: 'h-48'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Label
|
||||||
|
|
||||||
|
Use the `label` prop to display a label in the middle of the Separator.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
class: 'p-8 justify-center'
|
||||||
|
props:
|
||||||
|
label: 'Hello World'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Icon
|
||||||
|
|
||||||
|
Use the `icon` prop to display an icon in the middle of the Separator.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
class: 'p-8 justify-center'
|
||||||
|
props:
|
||||||
|
icon: 'i-simple-icons-nuxtdotjs'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Avatar
|
||||||
|
|
||||||
|
Use the `avatar` prop to display an avatar in the middle of the Separator.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
prettier: true
|
||||||
|
class: 'p-8 justify-center'
|
||||||
|
props:
|
||||||
|
avatar:
|
||||||
|
src: 'https://github.com/benjamincanac.png'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Color
|
||||||
|
|
||||||
|
Use the `color` prop to change the color of the Separator. Defaults to `gray`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
class: 'p-8 justify-center'
|
||||||
|
props:
|
||||||
|
color: 'primary'
|
||||||
|
type: solid
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Type
|
||||||
|
|
||||||
|
Use the `type` prop to change the type of the Separator. Defaults to `solid`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
class: 'p-8'
|
||||||
|
props:
|
||||||
|
type: dashed
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
|
### Size
|
||||||
|
|
||||||
|
Use the `size` prop to change the size of the Separator. Defaults to `xs`.
|
||||||
|
|
||||||
|
::component-code
|
||||||
|
---
|
||||||
|
class: 'p-8'
|
||||||
|
props:
|
||||||
|
size: 'lg'
|
||||||
|
---
|
||||||
|
::
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
|
|||||||
@@ -140,6 +140,7 @@ export default defineNuxtConfig({
|
|||||||
'UProgress',
|
'UProgress',
|
||||||
'URadioGroup',
|
'URadioGroup',
|
||||||
'USelect',
|
'USelect',
|
||||||
|
'USeparator',
|
||||||
'USlider',
|
'USlider',
|
||||||
'USlideover',
|
'USlideover',
|
||||||
'USwitch',
|
'USwitch',
|
||||||
|
|||||||
Reference in New Issue
Block a user