@nimbus-ds/collapsible 1.0.1 → 1.1.0-rc.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/dist/CHANGELOG.md +13 -0
- package/dist/README.md +36 -0
- package/package.json +4 -3
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
The Collapsible is a component that can hid and show another component when a event is triggered from a button or a link.
|
|
4
|
+
|
|
5
|
+
## 2024-02-28 `1.0.0`
|
|
6
|
+
|
|
7
|
+
### 🎉 New features
|
|
8
|
+
|
|
9
|
+
- Created new `Collapsible.Body` and `Collapsible.Item` subcomponents. ([#19](https://github.com/TiendaNube/nimbus-design-system/pull/222) by [@vrlopess](https://github.com/vrlopess))
|
|
10
|
+
|
|
11
|
+
- Added stories on Component `Collapsible`. ([#19](https://github.com/TiendaNube/nimbus-design-system/pull/222) by [@vrlopess](https://github.com/vrlopess))
|
|
12
|
+
|
|
13
|
+
- Created new `Collapsible` component. ([#19](https://github.com/TiendaNube/nimbus-design-system/pull/222) by [@vrlopess](https://github.com/vrlopess))
|
package/dist/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# `@nimbus-ds/collapsible`
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@nimbus-ds/collapsible)
|
|
4
|
+
|
|
5
|
+
The Collapsible is a component that can hid and show another component when a event is triggered from a button or a link.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
$ yarn add @nimbus-ds/collapsible
|
|
11
|
+
# or
|
|
12
|
+
$ npm install @nimbus-ds/collapsible
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Component Anatomy
|
|
16
|
+
|
|
17
|
+
The component consists of a Item, Body and a container that can encapsulate the logic of hide and show some stuff.
|
|
18
|
+
|
|
19
|
+
## Guidelines
|
|
20
|
+
|
|
21
|
+
We use Collapsible to hide some content and show it only when a open event is triggered
|
|
22
|
+
|
|
23
|
+
### Recommendations for use
|
|
24
|
+
|
|
25
|
+
- Hide and show a component
|
|
26
|
+
- Display a hint of a text and hide the bigger part of it until the user click on a button
|
|
27
|
+
|
|
28
|
+
### Related components
|
|
29
|
+
|
|
30
|
+
- Accordion - It is a component allows us to compress content into containers that can be opened or closed.
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
View docs [here](https://nimbus.nuvemshop.com.br/documentation/atomic-components/collapsible).
|
|
35
|
+
|
|
36
|
+
<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/collapsible",
|
|
3
|
-
"version": "1.0.1",
|
|
3
|
+
"version": "1.1.0-rc.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"files": [
|
|
@@ -26,7 +26,8 @@
|
|
|
26
26
|
"url": "https://github.com/TiendaNube/nimbus-design-system/issues"
|
|
27
27
|
},
|
|
28
28
|
"devDependencies": {
|
|
29
|
-
"@nimbus-ds/webpack": "^1.
|
|
29
|
+
"@nimbus-ds/webpack": "^1.5.0-rc.1",
|
|
30
30
|
"@vanilla-extract/dynamic": "^2.0.3"
|
|
31
|
-
}
|
|
31
|
+
},
|
|
32
|
+
"stableVersion": "1.0.1"
|
|
32
33
|
}
|