feat: added accordion docs
This commit is contained in:
victor
@@ -1,15 +1,154 @@
|
||||
<script setup>
|
||||
import AccordionExample from './examples/AccordionExample.vue'
|
||||
import AccordionExample from './examples/AccordionExample.vue';
|
||||
import AccordionAlwaysOpenExample from './examples/AccordionAlwaysOpenExample.vue';
|
||||
import AccordionFlushExample from './examples/AccordionFlushExample.vue';
|
||||
import AccordionStyledHeadersExample from './examples/AccordionStyledHeadersExample.vue';
|
||||
</script>
|
||||
# Vue Accordion Component - Flowbite
|
||||
|
||||
#### Use Tailwind CSS accordion component to show expanding content
|
||||
---
|
||||
|
||||
:::tip
|
||||
Original reference: [https://flowbite.com/docs/components/accordion/](https://flowbite.com/docs/components/accordion/)
|
||||
:::
|
||||
|
||||
## Default accordion
|
||||
Use this example to basic accordion.
|
||||
```vue
|
||||
<script setup>
|
||||
import { Accordion } from 'flowbite-vue'
|
||||
import { Accordion } from 'flowbite'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion></Accordion>
|
||||
<Accordion :items="items">
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
|
||||
```
|
||||
|
||||
<AccordionExample />
|
||||
|
||||
## Always open accordion
|
||||
Always open prop to makes accordion able to open multiple elements.
|
||||
```vue
|
||||
<script setup>
|
||||
import { Accordion } from 'flowbite'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion :items="items" always-open>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
|
||||
```
|
||||
|
||||
<AccordionAlwaysOpenExample />
|
||||
|
||||
## Flush accordion
|
||||
Flush prop makes opened tab being not able to close.
|
||||
```vue
|
||||
<script setup>
|
||||
import { Accordion } from 'flowbite'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion :items="items" flush>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
|
||||
```
|
||||
|
||||
<AccordionFlushExample />
|
||||
|
||||
## Styling accordion
|
||||
You can style headers with `header-classes` prop and content containers with `content-classes` props by pass tailwind classes.
|
||||
```vue
|
||||
<script setup>
|
||||
import { Accordion } from 'flowbite'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion :items="items" header-classes="bg-blue-800">
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
|
||||
```
|
||||
|
||||
<AccordionStyledHeadersExample />
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
<script setup>
|
||||
import { Accordion } from '../../../../src/index'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion :items="items" always-open>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
@@ -1,6 +1,16 @@
|
||||
<script setup>
|
||||
import { Accordion } from '../../../../src/index'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="vp-raw flex flex-col">
|
||||
<Accordion :items="items" content-classes="bg-red-100">
|
||||
<Accordion :items="items">
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
@@ -9,14 +19,9 @@
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
<script setup>
|
||||
|
||||
const items = [
|
||||
{ header: 'ehehe' },
|
||||
{ header: 'ehehe\'nt' },
|
||||
]
|
||||
import { Accordion } from '../../../../src/index'
|
||||
</script>
|
||||
|
||||
27
docs/components/accordion/examples/AccordionFlushExample.vue
Normal file
27
docs/components/accordion/examples/AccordionFlushExample.vue
Normal file
@@ -0,0 +1,27 @@
|
||||
<script setup>
|
||||
import { Accordion } from '../../../../src/index'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion :items="items" flush>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
@@ -0,0 +1,27 @@
|
||||
<script setup>
|
||||
import { Accordion } from '../../../../src/index'
|
||||
import { ref } from 'vue'
|
||||
|
||||
const items = ref([
|
||||
{ header: 'header' },
|
||||
{ header: 'another header' },
|
||||
{ header: 'and one more header' },
|
||||
])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Accordion :items="items" header-classes="bg-blue-800">
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is an open-source library of interactive components built on top of Tailwind CSS including buttons, dropdowns, modals, navbars, and more.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out this guide to learn how to <a href="/docs/getting-started/introduction/" class="text-blue-600 dark:text-blue-500 hover:underline">get started</a> and start developing websites even faster with components on top of Tailwind CSS.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
<div>
|
||||
<p class="mb-2 text-gray-500 dark:text-gray-400">Flowbite is first conceptualized and designed using the Figma software so everything you see in the library has a design equivalent in our Figma file.</p>
|
||||
<p class="text-gray-500 dark:text-gray-400">Check out the <a href="https://flowbite.com/figma/" class="text-blue-600 dark:text-blue-500 hover:underline">Figma design system</a> based on the utility classes from Tailwind CSS and components from Flowbite.</p>
|
||||
</div>
|
||||
</Accordion>
|
||||
</template>
|
||||
@@ -1,5 +1,5 @@
|
||||
<template>
|
||||
<div>
|
||||
<div class="vp-raw flex flex-col">
|
||||
<template v-for="(item, i) in formattedItems" :key="item.id">
|
||||
<h2>
|
||||
<button
|
||||
|
||||
Reference in New Issue
Block a user