@nxa-lab/nxa-ui 0.3.6 → 0.3.7
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 +74 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
|
|
2
|
+
# Links
|
|
3
|
+
[Doc](https://nxa-ui-docs-b56be5.gitlab.io/Home)
|
|
4
|
+
[Code](https://gitlab.com/nxa-lab-public/nxa-ui)
|
|
5
|
+
|
|
6
|
+
# nxa-ui
|
|
7
|
+
|
|
8
|
+
**nxa-ui** is a simple, fully customizable Angular component library built on **Tailwind CSS** and **DaisyUI**. It is designed to be easy to use, easy to modify, and fully themeable to fit your project needs.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
* Lightweight Angular components
|
|
15
|
+
* Built with Tailwind CSS and DaisyUI
|
|
16
|
+
* Fully themeable with custom colors and styles
|
|
17
|
+
* Easy to use and modify
|
|
18
|
+
* Minimal setup required
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Releases
|
|
23
|
+
|
|
24
|
+
**still in alpha**
|
|
25
|
+
|
|
26
|
+
[Releases Page](https://gitlab.com/nxa-lab-public/nxa-ui/-/packages/47616172)
|
|
27
|
+
|
|
28
|
+
## Installation
|
|
29
|
+
|
|
30
|
+
Install via npm:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
echo @nxa-lab:registry=https://gitlab.com/api/v4/packages/npm/ >> .npmrc
|
|
34
|
+
npm install @nxa-lab/nxa-ui
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Import the components you need directly into your Angular components:
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
import { NxaInput } from '@nxa-lab/nxa-ui';
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Example
|
|
46
|
+
|
|
47
|
+
Use `nxa-input` in your template:
|
|
48
|
+
|
|
49
|
+
```html
|
|
50
|
+
<nxa-input placeholder="Enter your name" [(ngModel)]="name"></nxa-input>
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
This input is fully themeable and can be customized using Tailwind CSS classes or your own styles.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Theming
|
|
58
|
+
|
|
59
|
+
You can override Tailwind CSS variables or DaisyUI themes to customize your components:
|
|
60
|
+
|
|
61
|
+
```scss
|
|
62
|
+
:root {
|
|
63
|
+
--p: #4f46e5;
|
|
64
|
+
--s: #22d3ee;
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
All components will adapt to your custom theme automatically.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
MIT © [Nxa Lab]
|