jaro/flowbite-vue
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: spinner

Browse Source
This commit is contained in:
Alexandr
2022-07-01 16:33:29 +03:00
parent 5834c29e34
commit 484dc3786e
4 changed files with 60 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/guide/spinner/examples/SpinnerColorExample.vue Normal file
View File

@@ -0,0 +1,15 @@
<template>
<div class="inline-flex align-center gap-2 flex-wrap">
<spinner color="blue" size="6" />
<spinner color="pink" size="8" />
<spinner color="gray" size="10" />
<spinner color="green" size="12" />
<spinner color="purple" size="10" />
<spinner color="white" size="8" />
<spinner color="yellow" size="6" />
<spinner color="red" size="4" />
</div>
</template>
<script setup>
import { Spinner } from '../../../../src/index'
</script>

55
docs/guide/spinner/spinner.md
View File

@@ -1,6 +1,7 @@
<script setup> <script setup>
import SpinnerBasicExample from './examples/SpinnerBasicExample.vue'; import SpinnerBasicExample from './examples/SpinnerBasicExample.vue';
import SpinnerSizeExample from './examples/SpinnerSizeExample.vue'; import SpinnerSizeExample from './examples/SpinnerSizeExample.vue';
import SpinnerColorExample from './examples/SpinnerColorExample.vue';
</script> </script>
# Spinner # Spinner
@@ -16,18 +17,18 @@ reference: [https://flowbite.com/docs/components/spinner/](https://flowbite.com/
import { Spinner } from 'flowbite-vue' import { Spinner } from 'flowbite-vue'
</script> </script>
<template> <template>
<div class="inline-flex align-center gap-2 flex-wrap">
<spinner /> <spinner />
</div>
</template> </template>
``` ```
## Prop - size ## Prop - size
```typescript ```typescript
type SpinnerSize = '0' | 'px' | '0.5' | '1' | '1.5' | '2' | '2.5' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12'
defineProps({ defineProps({
size: { size: {
type: String, // any string for w-${size} and h-${size} tailwind classes type: String as PropType<SpinnerSize>, // any string for w-${size} and h-${size} tailwind classes
default: '4', default: '4',
}, },
}) })
@@ -38,17 +39,47 @@ defineProps({
```vue ```vue
<script setup> <script setup>
import { Button } from 'flowbite-vue' import { Spinner } from 'flowbite-vue'
</script> </script>
<template> <template>
<Button color="default">Default</Button> <spinner />
<Button color="alternative">Alternative</Button> <spinner size="6" />
<Button color="dark">Dark</Button> <spinner size="8" />
<Button color="light">Light</Button> <spinner size="10" />
<Button color="green">Green</Button> <spinner size="12" />
<Button color="red">Red</Button> </template>
<Button color="yellow">Yellow</Button> ```
<Button color="purple">Purple</Button>
## Prop - color
```typescript
type SpinnerColor = 'blue' | 'gray' | 'green' | 'red' | 'yellow' | 'pink' | 'purple' | 'white'
defineProps({
color: {
type: String as PropType<SpinnerColor>,
default: 'blue',
},
})
```
<SpinnerColorExample />
```vue
<script setup>
import { Spinner } from 'flowbite-vue'
</script>
<template>
<spinner color="blue" size="6" />
<spinner color="pink" size="8" />
<spinner color="gray" size="10" />
<spinner color="green" size="12" />
<spinner color="purple" size="10" />
<spinner color="white" size="8" />
<spinner color="yellow" size="6" />
<spinner color="red" size="4" />
</template> </template>
``` ```

2
src/components/Spinner/Spinner.vue
View File

@@ -17,7 +17,7 @@ const props = defineProps({
default: '4', default: '4',
}, },
color: { color: {
type: String as PropType<SpinnerColor>, // any string for w-${size} and h-${size} tailwind classes, TODO: add all classes type: String as PropType<SpinnerColor>,
default: 'blue', default: 'blue',
}, },
}) })

1
src/composables/useColor.ts
View File

@@ -1 +0,0 @@
export function useColor() {}