Merge branch 'main' into breadcrumb-component
# Conflicts: # docs/.vitepress/config.ts
This commit is contained in:
@@ -1,15 +1,114 @@
|
||||
<script setup>
|
||||
import BadgeExample from './examples/BadgeExample.vue'
|
||||
import BadgeTypesExample from './examples/BadgeTypesExample.vue'
|
||||
import BadgeSizesExample from './examples/BadgeSizesExample.vue'
|
||||
import BadgeLinksExample from './examples/BadgeLinksExample.vue'
|
||||
import BadgeIconsExample from './examples/BadgeIconsExample.vue'
|
||||
import BadgeOnlyIconsExample from './examples/BadgeOnlyIconsExample.vue'
|
||||
</script>
|
||||
# Badge
|
||||
|
||||
#### Use Tailwind CSS badges as elements to show counts or labels separately or inside other components
|
||||
---
|
||||
|
||||
:::tip
|
||||
Original reference: [https://flowbite.com/docs/components/badge/](https://flowbite.com/docs/components/badge/)
|
||||
:::
|
||||
|
||||
The badge component can be used to complement other elements such as buttons or text elements as a label or to show the count of a given data, such as the number of comments for an article or how much time has passed by since a comment has been made.
|
||||
Alternatively, badges can also be used as standalone elements that link to a certain page by using the anchor tag instead of a span element.
|
||||
|
||||
|
||||
|
||||
## Default badge
|
||||
Prop – type
|
||||
|
||||
<BadgeTypesExample />
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Badge } from 'flowbite-vue'
|
||||
</script>
|
||||
<template>
|
||||
<Badge></Badge>
|
||||
<Badge />
|
||||
<Badge type="dark" />
|
||||
<Badge type="red" />
|
||||
<Badge type="green" />
|
||||
<Badge type="yellow" />
|
||||
<Badge type="indigo" />
|
||||
<Badge type="purple" />
|
||||
<Badge type="pink" />
|
||||
</template>
|
||||
```
|
||||
|
||||
<BadgeExample />
|
||||
## Large badges
|
||||
Prop – size
|
||||
|
||||
<BadgeSizesExample />
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Badge } from 'flowbite-vue'
|
||||
</script>
|
||||
<template>
|
||||
<Badge />
|
||||
<Badge type="dark" />
|
||||
<Badge type="red" />
|
||||
<Badge type="green" />
|
||||
<Badge type="yellow" />
|
||||
<Badge type="indigo" />
|
||||
<Badge type="purple" />
|
||||
<Badge type="pink" />
|
||||
</template>
|
||||
```
|
||||
|
||||
## Badges as links
|
||||
You can also use badges as anchor elements to link to another page.
|
||||
Prop – href
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Badge } from 'flowbite-vue'
|
||||
</script>
|
||||
<template>
|
||||
<Badge href="#">Link</Badge>
|
||||
</template>
|
||||
```
|
||||
|
||||
<BadgeLinksExample />
|
||||
|
||||
## Badges with icon
|
||||
You can also use SVG icons inside the badge elements.
|
||||
slot icon
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Badge } from 'flowbite-vue'
|
||||
</script>
|
||||
<template>
|
||||
<Badge>
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="mr-1 w-3 h-3" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
Default
|
||||
</Badge>
|
||||
</template>
|
||||
```
|
||||
|
||||
<BadgeIconsExample />
|
||||
|
||||
## Badge with icon only
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { Badge } from 'flowbite-vue'
|
||||
</script>
|
||||
<template>
|
||||
<Badge>
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="w-5 h-5" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
</Badge>
|
||||
</template>
|
||||
```
|
||||
|
||||
<BadgeOnlyIconsExample />
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
<template>
|
||||
<div class="vp-raw flex flex-col">
|
||||
<Badge></Badge>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import { Badge } from '../../../../src/index'
|
||||
</script>
|
||||
19
docs/components/badge/examples/BadgeIconsExample.vue
Normal file
19
docs/components/badge/examples/BadgeIconsExample.vue
Normal file
@@ -0,0 +1,19 @@
|
||||
<template>
|
||||
<div class="vp-raw flex items-end">
|
||||
<Badge>
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="mr-1 w-3 h-3" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
Default
|
||||
</Badge>
|
||||
<Badge type="dark" size="sm">
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="mr-1 w-3 h-3" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
Dark
|
||||
</Badge>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import Badge from '@/components/Badge/Badge.vue'
|
||||
</script>
|
||||
9
docs/components/badge/examples/BadgeLinksExample.vue
Normal file
9
docs/components/badge/examples/BadgeLinksExample.vue
Normal file
@@ -0,0 +1,9 @@
|
||||
<template>
|
||||
<div class="vp-raw flex items-end">
|
||||
<Badge href="#">Link</Badge>
|
||||
<Badge size="sm" href="#">Link</Badge>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import { Badge } from '../../../../src/index'
|
||||
</script>
|
||||
22
docs/components/badge/examples/BadgeOnlyIconsExample.vue
Normal file
22
docs/components/badge/examples/BadgeOnlyIconsExample.vue
Normal file
@@ -0,0 +1,22 @@
|
||||
<template>
|
||||
<div class="vp-raw flex items-end">
|
||||
<Badge>
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="w-5 h-5" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
</Badge>
|
||||
<Badge type="dark">
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="w-5 h-5" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
</Badge>
|
||||
<Badge type="green" size="sm">
|
||||
<template #icon>
|
||||
<svg aria-hidden="true" class="w-5 h-5" fill="currentColor" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm1-12a1 1 0 10-2 0v4a1 1 0 00.293.707l2.828 2.829a1 1 0 101.415-1.415L11 9.586V6z" clip-rule="evenodd"></path></svg>
|
||||
</template>
|
||||
</Badge>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import Badge from '@/components/Badge/Badge.vue'
|
||||
</script>
|
||||
15
docs/components/badge/examples/BadgeSizesExample.vue
Normal file
15
docs/components/badge/examples/BadgeSizesExample.vue
Normal file
@@ -0,0 +1,15 @@
|
||||
<template>
|
||||
<div class="vp-raw flex">
|
||||
<Badge size="sm">Default</Badge>
|
||||
<Badge type="dark" size="sm">Dark</Badge>
|
||||
<Badge type="red" size="sm">Red</Badge>
|
||||
<Badge type="green" size="sm">Green</Badge>
|
||||
<Badge type="yellow" size="sm">Yellow</Badge>
|
||||
<Badge type="indigo" size="sm">Indigo</Badge>
|
||||
<Badge type="purple" size="sm">Purple</Badge>
|
||||
<Badge type="pink" size="sm">Pink</Badge>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import { Badge } from '../../../../src/index'
|
||||
</script>
|
||||
15
docs/components/badge/examples/BadgeTypesExample.vue
Normal file
15
docs/components/badge/examples/BadgeTypesExample.vue
Normal file
@@ -0,0 +1,15 @@
|
||||
<template>
|
||||
<div class="vp-raw flex">
|
||||
<Badge>Default</Badge>
|
||||
<Badge type="dark">Dark</Badge>
|
||||
<Badge type="red">Red</Badge>
|
||||
<Badge type="green">Green</Badge>
|
||||
<Badge type="yellow">Yellow</Badge>
|
||||
<Badge type="indigo">Indigo</Badge>
|
||||
<Badge type="purple">Purple</Badge>
|
||||
<Badge type="pink">Pink</Badge>
|
||||
</div>
|
||||
</template>
|
||||
<script setup>
|
||||
import { Badge } from '../../../../src/index'
|
||||
</script>
|
||||
Reference in New Issue
Block a user