@aurea-uds/icons 0.62.0 → 0.62.1
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 +18 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,48 +1,46 @@
|
|
|
1
1
|
# @aurea-uds/icons
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
The icon sprite **Aurea UDS** draws from. The glyphs are [Phosphor Icons](https://phosphoricons.com), in the
|
|
4
|
+
**Regular** and **Fill** weights; this package only puts them together in a single SVG sprite. Up to
|
|
5
|
+
`0.12.4` they were IBM's Carbon Icons.
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
pnpm add @aurea-uds/icons
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
ele está:
|
|
11
|
+
Copy `dist/aurea-icons.svg` to where your app serves static files and tell the provider where it is:
|
|
13
12
|
|
|
14
13
|
```jsx
|
|
15
14
|
<AureaProvider spriteUrl="/aurea-icons.svg">
|
|
16
15
|
```
|
|
17
16
|
|
|
18
|
-
|
|
17
|
+
Markup outside React points straight to the symbol:
|
|
19
18
|
|
|
20
19
|
```html
|
|
21
20
|
<svg class="icon" aria-hidden="true"><use href="/aurea-icons.svg#i-magnifying-glass"></use></svg>
|
|
22
21
|
```
|
|
23
22
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
23
|
+
The symbol id is `i-` followed by the Phosphor name exactly as Phosphor writes it: `caret-down` becomes
|
|
24
|
+
`#i-caret-down`. The filled shape has the `-fill` suffix: `#i-caret-down-fill`. In React, it is
|
|
25
|
+
`<Icon name="caret-down" weight="fill" />`; Aurea uses the filled shape on the selected item (the active
|
|
26
|
+
tab, the current menu item) and in alerts.
|
|
28
27
|
|
|
29
|
-
|
|
30
|
-
|
|
28
|
+
Phosphor's brand logos (`apple-logo` and the other 78 with `-logo` in the name) **are not included**: a
|
|
29
|
+
third party's trademark does not belong in an Apache-2.0 library.
|
|
31
30
|
|
|
32
|
-
##
|
|
31
|
+
## Coming from Carbon
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
|
|
33
|
+
Every name changed. The `carbon-para-phosphor.json` table maps the 260 Carbon names that Aurea and the
|
|
34
|
+
known apps used to the Phosphor name that replaces each one:
|
|
36
35
|
|
|
37
36
|
```js
|
|
38
37
|
import tabela from "@aurea-uds/icons/carbon-para-phosphor.json" with {type: "json"};
|
|
39
38
|
tabela["chevron--down"]; // "caret-down"
|
|
40
39
|
```
|
|
41
40
|
|
|
42
|
-
|
|
41
|
+
Carbon's `*--filled` icons become the same name with `weight="fill"`.
|
|
43
42
|
|
|
44
|
-
##
|
|
43
|
+
## License
|
|
45
44
|
|
|
46
|
-
Apache-2.0
|
|
47
|
-
|
|
48
|
-
publicados.
|
|
45
|
+
Apache-2.0 for this package. The glyphs are Phosphor Icons, under the MIT license — the copyright and
|
|
46
|
+
permission notice it requires is in [`NOTICE`](./NOTICE), which is part of the published files.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aurea-uds/icons",
|
|
3
|
-
"version": "0.62.
|
|
3
|
+
"version": "0.62.1",
|
|
4
4
|
"description": "O sprite de ícones do Phosphor (Regular e Fill) que a Aurea UDS desenha com <use href>, e a tabela de nomes do Carbon para o Phosphor. A atribuição está no NOTICE.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"aurea",
|