From 70b964f3a0e2b074f12a4c47ad68c093e177eaed Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Thu, 18 Jul 2024 11:06:26 +0200 Subject: [PATCH] docs(avatar-group): update --- .../avatar-group/AvatarGroupChipExample.vue | 22 ++++++++ .../avatar-group/AvatarGroupLinkExample.vue | 37 ++++++++++++ .../AvatarGroupTooltipExample.vue | 22 ++++++++ docs/content/3.components/avatar-group.md | 56 +++++++++++++------ playground/app/pages/components/avatar.vue | 12 ++-- test/components/AvatarGroup.spec.ts | 6 +- .../__snapshots__/AvatarGroup.spec.ts.snap | 28 +++++----- 7 files changed, 142 insertions(+), 41 deletions(-) create mode 100644 docs/app/components/content/examples/avatar-group/AvatarGroupChipExample.vue create mode 100644 docs/app/components/content/examples/avatar-group/AvatarGroupLinkExample.vue create mode 100644 docs/app/components/content/examples/avatar-group/AvatarGroupTooltipExample.vue diff --git a/docs/app/components/content/examples/avatar-group/AvatarGroupChipExample.vue b/docs/app/components/content/examples/avatar-group/AvatarGroupChipExample.vue new file mode 100644 index 00000000..74a792e0 --- /dev/null +++ b/docs/app/components/content/examples/avatar-group/AvatarGroupChipExample.vue @@ -0,0 +1,22 @@ + diff --git a/docs/app/components/content/examples/avatar-group/AvatarGroupLinkExample.vue b/docs/app/components/content/examples/avatar-group/AvatarGroupLinkExample.vue new file mode 100644 index 00000000..dcc8293c --- /dev/null +++ b/docs/app/components/content/examples/avatar-group/AvatarGroupLinkExample.vue @@ -0,0 +1,37 @@ + diff --git a/docs/app/components/content/examples/avatar-group/AvatarGroupTooltipExample.vue b/docs/app/components/content/examples/avatar-group/AvatarGroupTooltipExample.vue new file mode 100644 index 00000000..61b6daf1 --- /dev/null +++ b/docs/app/components/content/examples/avatar-group/AvatarGroupTooltipExample.vue @@ -0,0 +1,22 @@ + diff --git a/docs/content/3.components/avatar-group.md b/docs/content/3.components/avatar-group.md index 946122ea..723fc127 100644 --- a/docs/content/3.components/avatar-group.md +++ b/docs/content/3.components/avatar-group.md @@ -15,13 +15,13 @@ Wrap multiple [Avatar](/components/avatar) within an AvatarGroup to stack them. --- slots: default: | - - - + + + --- -:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4" alt="benjamincanac"} -:u-avatar{src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="romhml"} -:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="noook"} +: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"} :: ### Size @@ -34,13 +34,13 @@ props: size: md slots: default: | - - - + + + --- -:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4" alt="benjamincanac"} -:u-avatar{src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="romhml"} -:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="noook"} +: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"} :: ### Max @@ -53,15 +53,35 @@ props: max: 2 slots: default: > - - - + + + --- -:u-avatar{src="https://avatars.githubusercontent.com/u/739984?v=4" alt="benjamincanac"} -:u-avatar{src="https://avatars.githubusercontent.com/u/25613751?v=4" alt="romhml"} -:u-avatar{src="https://avatars.githubusercontent.com/u/19751938?v=4" alt="noook"} +: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"} :: +## Examples + +### With tooltip + +Wrap each avatar with a [Tooltip](/components/tooltip) to display a tooltip on hover. + +:component-example{name="avatar-group-tooltip-example"} + +### With chip + +Wrap each avatar with a [Chip](/components/chip) to display a chip around the avatar. + +:component-example{name="avatar-group-chip-example"} + +### With link + +Wrap each avatar with a [Link](/components/link) to make them clickable. + +:component-example{name="avatar-group-link-example"} + ## API ### Props diff --git a/playground/app/pages/components/avatar.vue b/playground/app/pages/components/avatar.vue index c67b8893..1592948b 100644 --- a/playground/app/pages/components/avatar.vue +++ b/playground/app/pages/components/avatar.vue @@ -22,17 +22,17 @@ const sizes = Object.keys(theme.variants.size) as Array - + - - + +
- - - + + +
diff --git a/test/components/AvatarGroup.spec.ts b/test/components/AvatarGroup.spec.ts index 0680f00e..455b1261 100644 --- a/test/components/AvatarGroup.spec.ts +++ b/test/components/AvatarGroup.spec.ts @@ -11,9 +11,9 @@ const AvatarGroupWrapper = defineComponent({ UAvatarGroup: AvatarGroup }, template: ` - - - + + + ` }) diff --git a/test/components/__snapshots__/AvatarGroup.spec.ts.snap b/test/components/__snapshots__/AvatarGroup.spec.ts.snap index c1fc298e..0e6a7333 100644 --- a/test/components/__snapshots__/AvatarGroup.spec.ts.snap +++ b/test/components/__snapshots__/AvatarGroup.spec.ts.snap @@ -1,77 +1,77 @@ // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html -exports[`AvatarGroup > renders with as correctly 1`] = `"nrb"`; +exports[`AvatarGroup > renders with as correctly 1`] = `"NRRHBC"`; exports[`AvatarGroup > renders with class correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with default slot correctly 1`] = ` "
- nrb + NRRHBC
" `; -exports[`AvatarGroup > renders with max correctly 1`] = `"
+1rb
"`; +exports[`AvatarGroup > renders with max correctly 1`] = `"
+1RHBC
"`; exports[`AvatarGroup > renders with size 2xl correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size 2xs correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size 3xl correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size 3xs correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size lg correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size md correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size sm correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size xl correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with size xs correctly 1`] = ` "
- nrb + NRRHBC
" `; exports[`AvatarGroup > renders with ui correctly 1`] = ` "
- nrb + NRRHBC
" `;