docs(separator): update

This commit is contained in:
Benjamin Canac
2024-09-04 11:36:19 +02:00
parent 7c18232932
commit 29a9be2fdf
7 changed files with 122 additions and 28 deletions

View File

@@ -62,7 +62,7 @@ ignore:
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'
avatar.src: 'https://github.com/benjamincanac.png'
---
::

View File

@@ -17,13 +17,13 @@ prettier: true
slots:
default: |
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac" />
<UAvatar src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel" />
<UAvatar src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter" />
<UAvatar src="https://github.com/benjamincanac.png" alt="Benjamin Canac" />
<UAvatar src="https://github.com/romhml.png" alt="Romain Hamel" />
<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://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel"}
:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter"}
:u-avatar{src="https://github.com/benjamincanac.png" alt="Benjamin Canac"}
:u-avatar{src="https://github.com/romhml.png" alt="Romain Hamel"}
:u-avatar{src="https://github.com/noook.png" alt="Neil Richter"}
::
### Size
@@ -38,13 +38,13 @@ props:
slots:
default: |
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac" />
<UAvatar src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel" />
<UAvatar src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter" />
<UAvatar src="https://github.com/benjamincanac.png" alt="Benjamin Canac" />
<UAvatar src="https://github.com/romhml.png" alt="Romain Hamel" />
<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://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel"}
:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter"}
:u-avatar{src="https://github.com/benjamincanac.png" alt="Benjamin Canac"}
:u-avatar{src="https://github.com/romhml.png" alt="Romain Hamel"}
:u-avatar{src="https://github.com/noook.png" alt="Neil Richter"}
::
### Max
@@ -59,13 +59,13 @@ props:
slots:
default: |
<UAvatar src="https://avatars.githubusercontent.com/u/739984?v=4" alt="Benjamin Canac" />
<UAvatar src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel" />
<UAvatar src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter" />
<UAvatar src="https://github.com/benjamincanac.png" alt="Benjamin Canac" />
<UAvatar src="https://github.com/romhml.png" alt="Romain Hamel" />
<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://avatars.githubusercontent.com/u/25613751?v=4" alt="Romain Hamel"}
:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="Neil Richter"}
:u-avatar{src="https://github.com/benjamincanac.png" alt="Benjamin Canac"}
:u-avatar{src="https://github.com/romhml.png" alt="Romain Hamel"}
:u-avatar{src="https://github.com/noook.png" alt="Neil Richter"}
::
## Examples

View File

@@ -18,7 +18,7 @@ Use the `src` prop to set the image URL. You can pass any property from HTML `<i
::component-code
---
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:
- src
props:
src: 'https://avatars.githubusercontent.com/u/739984?v=4'
src: 'https://github.com/benjamincanac.png'
size: xl
---
::

View File

@@ -102,9 +102,9 @@ props:
slots:
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

View File

@@ -44,7 +44,7 @@ props:
items:
- - label: Benjamin
avatar:
src: 'https://avatars.githubusercontent.com/u/739984?v=4'
src: 'https://github.com/benjamincanac.png'
type: label
- - label: Profile
icon: i-heroicons-user

View File

@@ -7,14 +7,107 @@ links:
- label: GitHub
icon: i-simple-icons-github
to: https://github.com/benjamincanac/ui3/tree/dev/src/runtime/components/Divider.vue
navigation:
badge:
label: Todo
---
## 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

View File

@@ -140,6 +140,7 @@ export default defineNuxtConfig({
'UProgress',
'URadioGroup',
'USelect',
'USeparator',
'USlider',
'USlideover',
'USwitch',