reka-ui 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +89 -0
- package/dist/index.umd.cjs +20 -0
- package/package.json +32 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Radix Vue <https://github.com/radix-vue>
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
<br />
|
|
2
|
+
<p align="center">
|
|
3
|
+
<a href="https://github.com/radix-vue/radix-vue">
|
|
4
|
+
<img src="https://www.radix-vue.com/logo.svg" alt="Logo" width="150" />
|
|
5
|
+
</a>
|
|
6
|
+
|
|
7
|
+
<h1 align="center">
|
|
8
|
+
Radix Vue
|
|
9
|
+
</h1>
|
|
10
|
+
<p align="center">
|
|
11
|
+
An unofficial Vue port of Radix UI. <br>
|
|
12
|
+
Radix is an unstyled, customisable UI Library with built in accessibility for building top quality design systems.
|
|
13
|
+
|
|
14
|
+
<p>
|
|
15
|
+
|
|
16
|
+
<p align="center">
|
|
17
|
+
<a href='https://github.com/radix-vue/radix-vue/actions/workflows/test.yml'>
|
|
18
|
+
</a>
|
|
19
|
+
<a href="https://www.npmjs.com/package/radix-vue" target="__blank"><img src="https://img.shields.io/npm/v/radix-vue?style=flat&colorA=002438&colorB=41c399" alt="NPM version"></a>
|
|
20
|
+
<a href="https://www.npmjs.com/package/radix-vue" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/radix-vue?flat&colorA=002438&colorB=41c399"></a>
|
|
21
|
+
<a href="https://github.com/radix-vue/radix-vue" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/radix-vue/radix-vue?flat&colorA=002438&colorB=41c399"></a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
<p align="center">
|
|
25
|
+
<a href="https://chat.radix-vue.com"><b>Get involved!</b></a>
|
|
26
|
+
</p>
|
|
27
|
+
<p align="center">
|
|
28
|
+
<a href="https://radix-vue.com">Documentation</a> | <a href="https://www.radix-vue.com/overview/getting-started.html">Getting Started</a> | <a href="https://www.radix-vue.com/">Examples</a> | <a href="https://www.radix-vue.com/overview/introduction.html">Why Radix Vue?</a>
|
|
29
|
+
</p>
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<em>design by: [icarusgkx](https://twitter.com/icarusgkx), [melkam](https://github.com/MellKam)</em>
|
|
33
|
+
|
|
34
|
+
## Installation
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
pnpm add radix-vue
|
|
38
|
+
```
|
|
39
|
+
```bash
|
|
40
|
+
npm install radix-vue
|
|
41
|
+
```
|
|
42
|
+
```bash
|
|
43
|
+
yarn add radix-vue
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Documentation
|
|
47
|
+
|
|
48
|
+
For full documentation, visit [radix-vue.com](https://radix-vue.com).
|
|
49
|
+
|
|
50
|
+
## Releases
|
|
51
|
+
|
|
52
|
+
For changelog, visit [releases](https://github.com/radix-vue/radix-vue/releases).
|
|
53
|
+
|
|
54
|
+
## Contributing
|
|
55
|
+
|
|
56
|
+
We would love to have your contributions! All PRs all welcomed! We need help building the core components, docs, tests, stories! Join our discord and we will get you up and running!
|
|
57
|
+
|
|
58
|
+
## Dev Setup
|
|
59
|
+
|
|
60
|
+
### Docs
|
|
61
|
+
|
|
62
|
+
1. Clone the repo
|
|
63
|
+
2. Run `pnpm i`
|
|
64
|
+
3. Run `pnpm docs:dev` to run vitepress
|
|
65
|
+
4. Open `http://localhost:5173`
|
|
66
|
+
|
|
67
|
+
### Package
|
|
68
|
+
|
|
69
|
+
1. Clone the repo
|
|
70
|
+
2. Run `pnpm i`
|
|
71
|
+
3. Run `pnpm story:dev` to run histoire (storybook)
|
|
72
|
+
4. Open `http://localhost:6006`
|
|
73
|
+
|
|
74
|
+
## Authors
|
|
75
|
+
|
|
76
|
+
- [Khairul Haaziq](https://github.com/khairulhaaziq)
|
|
77
|
+
- [Mujahid Anuar](https://github.com/mujahidfa)
|
|
78
|
+
- [Zernonia](https://github.com/zernonia)
|
|
79
|
+
|
|
80
|
+
## Credits
|
|
81
|
+
|
|
82
|
+
All credits go to these open-source works and resources
|
|
83
|
+
|
|
84
|
+
- [Radix UI](https://radix-ui.com) for doing all the hard work to make sure components are accessible
|
|
85
|
+
- [Floating UI](https://floating-ui.com) for creating powerful components that as the base of many Radix Vue components
|
|
86
|
+
- [VueUse](https://vueuse.org) for providing many useful utilities.
|
|
87
|
+
- [Ark UI](https://ark-ui.com) for the `<Primitive>` component
|
|
88
|
+
- [Radix Svelte](https://radix-svelte.com)
|
|
89
|
+
- [Headless UI](https://headlessui.com)
|