@nimbus-ds/icon 3.1.0-rc.2 → 3.1.0-rc.5

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.
Files changed (3) hide show
  1. package/dist/CHANGELOG.md +98 -0
  2. package/dist/README.md +41 -0
  3. package/package.json +4 -4
package/dist/CHANGELOG.md ADDED
@@ -0,0 +1,98 @@
1
+ # Changelog
2
+
3
+ Icons are used to visually communicate core parts of the product and available actions. They can act as wayfinding tools to help merchants more easily understand where they are in the product, and common interaction patterns that are available.
4
+
5
+ ## 2023-03-13 `3.0.0`
6
+
7
+ ### 🛠 Breaking changes
8
+
9
+ - Changed the `color` properties to `primary-interactive`, `primary-surface`, `primary-textLow`, `success-textLow`, `success-surface`, `warning-interactive`, `warning-surface`, `warning-textLow`, `danger-interactive`, `danger-surface`, `danger-textLow`, `neutral-background`, `neutral-interactive`, `neutral-surface`, `neutral-textLow`, `currentColor`, `success-interactive`, `primary-textHigh`, `success-textHigh`, `warning-textHigh`, `danger-textHigh`, `neutral-textDisabled` and `neutral-textHigh`. ([#110](https://github.com/TiendaNube/nimbus-design-system/pull/110) by [@juniorconquista](https://github.com/juniorconquista))
10
+
11
+ ### 💡 Others
12
+
13
+ - Refactored style classes to have more semantic names. ([#110](https://github.com/TiendaNube/nimbus-design-system/pull/110) by [@juniorconquista](https://github.com/juniorconquista))
14
+
15
+ ## 2023-02-24 `2.2.1`
16
+
17
+ ### 🎉 New features
18
+
19
+ - Changed `cursor` property default value to `inherit`. ([#106](https://github.com/TiendaNube/nimbus-design-system/pull/106) by [@juanchigallego](https://github.com/juanchigallego))
20
+
21
+ ## 2023-02-23 `2.2.0`
22
+
23
+ ### 🎉 New features
24
+
25
+ - Added server side-rendering support to component. ([#105](https://github.com/TiendaNube/nimbus-design-system/pull/105) by [@juniorconquista](https://github.com/juniorconquista))
26
+
27
+ ## 2023-02-16 `2.1.0`
28
+
29
+ ### 🎉 New features
30
+
31
+ - Removed external dependency from `@tiendanube/icons` package to now use internal `@nimbus-ds/icons` package. ([#94](https://github.com/TiendaNube/nimbus-design-system/pull/#94) by [@juniorconquista](https://github.com/juniorconquista))
32
+
33
+ ### 📚 3rd party library updates
34
+
35
+ - Removed `@tiendanube/icons@0.3.1`. ([#94](https://github.com/TiendaNube/nimbus-design-system/pull/#94) by [@juniorconquista](https://github.com/juniorconquista))
36
+
37
+ ## 2022-12-22 `2.0.0`
38
+
39
+ ### 💡 Others
40
+
41
+ - Removed direct dependency on `nimbus-ds/styles` package from component build. ([#69](https://github.com/TiendaNube/nimbus-design-system/pull/69) by [@juniorconquista](https://github.com/juniorconquista))
42
+
43
+ ## 2022-12-07 `1.6.0`
44
+
45
+ ### 🎉 New features
46
+
47
+ - Changed build build to consume inner package `@nimbus-ds/webpack`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
48
+
49
+ ### 📚 3rd party library updates
50
+
51
+ - Removed `terser-webpack-plugin@5.3.5`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
52
+ - Removed `ts-loader@9.3.1`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
53
+ - Removed `webpack-cli@4.10.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
54
+ - Removed `webpack@5.74.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
55
+ - Removed `typescript@4.7.4`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
56
+
57
+ ## 2022-11-18 `1.5.0`
58
+
59
+ ### 📚 3rd party library updates
60
+
61
+ - Updated `@tiendanube/icons@0.3.1`. ([#57](https://github.com/TiendaNube/nimbus-design-system/pull/#57) by [@juniorconquista](https://github.com/juniorconquista))
62
+
63
+ ## 2022-11-09 `1.4.0`
64
+
65
+ ### 🎉 New features
66
+
67
+ - Added `cursor` property to the Component. ([#53](https://github.com/TiendaNube/nimbus-design-system/pull/53) by [@juniorconquista](https://github.com/juniorconquista))
68
+
69
+ ## 2022-10-20 `1.3.0`
70
+
71
+ ### 🎉 New features
72
+
73
+ - Added `neutral.textDisabled` color to the component property . ([#42](https://github.com/TiendaNube/nimbus-design-system/pull/42) by [@juniorconquista](https://github.com/juniorconquista))
74
+
75
+ ## 2022-09-29 `1.2.1`
76
+
77
+ ### 🎉 New features
78
+
79
+ - Added displayName to component. ([#32](https://github.com/TiendaNube/nimbus-design-system/pull/32) by [@juniorconquista](https://github.com/juniorconquista))
80
+ - Added displayName to component `Icon.Skeleton`. ([#32](https://github.com/TiendaNube/nimbus-design-system/pull/32) by [@juniorconquista](https://github.com/juniorconquista))
81
+
82
+ ## 2022-09-01 `1.0.0`
83
+
84
+ ### 📚 3rd party library updates
85
+
86
+ - Added `terser-webpack-plugin@5.3.5`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
87
+ - Added `ts-loader@9.3.1`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
88
+ - Added `typescript@4.7.4`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
89
+ - Added `webpack@5.74.0`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
90
+ - Added `webpack-cli@4.10.0`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
91
+
92
+ ### 🎉 New features
93
+
94
+ - Added `source` and `color` properties to the Component. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
95
+ - Added stories on Component. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
96
+ - Created new `Icon.Skeleton` subcomponent. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
97
+ - Added `width` and `height` properties to the Component `Icon.Skeleton`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
98
+ - Added stories on Component `Icon.Skeleton`. ([#21](https://github.com/TiendaNube/nimbus-design-system/pull/21) by [@juniorconquista](https://github.com/juniorconquista))
package/dist/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # `@nimbus-ds/icon`
2
+
3
+ [![@nimbus-ds/icon](https://img.shields.io/npm/v/@nimbus-ds/icon?label=%40nimbus-ds%2Ficon)](https://www.npmjs.com/package/@nimbus-ds/icon)
4
+
5
+ The Icon component is used when we need to illustrate an action, state or text inside or outside another component.
6
+
7
+ ## Installation
8
+
9
+ ```sh
10
+ $ yarn add @nimbus-ds/icon
11
+ # or
12
+ $ npm install @nimbus-ds/icon
13
+ ```
14
+
15
+ ### Component Anatomy
16
+
17
+ The component consists of a vector shape, which uses our Nimbus icons library.
18
+
19
+ ## Guidelines
20
+
21
+ We use this component to reinforce, through an icon, a message, state or action that requires greater emphasis in relation to a text, for example.
22
+
23
+ ### Sizes
24
+
25
+ Icon has 3 predefined sizes large, medium and small and must be used taking into account the component and context in which they will be applied.
26
+
27
+ ### AriaLabel
28
+
29
+ This component does not have text, but it has a tag (Aria Label) to facilitate its identification by people with some type of visual or cognitive limitation. That's why we need to add a description that makes the icon's function clear.
30
+
31
+ ### Recommendation for use
32
+
33
+ - Illustrate states of an order
34
+ - Illustrate actions inside a button
35
+ - Illustrate a section of the application
36
+
37
+ ## Usage
38
+
39
+ View docs [here](https://nimbus.nuvemshop.com.br/documentation/atomic-components/icon).
40
+
41
+ <img alt="Nimbus" style="margin-bottom: 30px;" src="https://tiendanube.github.io/design-system-nimbus/static/media/nimbus-logo.ab60bd79.png" height="30" />
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nimbus-ds/icon",
3
- "version": "3.1.0-rc.2",
3
+ "version": "3.1.0-rc.5",
4
4
  "license": "MIT",
5
5
  "main": "dist/index.js",
6
6
  "files": [
@@ -14,7 +14,7 @@
14
14
  "version": "yarn version"
15
15
  },
16
16
  "dependencies": {
17
- "@nimbus-ds/skeleton": "^3.1.0-rc.2"
17
+ "@nimbus-ds/skeleton": "^3.1.0-rc.5"
18
18
  },
19
19
  "peerDependencies": {
20
20
  "react": "^16.8 || ^17.0 || ^18.0",
@@ -29,8 +29,8 @@
29
29
  "url": "https://github.com/TiendaNube/nimbus-design-system/issues"
30
30
  },
31
31
  "devDependencies": {
32
- "@nimbus-ds/icons": "^1.6.0",
33
- "@nimbus-ds/webpack": "^1.4.0"
32
+ "@nimbus-ds/icons": "^1.7.0-rc.2",
33
+ "@nimbus-ds/webpack": "^1.5.0-rc.1"
34
34
  },
35
35
  "stableVersion": "3.0.0"
36
36
  }