Skip to content

Commit 83d09e2

Browse files
docs: create documentation for separator component
- Create separator example and index.mdx - Add Separator component to the list of headless menu components in menu.md
1 parent e9f9d37 commit 83d09e2

File tree

4 files changed

+97
-0
lines changed

4 files changed

+97
-0
lines changed

apps/website/src/_state/component-statuses.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export const statusByComponent: ComponentKitsStatuses = {
4444
Combobox: ComponentStatus.Draft,
4545
Popover: ComponentStatus.Draft,
4646
Select: ComponentStatus.Draft,
47+
Separator: ComponentStatus.Beta,
4748
Tabs: ComponentStatus.Beta,
4849
Toggle: ComponentStatus.Planned,
4950
Tooltip: ComponentStatus.Draft
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import { component$, Slot } from '@builder.io/qwik';
2+
import { Separator } from '@qwik-ui/headless';
3+
import { PreviewCodeExample } from '../../../_components/preview-code-example/preview-code-example';
4+
5+
export const MainExample = component$(() => {
6+
return (
7+
<PreviewCodeExample>
8+
<div q:slot="actualComponent">
9+
<div>
10+
<h1 class="text-lg">Qwik UI Headless</h1>
11+
<p class="text-sm">Accessible, Unstyled Qwik UI Components</p>
12+
</div>
13+
<Separator orientation="horizontal" class="h-px my-1 bg-primary" />
14+
<menu class="flex gap-2">
15+
<li>
16+
<a href="/docs/headless/introduction/">Introduction</a>
17+
</li>
18+
<Separator orientation="vertical" class="w-px mx-1 bg-primary" />
19+
<li>
20+
<a href="/docs/headless/install/">Installation</a>
21+
</li>
22+
<Separator orientation="vertical" class="w-px mx-1 bg-primary" />
23+
<li>
24+
<a href="/docs/headless/contributing/">Contributing</a>
25+
</li>
26+
</menu>
27+
</div>
28+
<div q:slot="codeExample">
29+
<Slot />
30+
</div>
31+
</PreviewCodeExample>
32+
);
33+
});
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Qwik UI | Separator
3+
---
4+
import { StatusBanner } from '../../../_components/status-banner/status-banner';
5+
import {statusByComponent} from '../../../../../_state/component-statuses';
6+
import { MainExample } from './examples';
7+
import { APITable } from '../../../_components/api-table/api-table';
8+
9+
<StatusBanner status={statusByComponent.headless.Separator}/>
10+
11+
# Separator
12+
13+
#### A separator separates and distinguishes sections of content or groups of menuitems
14+
15+
<MainExample>
16+
```tsx
17+
<div>
18+
<div>
19+
<h1 class="text-lg">Qwik UI Headless</h1>
20+
<p class="text-sm">Accessible, Unstyled Qwik UI Components</p>
21+
</div>
22+
<Separator orientation="horizontal" class="h-px my-1 bg-primary" />
23+
<menu class="flex gap-2">
24+
<li>
25+
<a href="/docs/headless/introduction/">Introduction</a>
26+
</li>
27+
<Separator orientation="vertical" class="w-px mx-1 bg-primary" />
28+
<li>
29+
<a href="/docs/headless/install/">Installation</a>
30+
</li>
31+
<Separator orientation="vertical" class="w-px mx-1 bg-primary" />
32+
<li>
33+
<a href="/docs/headless/contributing/">Contributing</a>
34+
</li>
35+
</menu>
36+
</div>
37+
```
38+
</MainExample>
39+
40+
Qwik UI's Separator implementation follows [WAI-Aria separator role requirements](https://www.w3.org/TR/wai-aria-1.2/#separator). This separator is static and should not be used for interactivity.
41+
42+
##### ✨ Features
43+
- Supports both horizontal and vertical orientation
44+
45+
## API
46+
<APITable
47+
propDescriptors={[
48+
{
49+
name: "orientation",
50+
type: "enum",
51+
info: '"horizontal" | "vertical"',
52+
description:
53+
"The orientation of the separator. Defaults to horizontal.",
54+
},
55+
{
56+
name: "decorative",
57+
type: "boolean",
58+
description:
59+
"Indicates that the element is purely decorative and should not be included in the accessibility tree.",
60+
},
61+
]}
62+
/>

apps/website/src/routes/docs/headless/menu.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
- [Combobox](/docs/headless/combobox)
1313
- [Popover](/docs/headless/popover)
1414
- [Select](/docs/headless/select)
15+
- [Separator](/docs/headless/separator)
1516
- [Tabs](/docs/headless/tabs)
1617
- [Toggle](/docs/headless/toggle)
1718
- [Tooltip](/docs/headless/tooltip)

0 commit comments

Comments
 (0)