@nimbus-ds/skeleton 3.1.0-rc.4 → 3.1.0-rc.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.
@@ -0,0 +1,59 @@
1
+ # Changelog
2
+
3
+ The skeleton is a basic component that displays a placeholder preview of its content before the data is loaded, reducing the feeling of slow loading time.
4
+
5
+ ## 2023-03-13 `2.2.0`
6
+
7
+ ### 💡 Others
8
+
9
+ - Refactored style classes to have more semantic names. ([#110](https://github.com/TiendaNube/nimbus-design-system/pull/110) by [@juniorconquista](https://github.com/juniorconquista))
10
+
11
+ ## 2023-02-23 `2.1.0`
12
+
13
+ ### 🎉 New features
14
+
15
+ - Added server side-rendering support to component. ([#105](https://github.com/TiendaNube/nimbus-design-system/pull/105) by [@juniorconquista](https://github.com/juniorconquista))
16
+
17
+ ## 2022-12-22 `2.0.0`
18
+
19
+ ### 💡 Others
20
+
21
+ - 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))
22
+
23
+ ## 2022-12-07 `1.2.0`
24
+
25
+ ### 🎉 New features
26
+
27
+ - 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))
28
+
29
+ ### 📚 3rd party library updates
30
+
31
+ - Removed `@vanilla-extract/webpack-plugin@2.1.11`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
32
+ - Removed `terser-webpack-plugin@5.3.5`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
33
+ - Removed `ts-loader@9.3.1`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
34
+ - Removed `webpack-cli@4.10.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
35
+ - Removed `webpack@5.74.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
36
+ - Removed `typescript@4.7.4`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
37
+
38
+ ## 2022-09-29 `1.1.0`
39
+
40
+ ### 🎉 New features
41
+
42
+ - Added displayName to component. ([#32](https://github.com/TiendaNube/nimbus-design-system/pull/32) by [@juniorconquista](https://github.com/juniorconquista))
43
+
44
+ ## 2022-08-22 `1.0.0`
45
+
46
+ ### 📚 3rd party library updates
47
+
48
+ - Added `@vanilla-extract/dynamic@2.0.2`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
49
+ - Added `@vanilla-extract/webpack-plugin@2.1.11`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
50
+ - Added `terser-webpack-plugin@5.3.5`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
51
+ - Added `ts-loader@9.3.1`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
52
+ - Added `typescript@4.7.4`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
53
+ - Added `webpack@5.74.0`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
54
+ - Added `webpack-cli@4.10.0`. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
55
+
56
+ ### 🎉 New features
57
+
58
+ - Added `width`, `height` and `borderRadius` properties to the Component. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
59
+ - Added stories on Component. ([#15](https://github.com/TiendaNube/nimbus-design-system/pull/15) by [@juniorconquista](https://github.com/juniorconquista))
package/dist/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # `@nimbus-ds/skeleton`
2
+
3
+ [![@nimbus-ds/skeleton](https://img.shields.io/npm/v/@nimbus-ds/skeleton?label=%40nimbus-ds%2Fskeleton)](https://www.npmjs.com/package/@nimbus-ds/skeleton)
4
+
5
+ The Skeleton component allows us to visually communicate the loading of other components.
6
+
7
+ ## Installation
8
+
9
+ ```sh
10
+ $ yarn add @nimbus-ds/skeleton
11
+ # or
12
+ $ npm install @nimbus-ds/skeleton
13
+ ```
14
+
15
+ ### Component Anatomy
16
+
17
+ The component is composed of a rectangle with an animation that alternates its colors.
18
+
19
+ ## Guidelines
20
+
21
+ We use this component individually to represent the loading of other atomic and compound components.
22
+
23
+ ### Personalization
24
+
25
+ It is possible to customize Skeleton to meet the needs of local components, adjusting width, height and border radius properties.
26
+
27
+ ### Recommendation for use
28
+
29
+ - Communicate loading composite components
30
+ - Report loading of atomic components
31
+ - Communicate local component loading
32
+
33
+ ### Related components
34
+
35
+ - Spinner - Can be used to inform the processing of actions in real time.
36
+
37
+ ## Usage
38
+
39
+ View docs [here](https://nimbus.nuvemshop.com.br/documentation/atomic-components/skeleton).
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/skeleton",
3
- "version": "3.1.0-rc.4",
3
+ "version": "3.1.0-rc.6",
4
4
  "license": "MIT",
5
5
  "main": "dist/index.js",
6
6
  "files": [
@@ -26,7 +26,7 @@
26
26
  "url": "https://github.com/TiendaNube/nimbus-design-system/issues"
27
27
  },
28
28
  "devDependencies": {
29
- "@nimbus-ds/webpack": "^1.4.1-rc.1",
29
+ "@nimbus-ds/webpack": "^1.5.0-rc.2",
30
30
  "@vanilla-extract/dynamic": "^2.0.3"
31
31
  },
32
32
  "stableVersion": "3.0.0"