@aveonline/ui-react 2.4.7 → 2.4.8
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/README.md +93 -93
- package/dist/reset.css +273 -273
- package/dist/tailwind.config.js +246 -246
- package/dist/tailwind.css +1 -1
- package/dist/tokens.css +160 -160
- package/dist/ui/atoms/Button/IButton.d.ts +1 -1
- package/dist/ui/atoms/Tooltip/TooltipAnchor.d.ts +1 -1
- package/dist/ui/atoms/Tooltip/TooltipFloat.d.ts +1 -1
- package/dist/ui/atoms/Tooltip/useTooltip.d.ts +53 -0
- package/dist/ui/molecules/Cards/CardSelect/ICardSelect.d.ts +1 -0
- package/dist/ui/molecules/Dropdowns/DropdownFilter/Command.d.ts +1 -1
- package/dist/ui/molecules/TextArea/TextArea.d.ts +1 -1
- package/dist/ui-react.mjs +13530 -12621
- package/dist/vite-env.d.ts +2 -2
- package/package.json +1 -1
- package/dist/ui/molecules/Selectable/select.d.ts +0 -28
package/README.md
CHANGED
|
@@ -1,93 +1,93 @@
|
|
|
1
|
-
<div align="center">
|
|
2
|
-
<img height="70" src="https://user-images.githubusercontent.com/38017835/236567288-5cc2dd3b-95f7-413b-9fd1-208d4b4d5654.png">
|
|
3
|
-
<h1 align="center">ui ecosystem react</h1>
|
|
4
|
-
<p>The home base for Aveonline design system, ui-react provides essential design resources for our developers to use in the Aveonline-branded interfaces that they create.</p>
|
|
5
|
-
<a href="https://ui-aveonline.netlify.app/">Go Storybook</a>
|
|
6
|
-
</div>
|
|
7
|
-
|
|
8
|
-
<br>
|
|
9
|
-
|
|
10
|
-
<p align="center">
|
|
11
|
-
<a href="https://github.com/Development-Aveonline/ui-react/actions/workflows/ci.yml">
|
|
12
|
-
<img src="https://github.com/Development-Aveonline/ui-react/actions/workflows/ci.yml/badge.svg?event=pull_request" alt="UI CI">
|
|
13
|
-
</a>
|
|
14
|
-
</p>
|
|
15
|
-
|
|
16
|
-
<br />
|
|
17
|
-
|
|
18
|
-
## Before started
|
|
19
|
-
|
|
20
|
-
For usage with tailwind config, install:
|
|
21
|
-
|
|
22
|
-
```shell
|
|
23
|
-
npm i @tailwindcss/forms -D
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Getting started
|
|
27
|
-
|
|
28
|
-
Working with all config from this library or only components availables
|
|
29
|
-
|
|
30
|
-
```shell
|
|
31
|
-
npm i @aveonline/ui-react
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## Usage with tailwind
|
|
35
|
-
|
|
36
|
-
Import things into your JS app from the `@aveonline/ui-react` package.
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
import { Button } from '@aveonline/ui-react'
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
`tailwind.config.js`
|
|
43
|
-
|
|
44
|
-
```ts
|
|
45
|
-
/** @type {import('tailwindcss').Config} */
|
|
46
|
-
|
|
47
|
-
const tailwindConfig = require('@aveonline/ui-react/tailwind.config.js')
|
|
48
|
-
|
|
49
|
-
tailwindConfig.content = [
|
|
50
|
-
'./pages/**/*.{ts,tsx}',
|
|
51
|
-
'./components/**/*.{ts,tsx}',
|
|
52
|
-
'./node_modules/@aveonline/ui-react/dist/ui-react.mjs'
|
|
53
|
-
]
|
|
54
|
-
|
|
55
|
-
module.exports = tailwindConfig
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## Usage css
|
|
59
|
-
|
|
60
|
-
Import things into your JS app from the `@aveonline/ui-react` package.
|
|
61
|
-
|
|
62
|
-
```css
|
|
63
|
-
/* global.css or tailwind.css local */
|
|
64
|
-
@tailwind base;
|
|
65
|
-
@tailwind components;
|
|
66
|
-
@tailwind utilities;
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
```ts
|
|
70
|
-
// import this lines at main.ts or root
|
|
71
|
-
import './global.css' // Reference tailwind local
|
|
72
|
-
import '@aveonline/ui-react/reset.css' // Only not usage tailwind
|
|
73
|
-
import '@aveonline/ui-react/tokens.css' // Required
|
|
74
|
-
import '@aveonline/ui-react/tailwind.css' // Required
|
|
75
|
-
import '@aveonline/ui-react/index.css' // Required
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
## Example usage class with tailwind
|
|
79
|
-
|
|
80
|
-
```html
|
|
81
|
-
<!-- Class from library -->
|
|
82
|
-
<section class="bg-letter-default">
|
|
83
|
-
<p class="text-letter-subdued">Hello human</p>
|
|
84
|
-
</section>
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
## Resources
|
|
88
|
-
|
|
89
|
-
- [Docs](https://ui-aveonline.netlify.app/)
|
|
90
|
-
|
|
91
|
-
## Development 🚀
|
|
92
|
-
|
|
93
|
-
- See [Contributing.md](https://github.com/Development-Aveonline/ui-react/blob/develop/CONTRIBUTING.md) for more information on how to build `@aveonline/ui-react` from the source and contribute!
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img height="70" src="https://user-images.githubusercontent.com/38017835/236567288-5cc2dd3b-95f7-413b-9fd1-208d4b4d5654.png">
|
|
3
|
+
<h1 align="center">ui ecosystem react</h1>
|
|
4
|
+
<p>The home base for Aveonline design system, ui-react provides essential design resources for our developers to use in the Aveonline-branded interfaces that they create.</p>
|
|
5
|
+
<a href="https://ui-aveonline.netlify.app/">Go Storybook</a>
|
|
6
|
+
</div>
|
|
7
|
+
|
|
8
|
+
<br>
|
|
9
|
+
|
|
10
|
+
<p align="center">
|
|
11
|
+
<a href="https://github.com/Development-Aveonline/ui-react/actions/workflows/ci.yml">
|
|
12
|
+
<img src="https://github.com/Development-Aveonline/ui-react/actions/workflows/ci.yml/badge.svg?event=pull_request" alt="UI CI">
|
|
13
|
+
</a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
<br />
|
|
17
|
+
|
|
18
|
+
## Before started
|
|
19
|
+
|
|
20
|
+
For usage with tailwind config, install:
|
|
21
|
+
|
|
22
|
+
```shell
|
|
23
|
+
npm i @tailwindcss/forms -D
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Getting started
|
|
27
|
+
|
|
28
|
+
Working with all config from this library or only components availables
|
|
29
|
+
|
|
30
|
+
```shell
|
|
31
|
+
npm i @aveonline/ui-react
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Usage with tailwind
|
|
35
|
+
|
|
36
|
+
Import things into your JS app from the `@aveonline/ui-react` package.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
import { Button } from '@aveonline/ui-react'
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
`tailwind.config.js`
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
/** @type {import('tailwindcss').Config} */
|
|
46
|
+
|
|
47
|
+
const tailwindConfig = require('@aveonline/ui-react/tailwind.config.js')
|
|
48
|
+
|
|
49
|
+
tailwindConfig.content = [
|
|
50
|
+
'./pages/**/*.{ts,tsx}',
|
|
51
|
+
'./components/**/*.{ts,tsx}',
|
|
52
|
+
'./node_modules/@aveonline/ui-react/dist/ui-react.mjs'
|
|
53
|
+
]
|
|
54
|
+
|
|
55
|
+
module.exports = tailwindConfig
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Usage css
|
|
59
|
+
|
|
60
|
+
Import things into your JS app from the `@aveonline/ui-react` package.
|
|
61
|
+
|
|
62
|
+
```css
|
|
63
|
+
/* global.css or tailwind.css local */
|
|
64
|
+
@tailwind base;
|
|
65
|
+
@tailwind components;
|
|
66
|
+
@tailwind utilities;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
// import this lines at main.ts or root
|
|
71
|
+
import './global.css' // Reference tailwind local
|
|
72
|
+
import '@aveonline/ui-react/reset.css' // Only not usage tailwind
|
|
73
|
+
import '@aveonline/ui-react/tokens.css' // Required
|
|
74
|
+
import '@aveonline/ui-react/tailwind.css' // Required
|
|
75
|
+
import '@aveonline/ui-react/index.css' // Required
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Example usage class with tailwind
|
|
79
|
+
|
|
80
|
+
```html
|
|
81
|
+
<!-- Class from library -->
|
|
82
|
+
<section class="bg-letter-default">
|
|
83
|
+
<p class="text-letter-subdued">Hello human</p>
|
|
84
|
+
</section>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Resources
|
|
88
|
+
|
|
89
|
+
- [Docs](https://ui-aveonline.netlify.app/)
|
|
90
|
+
|
|
91
|
+
## Development 🚀
|
|
92
|
+
|
|
93
|
+
- See [Contributing.md](https://github.com/Development-Aveonline/ui-react/blob/develop/CONTRIBUTING.md) for more information on how to build `@aveonline/ui-react` from the source and contribute!
|