Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(accordion): document context #3000

Merged
merged 4 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/react/src/components/accordion/accordion.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ export { Provider } from './examples/provider'
export { RenderProp } from './examples/render-prop'
export { Vertical } from './examples/vertical'
export { WithSlider } from './examples/with-slider'
export { ContextFocusedValue } from './examples/context/focusedValue'
export { ContextValue } from './examples/context/value'
export { ContextSetValue } from './examples/context/setValue'
export { ContextGetItemState } from './examples/context/getItemState'
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Accordion } from '@ark-ui/react/accordion'
import { ChevronDownIcon } from 'lucide-react'

export const ContextFocusedValue = () => {
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => <span>Focused item: {context.focusedValue}</span>}
</Accordion.Context>
{['React', 'Solid', 'Vue'].map((item) => (
<Accordion.Item key={item} value={item}>
<Accordion.ItemTrigger>
What is {item}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
))}
</Accordion.Root>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import { Accordion } from '@ark-ui/react/accordion'
import { ChevronDownIcon } from 'lucide-react'

export const ContextGetItemState = () => {
const items = [{ value: 'React' }, { value: 'Solid', disabled: true }, { value: 'Vue' }]
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => {
const itemState = context.getItemState(items[2])
return (
<>
<b>Vue State: </b>
<span>Disabled: {itemState.disabled ? 'Y' : 'N'} </span>
<span>Expanded: {itemState.expanded ? 'Y' : 'N'} </span>
<span>Focused: {itemState.focused ? 'Y' : 'N'} </span>
</>
)
}}
</Accordion.Context>
{items.map((item) => (
<Accordion.Item key={item.value} {...item}>
<Accordion.ItemTrigger>
What is {item.value}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item.value} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
))}
</Accordion.Root>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Accordion } from '@ark-ui/react/accordion'
import { ChevronDownIcon } from 'lucide-react'

export const ContextSetValue = () => {
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => <button onClick={() => context.setValue(['Vue'])}>Select Vue</button>}
</Accordion.Context>
{['React', 'Solid', 'Vue'].map((item) => (
<Accordion.Item key={item} value={item}>
<Accordion.ItemTrigger>
What is {item}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
))}
</Accordion.Root>
)
}
25 changes: 25 additions & 0 deletions packages/react/src/components/accordion/examples/context/value.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Accordion } from '@ark-ui/react/accordion'
import { ChevronDownIcon } from 'lucide-react'

export const ContextValue = () => {
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => <span>Selected items: {context.value.join(', ')}</span>}
</Accordion.Context>
{['React', 'Solid', 'Vue'].map((item) => (
<Accordion.Item key={item} value={item}>
<Accordion.ItemTrigger>
What is {item}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
))}
</Accordion.Root>
)
}
4 changes: 4 additions & 0 deletions packages/solid/src/components/accordion/accordion.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ export { Multiple } from './examples/multiple'
export { Provider } from './examples/provider'
export { RenderProp } from './examples/render-prop'
export { Vertical } from './examples/vertical'
export { ContextFocusedValue } from './examples/context/focusedValue'
export { ContextValue } from './examples/context/value'
export { ContextSetValue } from './examples/context/setValue'
export { ContextGetItemState } from './examples/context/getItemState'
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { Accordion } from '@ark-ui/solid/accordion'
import { ChevronDownIcon } from 'lucide-solid'
import { Index } from 'solid-js'

export const ContextFocusedValue = () => {
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => <span>Focused item: {context().focusedValue}</span>}
</Accordion.Context>
<Index each={['React', 'Solid', 'Vue']}>
{(item) => (
<Accordion.Item value={item()}>
<Accordion.ItemTrigger>
What is {item()}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item()} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
)}
</Index>
</Accordion.Root>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { Accordion } from '@ark-ui/solid/accordion'
import { ChevronDownIcon } from 'lucide-solid'
import { Index } from 'solid-js'

export const ContextGetItemState = () => {
const items = [{ value: 'React' }, { value: 'Solid', disabled: true }, { value: 'Vue' }]
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => {
const itemState = context().getItemState(items[2])
return (
<>
<b>Vue State: </b>
<span>Disabled: {itemState.disabled ? 'Y' : 'N'} </span>
<span>Expanded: {itemState.expanded ? 'Y' : 'N'} </span>
<span>Focused: {itemState.focused ? 'Y' : 'N'} </span>
</>
)
}}
</Accordion.Context>
<Index each={items}>
{(item) => (
<Accordion.Item {...item()}>
<Accordion.ItemTrigger>
What is {item().value}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item().value} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
)}
</Index>
</Accordion.Root>
)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { Accordion } from '@ark-ui/solid/accordion'
import { ChevronDownIcon } from 'lucide-solid'
import { Index } from 'solid-js'

