bevi-icon 1.0.4 → 1.0.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/README.md
CHANGED
|
@@ -1 +1,108 @@
|
|
|
1
|
-
|
|
1
|
+
<img src='./public/doc/cover.png' title='BeviIcon' alt='Cover BeviIcon' />
|
|
2
|
+
<div align="center">
|
|
3
|
+
<h3>Biblioteca de ícones da Bevi</h3>
|
|
4
|
+
<span>
|
|
5
|
+
<a href="https://www.npmjs.com/package/bevi-icon"><strong>Npm Package</strong></a>
|
|
6
|
+
</span>
|
|
7
|
+
</div>
|
|
8
|
+
|
|
9
|
+
<br />
|
|
10
|
+
<br />
|
|
11
|
+
<br />
|
|
12
|
+
<br />
|
|
13
|
+
|
|
14
|
+
## Como começar
|
|
15
|
+
|
|
16
|
+
<br />
|
|
17
|
+
|
|
18
|
+
### NPM Package
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm i bevi-icon
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
<br/>
|
|
25
|
+
<br/>
|
|
26
|
+
|
|
27
|
+
## Como utilizar
|
|
28
|
+
|
|
29
|
+
Para utilizar essa biblioteca, basta instalar o pacote e
|
|
30
|
+
realizar a importação onde deseja utiliza.
|
|
31
|
+
|
|
32
|
+
```javascript
|
|
33
|
+
import { BvIcon } from 'bevi-icon'
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
<br />
|
|
37
|
+
|
|
38
|
+
Em seguida, pode utilizar o componente especificando suas
|
|
39
|
+
propriedades
|
|
40
|
+
|
|
41
|
+
```html
|
|
42
|
+
<BvIcon name="cube" variant="duo" />
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
<br />
|
|
46
|
+
<br />
|
|
47
|
+
|
|
48
|
+
## Propriedades
|
|
49
|
+
|
|
50
|
+
Essa biblioteca possui as seguintes propriedades
|
|
51
|
+
|
|
52
|
+
### Name
|
|
53
|
+
|
|
54
|
+
Nome do ícone que será exibido no seu projeto. Para mais
|
|
55
|
+
informações sobre os nomes dos ícones disponíveis na
|
|
56
|
+
biblioteca acesse
|
|
57
|
+
[Bevi Icon Doc Beta](https://beviicon-doc.netlify.app/icons).
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
name="cube"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
<br />
|
|
64
|
+
|
|
65
|
+
### Variant
|
|
66
|
+
|
|
67
|
+
Esse atributo é responsável por definir qual variante do
|
|
68
|
+
ícone será renderizado: `solid`, `duo`, `light` ou `dark`
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
name="dark"
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
<br />
|
|
75
|
+
|
|
76
|
+
### Size
|
|
77
|
+
|
|
78
|
+
Esse atributo é para o tamanho que deseja renderizar o
|
|
79
|
+
ícone, o valor é do tipo `Number` e com base na unidade de
|
|
80
|
+
medida
|
|
81
|
+
[rem](https://developer.mozilla.org/en-US/docs/Learn/CSS/Building_blocks/Values_and_units#relative_length_units).
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
size="4"
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
<br />
|
|
88
|
+
|
|
89
|
+
### Title
|
|
90
|
+
|
|
91
|
+
Você também pode adicionar um título ao ícone. Esse é usado
|
|
92
|
+
para acessibilidade e ajuda de leitores de tela.
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
title="Título de exemplo"
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
<br />
|
|
99
|
+
<br />
|
|
100
|
+
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
Bevi Icon is licensed under the
|
|
104
|
+
[MIT License](https://github.com/BeviProjects/bevi-icon/blob/main/LICENSE).
|
|
105
|
+
|
|
106
|
+
<br/>
|
|
107
|
+
<br/>
|
|
108
|
+
<br/>
|
|
@@ -9,12 +9,7 @@ const e = {
|
|
|
9
9
|
dark: "222343",
|
|
10
10
|
light: "25CBDB",
|
|
11
11
|
duo: "inherit"
|
|
12
|
-
}, g = ({
|
|
13
|
-
variant: r = "solid",
|
|
14
|
-
name: t,
|
|
15
|
-
title: i,
|
|
16
|
-
size: o
|
|
17
|
-
}, d) => /* @__PURE__ */ h(
|
|
12
|
+
}, g = ({ variant: r = "solid", name: t, title: i, size: o }, d) => /* @__PURE__ */ h(
|
|
18
13
|
"svg",
|
|
19
14
|
{
|
|
20
15
|
width: o ? o * 16 : 32,
|
|
@@ -28,13 +23,7 @@ const e = {
|
|
|
28
23
|
...d,
|
|
29
24
|
children: [
|
|
30
25
|
i ? /* @__PURE__ */ n("title", { children: i }) : "",
|
|
31
|
-
/* @__PURE__ */ n(
|
|
32
|
-
l,
|
|
33
|
-
{
|
|
34
|
-
variant: r,
|
|
35
|
-
name: t
|
|
36
|
-
}
|
|
37
|
-
)
|
|
26
|
+
/* @__PURE__ */ n(l, { variant: r, name: t })
|
|
38
27
|
]
|
|
39
28
|
}
|
|
40
29
|
);
|
package/package.json
CHANGED
|
@@ -1,33 +1,44 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
2
|
+
"name": "bevi-icon",
|
|
3
|
+
"version": "1.0.6",
|
|
4
|
+
"description": "Biblioteca de ícones da Bevi",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
11
|
+
"homepage": "https://github.com/BeviProjects/bevi-icon#readme",
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/BeviProjects/bevi-icon/issues",
|
|
14
|
+
"email": "andreluizmagjr@outlook.com"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"Bevi",
|
|
18
|
+
"Bevi Icon",
|
|
19
|
+
"Icon Library"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"dev": "vite",
|
|
23
|
+
"build": "tsc --p ./tsconfig-build.json && vite build",
|
|
24
|
+
"preview": "vite preview",
|
|
25
|
+
"prepublishOnly": "npm run build"
|
|
26
|
+
},
|
|
27
|
+
"peerDependencies": {
|
|
28
|
+
"react": "^18.2.0",
|
|
29
|
+
"react-dom": "^18.2.0"
|
|
30
|
+
},
|
|
31
|
+
"devDependencies": {
|
|
32
|
+
"@types/node": "^20.7.1",
|
|
33
|
+
"@types/react": "^18.0.27",
|
|
34
|
+
"@types/react-dom": "^18.0.10",
|
|
35
|
+
"@vitejs/plugin-react": "^3.1.0",
|
|
36
|
+
"glob": "^10.3.10",
|
|
37
|
+
"react": "^18.2.0",
|
|
38
|
+
"react-dom": "^18.2.0",
|
|
39
|
+
"typescript": "^4.9.3",
|
|
40
|
+
"vite": "^4.1.0",
|
|
41
|
+
"vite-plugin-dts": "^3.6.0"
|
|
42
|
+
},
|
|
43
|
+
"license": "MIT"
|
|
33
44
|
}
|
|
File without changes
|
|
File without changes
|