Skip to content

Commit 42b3681

Browse files
committed
docs: added status to README
1 parent a517b7a commit 42b3681

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,34 +35,34 @@
3535

3636
</details>
3737

38-
## ⚠ This is not ready for production!
39-
40-
This library is still in early stages and once we'll collect enough feedback from the community we'll release the first beta version.
41-
42-
### ROADMAP
43-
44-
- [ ] Deploy the documentation site
45-
- [ ] Add "Readiness" statuses to the components
46-
- [ ] Add a getting started video tutorial
47-
- [ ] Make a public storybook url
48-
- [ ] Deploy the tailwind-kit package
49-
- [ ] Cover all of the components with storybook tests
50-
- [ ] Add testing coverage reports
51-
- [ ] Add a contribution tutorial video
52-
5338
<br/>
5439

5540
## Installation of the headless components
5641

57-
> Please create issue if you encounter bugs.
58-
5942
```console
6043

6144
npm install -D @qwik-ui/headless
6245
```
6346

6447
<br/>
6548

49+
## Components Status
50+
51+
### Headless Kit
52+
53+
| Component | Planned | Draft (Alpha) | Beta | Stable |
54+
| :------------------------------------------------------------ | :-----: | ------------- | ---- | ------ |
55+
| [Accordion](https://qwikui.com/docs/headless/accordion) | | || |
56+
| [Autocomplete](https://qwikui.com/docs/headless/autocomplete) | || | |
57+
| Carousel || | | |
58+
| Dialog || | | |
59+
| Pagination || | | |
60+
| [Popover](https://qwikui.com/docs/headless/popover) | || | |
61+
| [Select](https://qwikui.com/docs/headless/select) | || | |
62+
| [Tabs](https://qwikui.com/docs/headless/tabs) | | || |
63+
| [Toggle](https://qwikui.com/docs/headless/toggle) || | | |
64+
| [Tooltip](https://qwikui.com/docs/headless/tooltip) | || | |
65+
6666
## Contributing
6767

6868
Want to contribute? Yayy! 🎉

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ export const statusByComponent: ComponentKitsStatuses = {
4242
Accordion: ComponentStatus.Beta,
4343
Autocomplete: ComponentStatus.Draft,
4444
Carousel: ComponentStatus.Planned,
45-
Popover: ComponentStatus.Planned,
45+
Popover: ComponentStatus.Draft,
4646
Select: ComponentStatus.Draft,
4747
Tabs: ComponentStatus.Beta,
4848
Toggle: ComponentStatus.Planned,
49-
Tooltip: ComponentStatus.Planned
49+
Tooltip: ComponentStatus.Draft
5050
}
5151
};

0 commit comments

Comments
 (0)