Skip to content

Commit 3f65b2f

Browse files
committed
docs(mdx-components): use styled accordion instead for /headless/introduction
1 parent ff1a01f commit 3f65b2f

File tree

2 files changed

+29
-51
lines changed
  • apps/website/src

2 files changed

+29
-51
lines changed

apps/website/src/components/mdx-components/index.tsx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ import { KeyboardInteractionTable } from '../keyboard-interaction-table/keyboard
99
import { Note } from '../note/note';
1010
import { Showcase } from '../showcase/showcase';
1111
import { StatusBanner } from '../status-banner/status-banner';
12+
import {
13+
Accordion,
14+
AccordionContent,
15+
AccordionItem,
16+
AccordionTrigger,
17+
} from '@qwik-ui/styled';
1218

1319
export const components: Record<string, Component> = {
1420
p: component$<PropsOf<'p'>>(({ ...props }) => {
@@ -111,13 +117,11 @@ export const components: Record<string, Component> = {
111117
</div>
112118
);
113119
}),
114-
code: component$<PropsOf<'code'>>(() => {
115-
return (
116-
<code class="whitespace-pre-wrap">
117-
<Slot />
118-
</code>
119-
);
120-
}),
120+
121+
Accordion,
122+
AccordionItem,
123+
AccordionTrigger,
124+
AccordionContent,
121125
AnatomyTable,
122126
APITable,
123127
CodeSnippet,

apps/website/src/routes/docs/headless/introduction/index.mdx

Lines changed: 18 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,6 @@ title: Qwik UI | Introduction
33
---
44

55
import headlessHero from '/public/images/qwik-ui-headless-hero.webp';
6-
import { Note } from '~/components/note/note';
7-
import { FeatureList } from '~/components/feature-list/feature-list';
8-
import {
9-
AccordionRoot,
10-
AccordionItem,
11-
AccordionHeader,
12-
AccordionTrigger,
13-
AccordionContent,
14-
} from '@qwik-ui/headless';
15-
16-
import { CollapsibleIcon } from '~/components/icons/CollapsibleIcon.tsx';
176

187
# Headless kit
198

@@ -102,50 +91,35 @@ One of the benefits of Qwik is its ability to create performant applications wit
10291

10392
## FAQ
10493

105-
<AccordionRoot animated enhance={true}>
106-
<AccordionItem class="border-b">
107-
<AccordionHeader as="h3">
108-
<AccordionTrigger class="group flex w-full items-center justify-between rounded-t-sm py-4 text-left hover:underline">
109-
<span class="font-medium">What kind of support or resources are available if I encounter issues with Qwik UI?</span>
110-
<CollapsibleIcon class="ease transition-transform duration-500 group-aria-expanded:rotate-180 group-aria-expanded:transform min-w-[1rem]" /> </AccordionTrigger>
111-
</AccordionHeader>
112-
<AccordionContent class="accordion-animation-1 overflow-hidden">
113-
<div class="pb-4">
114-
If you stumble into any problems, [create an issue](https://github.com/qwikifiers/qwik-ui/issues) on the Qwik UI repository.
115-
We also have a [discord community](https://discord.gg/PVWUUejrez) with a Qwik UI channel where you can raise any concerns, propose ideas, or chat all things Qwik UI 😊
116-
</div>
117-
</AccordionContent>
94+
<Accordion>
95+
<AccordionItem>
96+
<AccordionTrigger>
97+
What kind of support or resources are available if I encounter issues with Qwik UI?
98+
</AccordionTrigger>
99+
<AccordionContent>
100+
If you stumble into any problems, [create an issue](https://github.com/qwikifiers/qwik-ui/issues) on the Qwik UI repository.
101+
We also have a [discord community](https://discord.gg/PVWUUejrez) with a Qwik UI channel where you can raise any concerns, propose ideas, or chat all things Qwik UI 😊
102+
</AccordionContent>
118103
</AccordionItem>
119-
<AccordionItem class="border-b">
120-
<AccordionHeader as="h3">
121-
<AccordionTrigger class="group flex w-full items-center justify-between py-4 text-left hover:underline">
122-
<span class="font-medium">How can I contribute to the project?</span>
123-
<CollapsibleIcon class="ease transition-transform duration-500 group-aria-expanded:rotate-180 group-aria-expanded:transform min-w-[1rem]" />
104+
<AccordionItem>
105+
<AccordionTrigger>
106+
How can I contribute to the project?
124107
</AccordionTrigger>
125-
</AccordionHeader>
126-
<AccordionContent class="accordion-animation-1 overflow-hidden">
127-
<div class="pb-4">
108+
<AccordionContent>
128109
We provide a [contributing](/docs/headless/contributing) guide to help get familiar with the repository.
129110
Additionally, we offer a quick start [setup guide](https://github.com/qwikifiers/qwik-ui/blob/main/CONTRIBUTING.md) and a section dedicated to advanced resources below the Components navigation.
130-
</div>
131111
</AccordionContent>
132112
</AccordionItem>
133-
<AccordionItem class="border-b">
134-
<AccordionHeader as="h3">
135-
<AccordionTrigger class="group flex w-full items-center justify-between py-4 text-left hover:underline aria-expanded:rounded-none">
136-
<span class="font-medium">How can I migrate my existing application to use Qwik UI?</span>
137-
<CollapsibleIcon class="ease transition-transform duration-500 group-aria-expanded:rotate-180 group-aria-expanded:transform min-w-[1rem]" />
113+
<AccordionItem>
114+
<AccordionTrigger>
115+
How can I migrate my existing application to use Qwik UI?
138116
</AccordionTrigger>
139-
</AccordionHeader>
140-
<AccordionContent class="accordion-animation-1 overflow-hidden">
141-
<div class="pb-4">
117+
<AccordionContent>
142118
If you're using `Qwik-React`, `Qwik-Angular`, `@qwikdev/astro`, we suggest incrementally adding Qwik UI components to your application.
143119
Qwik, built as a microfrontend, allows you to incrementally integrate Qwik UI components into your existing application. This approach reduces migration risk and complexity, letting you leverage Qwik UI's benefits at your own pace.
144-
</div>
145120
</AccordionContent>
146121
</AccordionItem>
147-
148-
</AccordionRoot>
122+
</Accordion>
149123

150124
## Credits
151125

0 commit comments

Comments
 (0)