ranui 0.1.1-alpha.5 → 0.1.1-alpha.6
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/package.json +8 -2
- package/readme.md +63 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ranui",
|
|
3
|
-
"version": "0.1.1-alpha.
|
|
3
|
+
"version": "0.1.1-alpha.6",
|
|
4
4
|
"description": "基于web components的组件库",
|
|
5
5
|
"main": "dist/index.umd.cjs",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -25,7 +25,13 @@
|
|
|
25
25
|
"url": "git+https://github.com/chaxus/ran",
|
|
26
26
|
"directory": "packages/ranui"
|
|
27
27
|
},
|
|
28
|
-
"keywords": [
|
|
28
|
+
"keywords": [
|
|
29
|
+
"ran",
|
|
30
|
+
"component",
|
|
31
|
+
"components",
|
|
32
|
+
"ui",
|
|
33
|
+
""
|
|
34
|
+
],
|
|
29
35
|
"author": "",
|
|
30
36
|
"license": "ISC",
|
|
31
37
|
"devDependencies": {
|
package/readme.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# ranui
|
|
2
|
+
|
|
3
|
+
UI Component library based on `Web Component`
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<a href="https://github.com/chaxus/ran/actions"><img src="https://img.shields.io/github/actions/workflow/status/chaxus/ran/ci.yml" alt="Build Status"></a>
|
|
8
|
+
<a href="https://npmjs.com/package/ranui"><img src="https://img.shields.io/npm/v/ranui.svg" alt="npm-v"></a>
|
|
9
|
+
<a href="https://npmjs.com/package/ranui"><img src="https://img.shields.io/npm/dt/ranui.svg" alt="npm-d"></a>
|
|
10
|
+
<a href="https://bundlephobia.com/result?p=ranui"><img src="https://img.badgesize.io/https:/unpkg.com/ranui/dist/index.umd.cjs?label=brotli&compression=brotli" alt="brotli"></a>
|
|
11
|
+
<a href="#alternative-installation-methods"><img src="https://img.shields.io/badge/module%20formats-umd%2C%20esm-green.svg" alt="module formats: umd, esm"></a>
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
Using npm:
|
|
16
|
+
|
|
17
|
+
```console
|
|
18
|
+
npm install ranui --save
|
|
19
|
+
```
|
|
20
|
+
## Document
|
|
21
|
+
|
|
22
|
+
[See components and use examples](https://chaxus.github.io/ran/src/ranui/)
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
It is based on the `Web Component`, you can use it without focusing on the framework.
|
|
27
|
+
|
|
28
|
+
- tsx
|
|
29
|
+
```tsx
|
|
30
|
+
import Button from 'ranui'
|
|
31
|
+
|
|
32
|
+
const App = () => {
|
|
33
|
+
return (
|
|
34
|
+
<>
|
|
35
|
+
<r-button>Button</r-button>
|
|
36
|
+
</>
|
|
37
|
+
)
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
- html
|
|
42
|
+
```html
|
|
43
|
+
<script src="./ranui/dist/index.umd.cjs"></script>
|
|
44
|
+
|
|
45
|
+
<body>
|
|
46
|
+
<r-button>Button</r-button>
|
|
47
|
+
</body>
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
- js
|
|
51
|
+
|
|
52
|
+
```js
|
|
53
|
+
import 'ranui'
|
|
54
|
+
|
|
55
|
+
const Button = document.createElement('r-button')
|
|
56
|
+
Button.appendChild('this is button text')
|
|
57
|
+
document.body.appendChild(Button)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Meta
|
|
62
|
+
|
|
63
|
+
[LICENSE (MIT)](/LICENSE)
|