export const ContextSetValue = () => {
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => <button onClick={() => context().setValue(['Vue'])}>Select Vue</button>}
</Accordion.Context>
<Index each={['React', 'Solid', 'Vue']}>
{(item) => (
<Accordion.Item value={item()}>
<Accordion.ItemTrigger>
What is {item()}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item()} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
)}
</Index>
</Accordion.Root>
)
}
28 changes: 28 additions & 0 deletions packages/solid/src/components/accordion/examples/context/value.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { Accordion } from '@ark-ui/solid/accordion'
import { ChevronDownIcon } from 'lucide-solid'
import { Index } from 'solid-js'

export const ContextValue = () => {
return (
<Accordion.Root defaultValue={['React']}>
<Accordion.Context>
{(context) => <span>Selected items: {context().value.join(', ')}</span>}
</Accordion.Context>
<Index each={['React', 'Solid', 'Vue']}>
{(item) => (
<Accordion.Item value={item()}>
<Accordion.ItemTrigger>
What is {item()}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{item()} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
)}
</Index>
</Accordion.Root>
)
}
16 changes: 16 additions & 0 deletions packages/vue/src/components/accordion/accordion.stories.vue
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
import Accordion from './examples/accordion.vue'
import Basic from './examples/basic.vue'
import Collapsible from './examples/collapsible.vue'
import ContextFocusedValue from './examples/context/focusedValue.vue'
import ContextGetItemState from './examples/context/getItemState.vue'
import ContextSetValue from './examples/context/setValue.vue'
import ContextValue from './examples/context/value.vue'
import Controlled from './examples/controlled.vue'
import Disabled from './examples/disabled.vue'
import Horizontal from './examples/horizontal.vue'
Expand Down Expand Up @@ -42,5 +46,17 @@ import Vertical from './examples/vertical.vue'
<Variant title="RootProvider">
<RootProvider />
</Variant>
<Variant title="ContextFocusedValue">
<ContextFocusedValue />
</Variant>
<Variant title="ContextValue">
<ContextValue />
</Variant>
<Variant title="ContextSetValue">
<ContextSetValue />
</Variant>
<Variant title="ContextGetItemState">
<ContextGetItemState />
</Variant>
</Story>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<script setup lang="ts">
import { Accordion } from '@ark-ui/vue/accordion'
import { ref } from 'vue'
import { ChevronDownIcon } from '../icons'

const items = ref(['React', 'Solid', 'Vue'])
</script>

<template>
<Accordion.Root :defaultValue="['React']">
<Accordion.Context v-slot="context">
<span>Focused item: {{ context.focusedValue }}</span>
</Accordion.Context>
<Accordion.Item v-for="item in items" :key="item" :value="item">
<Accordion.ItemTrigger>
What is {{ item }}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{{ item }} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
</Accordion.Root>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<script setup lang="ts">
import { Accordion } from '@ark-ui/vue/accordion'
import { ref } from 'vue'
import { ChevronDownIcon } from '../icons'

const items = ref([{ value: 'React' }, { value: 'Solid', disabled: true }, { value: 'Vue' }])
</script>

<template>
<Accordion.Root :defaultValue="['React']">
<Accordion.Context v-slot="context">
<b>Vue State:</b>
<span>Disabled: {{ context.getItemState(items[2]).disabled ? 'Y' : 'N' }}</span>
<span>Expanded: {{ context.getItemState(items[2]).expanded ? 'Y' : 'N' }}</span>
<span>Focused: {{ context.getItemState(items[2]).focused ? 'Y' : 'N' }}</span>
</Accordion.Context>
<Accordion.Item v-for="item in items" :key="item.value" v-bind="item">
<Accordion.ItemTrigger>
What is {{ item }}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{{ item }} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
</Accordion.Root>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<script setup lang="ts">
import { Accordion } from '@ark-ui/vue/accordion'
import { ref } from 'vue'
import { ChevronDownIcon } from '../icons'

const items = ref(['React', 'Solid', 'Vue'])
</script>

<template>
<Accordion.Root :defaultValue="['React']">
<Accordion.Context v-slot="context">
<button @click="context.setValue(['Vue'])">Select Vue</button>
</Accordion.Context>
<Accordion.Item v-for="item in items" :key="item" :value="item">
<Accordion.ItemTrigger>
What is {{ item }}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{{ item }} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
</Accordion.Root>
</template>
26 changes: 26 additions & 0 deletions packages/vue/src/components/accordion/examples/context/value.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<script setup lang="ts">
import { Accordion } from '@ark-ui/vue/accordion'
import { ref } from 'vue'
import { ChevronDownIcon } from '../icons'

const items = ref(['React', 'Solid', 'Vue'])
</script>

<template>
<Accordion.Root :defaultValue="['React']">
<Accordion.Context v-slot="context">
<span>Selected items: {{ context.value.join(', ') }}</span>
</Accordion.Context>
<Accordion.Item v-for="item in items" :key="item" :value="item">
<Accordion.ItemTrigger>
What is {{ item }}?
<Accordion.ItemIndicator>
<ChevronDownIcon />
</Accordion.ItemIndicator>
</Accordion.ItemTrigger>
<Accordion.ItemContent>
{{ item }} is a JavaScript library for building user interfaces.
</Accordion.ItemContent>
</Accordion.Item>
</Accordion.Root>
</template>
Loading