koval-ui 0.12.19
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 +53 -0
- package/dist/index.d.ts +1646 -0
- package/dist/index.js +3922 -0
- package/dist/index.js.map +1 -0
- package/dist/index.umd.cjs +3 -0
- package/dist/index.umd.cjs.map +1 -0
- package/dist/style.css +1 -0
- package/dist/vite.svg +1 -0
- package/package.json +154 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Dima Vyshniakov
|
|
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,53 @@
|
|
|
1
|
+
[](https://github.com/morewings/koval-ui/actions/workflows/pages.yml)
|
|
2
|
+
[](https://github.com/morewings/koval-ui/actions/workflows/merge-jobs.yml)
|
|
3
|
+
[](https://github.com/morewings/koval-ui)
|
|
4
|
+
[](https://www.npmjs.com/package/koval-ui)
|
|
5
|
+
[![npm bundle size](https://deno.bundlejs.com/badge?q=koval-ui@latest&config={"esbuild":{"external":["react","react-dom"]}})](https://bundlejs.com/?bundle&q=koval-ui@latest&config={"analysis":"treemap","esbuild":{"external":["react","react-dom"]}})
|
|
6
|
+
[](https://codeclimate.com/github/morewings/koval-ui/maintainability)
|
|
7
|
+
[](https://codeclimate.com/github/morewings/koval-ui/test_coverage)
|
|
8
|
+
|
|
9
|
+
# Koval components library
|
|
10
|
+
|
|
11
|
+
[](#)
|
|
12
|
+
|
|
13
|
+
Koval UI is component library built for modern browsers. Each component tries to utilize built in browser APIs to full extent.
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- Supports **Typescript**, bundled types.
|
|
18
|
+
- **ESM** and **commonjs** bundles.
|
|
19
|
+
- Compatible with **Nextjs**.
|
|
20
|
+
- CSS Flex column-based layout.
|
|
21
|
+
- Inputs compatible with **react-hook-form** and similar libraries.
|
|
22
|
+
- Built-in form validation.
|
|
23
|
+
- Typography components.
|
|
24
|
+
|
|
25
|
+
See [Koval Storybook](https://morewings.github.io/koval-ui/).
|
|
26
|
+
|
|
27
|
+
## Quickstart
|
|
28
|
+
|
|
29
|
+
Install library with the package manager of your choice
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm i koval-ui
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Include Koval css styles and wrap your application with Provider.
|
|
36
|
+
|
|
37
|
+
```jsx
|
|
38
|
+
import {Provider} from 'koval-ui';
|
|
39
|
+
import 'koval-ui/dist/style.css'
|
|
40
|
+
|
|
41
|
+
const App = ({children}) => {
|
|
42
|
+
//...
|
|
43
|
+
return <Provider>{children}</Provider>
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Acknowledgments
|
|
48
|
+
|
|
49
|
+
<img width="222" src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo.">
|
|
50
|
+
|
|
51
|
+
This project is developed using amazing **Webstorm IDE** provided by [Jetbrains](https://www.jetbrains.com).
|
|
52
|
+
|
|
53
|
+
|