@medway-ui/icons 1.0.0 → 1.0.2
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 +75 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Medway Icons
|
|
2
|
+
|
|
3
|
+
Biblioteca de ícones React da Medway, pronta para uso em projetos modernos. Todos os ícones são componentes React otimizados, com suporte a tree-shaking e tipagem TypeScript.
|
|
4
|
+
|
|
5
|
+
## Instalação
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @medway-ui/icons
|
|
9
|
+
# ou
|
|
10
|
+
yarn add @medway-ui/icons
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Uso
|
|
14
|
+
|
|
15
|
+
Importe qualquer ícone diretamente pelo nome:
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import { ArrowLeft, ArrowRight } from "@medway-ui/icons";
|
|
19
|
+
|
|
20
|
+
function Example() {
|
|
21
|
+
return (
|
|
22
|
+
<div>
|
|
23
|
+
<ArrowLeft size={24} color="red" />
|
|
24
|
+
<ArrowRight size={32} color="#00f" />
|
|
25
|
+
</div>
|
|
26
|
+
);
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Propriedades dos ícones
|
|
31
|
+
|
|
32
|
+
Todos os ícones aceitam as props padrão de `<svg>` do React, além de:
|
|
33
|
+
|
|
34
|
+
- `size`: número ou string (tamanho em px ou qualquer unidade CSS)
|
|
35
|
+
- `color`: cor do stroke
|
|
36
|
+
- `strokeWidth`: espessura do traço
|
|
37
|
+
- `className`: classe CSS
|
|
38
|
+
|
|
39
|
+
## Gerando os ícones
|
|
40
|
+
|
|
41
|
+
Se você precisa atualizar ou adicionar novos ícones:
|
|
42
|
+
|
|
43
|
+
1. Adicione os arquivos SVG na pasta `./icons`.
|
|
44
|
+
|
|
45
|
+
2. Execute o script de geração:
|
|
46
|
+
```bash
|
|
47
|
+
yarn generate-icons
|
|
48
|
+
# ou
|
|
49
|
+
npm run generate-icons
|
|
50
|
+
```
|
|
51
|
+
3. O script irá converter os SVGs em componentes React e atualizar os exports em `src/components/icons/index.ts`.
|
|
52
|
+
|
|
53
|
+
4. Faça o build da lib:
|
|
54
|
+
```bash
|
|
55
|
+
yarn build
|
|
56
|
+
# ou
|
|
57
|
+
npm run build
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Publicando a lib
|
|
61
|
+
|
|
62
|
+
1. Certifique-se de estar logado no npm:
|
|
63
|
+
```bash
|
|
64
|
+
npm login
|
|
65
|
+
```
|
|
66
|
+
2. Publique:
|
|
67
|
+
```bash
|
|
68
|
+
yarn release
|
|
69
|
+
# ou
|
|
70
|
+
npm run release
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
**Medway Icons** © Medway. MIT License.
|
package/package.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@medway-ui/icons",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Pacote para geração e gerenciamento de ícones Medway.",
|
|
5
|
-
"main": "dist/index.cjs
|
|
6
|
-
"module": "dist/index.
|
|
5
|
+
"main": "dist/index.cjs",
|
|
6
|
+
"module": "dist/index.js",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
8
8
|
"exports": {
|
|
9
9
|
".": {
|
|
10
|
-
"import": "./dist/index.
|
|
11
|
-
"require": "./dist/index.cjs
|
|
10
|
+
"import": "./dist/index.js",
|
|
11
|
+
"require": "./dist/index.cjs"
|
|
12
12
|
}
|
|
13
13
|
},
|
|
14
14
|
"scripts": {
|