Skip to content

Commit 3275522

Browse files
committed
Merge branch 'main' into pr/Zankel-Engineering/363
2 parents c3e1532 + 51ed4b0 commit 3275522

File tree

128 files changed

+3983
-11933
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

128 files changed

+3983
-11933
lines changed

.all-contributorsrc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,22 @@
301301
"contributions": [
302302
"code"
303303
]
304+
},
305+
{
306+
"login": "wmertens",
307+
"name": "Wout Mertens",
308+
"avatar_url": "https://avatars.githubusercontent.com/u/54934?v=4",
309+
"profile": "https://github.com/wmertens",
310+
"contributions": [
311+
"code",
312+
"research",
313+
"ideas",
314+
"test",
315+
"doc"
316+
]
304317
}
305318
],
306319
"contributorsPerLine": 7,
307-
"skipCi": true
320+
"skipCi": true,
321+
"commitType": "docs"
308322
}

.prettierignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44
*.
55
dist
66
node_modules
7-
coverage
7+
coverage
8+
**/*.mdx

.prettierrc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"singleQuote": true
2+
"semi": true,
3+
"singleQuote": true,
4+
"trailingComma": "none",
5+
"printWidth": 90
36
}

README.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<br>
3-
<img width="400" src="./apps/website/public/qwik-ui.png" alt="awesome logo of qwik ui">
3+
<img width="400" src="./apps/website/public/images/qwik-ui.png" alt="awesome logo of qwik ui">
44
<br>
55
<br>
66
</p>
@@ -23,46 +23,39 @@
2323

2424
</div>
2525
<br>
26-
<details>
27-
<summary>Table of Contents</summary>
2826

29-
- [Installation of the headless components](#installation-of-the-headless-components)
30-
- [Contributing](#contributing)
31-
- [Code Of Conduct](#code-of-conduct)
32-
- [Contributors](#contributors)
33-
- [Related Links](#related-links)
34-
- [License](#license)
27+
## Documentation
3528

36-
</details>
37-
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
29+
To read the complete docs, please visit [qwikui.com](https://qwikui.com)
5230

5331
<br/>
5432

5533
## Installation of the headless components
5634

57-
> Please create issue if you encounter bugs.
58-
5935
```console
6036

6137
npm install -D @qwik-ui/headless
6238
```
6339

6440
<br/>
6541

42+
## Components Status
43+
44+
### Headless Kit
45+
46+
| Component | Planned | Draft (Alpha) | Beta | Stable |
47+
| :------------------------------------------------------------ | :-----: | :-----------: | ---- | ------ |
48+
| [Accordion](https://qwikui.com/docs/headless/accordion) | | || |
49+
| [Autocomplete](https://qwikui.com/docs/headless/autocomplete) | || | |
50+
| Carousel || | | |
51+
| Dialog || | | |
52+
| Pagination || | | |
53+
| [Popover](https://qwikui.com/docs/headless/popover) | || | |
54+
| [Select](https://qwikui.com/docs/headless/select) | || | |
55+
| [Tabs](https://qwikui.com/docs/headless/tabs) | | || |
56+
| [Toggle](https://qwikui.com/docs/headless/toggle) || | | |
57+
| [Tooltip](https://qwikui.com/docs/headless/tooltip) | || | |
58+
6659
## Contributing
6760

6861
Want to contribute? Yayy! 🎉
@@ -124,6 +117,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
124117
<td align="center" valign="top" width="14.28%"><a href="https://github.com/thejackshelton"><img src="https://avatars.githubusercontent.com/u/104264123?v=4?s=100" width="100px;" alt="Jack Shelton"/><br /><sub><b>Jack Shelton</b></sub></a><br /><a href="https://github.com/qwikifiers/qwik-ui/commits?author=thejackshelton" title="Code">💻</a> <a href="https://github.com/qwikifiers/qwik-ui/commits?author=thejackshelton" title="Documentation">📖</a></td>
125118
<td align="center" valign="top" width="14.28%"><a href="https://github.com/vasucp1207"><img src="https://avatars.githubusercontent.com/u/85363195?v=4?s=100" width="100px;" alt="Vasu Singh"/><br /><sub><b>Vasu Singh</b></sub></a><br /><a href="https://github.com/qwikifiers/qwik-ui/commits?author=vasucp1207" title="Code">💻</a></td>
126119
</tr>
120+
<tr>
121+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/wmertens"><img src="https://avatars.githubusercontent.com/u/54934?v=4?s=100" width="100px;" alt="Wout Mertens"/><br /><sub><b>Wout Mertens</b></sub></a><br /><a href="https://github.com/qwikifiers/qwik-ui/commits?author=wmertens" title="Code">💻</a> <a href="#research-wmertens" title="Research">🔬</a> <a href="#ideas-wmertens" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/qwikifiers/qwik-ui/commits?author=wmertens" title="Tests">⚠️</a> <a href="https://github.com/qwikifiers/qwik-ui/commits?author=wmertens" title="Documentation">📖</a></td>
122+
</tr>
127123
</tbody>
128124
</table>
129125

apps/website/.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ build
2929
dist
3030
tsconfig.tsbuildinfo
3131
vite.config.ts
32+
**/*.mdx

apps/website/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"description": "The Qwik UI Website",
44
"private": true,
55
"dependencies": {
6-
"@qwik-ui/headless": "file:../../dist/packages/kit-headless",
7-
"@qwik-ui/tailwind": "file:../../dist/packages/kit-tailwind",
8-
"@qwik-ui/material": "file:../../dist/packages/kit-material",
9-
"@qwik-ui/primitives": "file:../../dist/packages/primitives"
6+
"@qwik-ui/headless": "workspace:*",
7+
"@qwik-ui/tailwind": "workspace:*",
8+
"@qwik-ui/material": "workspace:*",
9+
"@qwik-ui/primitives": "workspace:*"
1010
}
1111
}
Lines changed: 10 additions & 0 deletions
Loading
-25.2 KB
Binary file not shown.
-66.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)