@gbmtech/aurora-ui 0.1.7 → 0.1.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 +55 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# **@gbmtech/aurora-ui** - Biblioteca de componentes GBM Tech & Control
|
|
2
|
+
|
|
3
|
+
**@gbmtech/aurora-ui** é uma biblioteca interna de componentes da GBM Tech & Control, desenvolvida com TailwindCSS para acelerar o desenvolvimento de aplicações web modernas da empresa. Ela oferece um sistema de design unificado e uma arquitetura de componentes robusta, promovendo consistência visual, escalabilidade e fácil manutenção em todos os projetos internos.
|
|
4
|
+
|
|
5
|
+
## Instalação
|
|
6
|
+
|
|
7
|
+
Solicitar o token do NPM para baixar o pacote na aplicação
|
|
8
|
+
|
|
9
|
+
Incluir o token no arquivo .npmrc
|
|
10
|
+
|
|
11
|
+
Instalar **@gbmtech/aurora-ui** via **npm**:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npm install @gbmtech/aurora-ui
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Configuração
|
|
18
|
+
|
|
19
|
+
### Configuração do CSS Global
|
|
20
|
+
|
|
21
|
+
Para habilitar o **@gbmtech/aurora-ui**, importe os estilos necessários para seu arquivo CSS global (e.g., `/app/globals.css`):
|
|
22
|
+
|
|
23
|
+
```css
|
|
24
|
+
@import "tailwindcss";
|
|
25
|
+
|
|
26
|
+
@import "@gbmtech/aurora-ui/styles.css";
|
|
27
|
+
|
|
28
|
+
@source '../../node_modules/@gbmtech/aurora-ui';
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Next.js configuration
|
|
32
|
+
|
|
33
|
+
Para otimizar a importação de pacotes, você precisa atualizar o arquivo `next.config.ts` no seu projeto. Adicione a seguinte configuração:
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
experimental: {
|
|
37
|
+
optimizePackageImports: ['@gbmtech/aurora-ui'],
|
|
38
|
+
},
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Esta configuração melhora o desempenho otimizando o processo de importação de bibliotecas de `@gbmtech/aurora-ui`.
|
|
42
|
+
|
|
43
|
+
## Usage
|
|
44
|
+
|
|
45
|
+
**@gbmtech/aurora-ui** fornece uma variedade de componentes pré-criados que se integram perfeitamente ao seu aplicativo.
|
|
46
|
+
|
|
47
|
+
Exemplo de uso do componente **Button**:
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
import { Button } from '@gbmtech/aurora-ui';
|
|
51
|
+
|
|
52
|
+
export default function Home() {
|
|
53
|
+
return <Button variant="primary">Get Started</Button>;
|
|
54
|
+
}
|
|
55
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gbmtech/aurora-ui",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"main": "./dist/cjs/index.cjs",
|
|
5
5
|
"module": "./dist/esm/index.js",
|
|
6
6
|
"types": "./dist/types/index.d.ts",
|
|
@@ -41,8 +41,8 @@
|
|
|
41
41
|
"postcss": "^8.5.3",
|
|
42
42
|
"tailwindcss": "^4.1.4",
|
|
43
43
|
"typescript": "^5.8.3",
|
|
44
|
-
"@gbmtech/
|
|
45
|
-
"@gbmtech/
|
|
44
|
+
"@gbmtech/tsconfig": "1.0.0",
|
|
45
|
+
"@gbmtech/prettier": "0.0.0"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"@hookform/resolvers": "^3.10.0",
|