Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vrlopess committed Feb 28, 2024
1 parent 20dbe00 commit 3133619
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions packages/react/src/composite/Collapsible/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# `@nimbus-ds/collapsible`

[![@nimbus-ds/collapsible](https://img.shields.io/npm/v/@nimbus-ds/collapsible?label=%40nimbus-ds%2Fcollapsible)](https://www.npmjs.com/package/@nimbus-ds/collapsible)

The Collapsible is a component that can hid and show another component when a event is triggered from a button or a link.

## Installation

```sh
$ yarn add @nimbus-ds/collapsible
# or
$ npm install @nimbus-ds/collapsible
```

### Component Anatomy

The component consists of a Item, Body and a container that can encapsulate the logic of hide and show some stuff.

## Guidelines

We use Collapsible to hide some content and show it only when a open event is triggered

### Recommendations for use

- Hide and show a component
- Display a hint of a text and hide the bigger part of it until the user click on a button

### Related components

- Accordion - It is a component allows us to compress content into containers that can be opened or closed.

## Usage

View docs [here](https://nimbus.nuvemshop.com.br/documentation/atomic-components/collapsible).

<img alt="Nimbus" style="margin-bottom: 30px;" src="https://tiendanube.github.io/design-system-nimbus/static/media/nimbus-logo.ab60bd79.png" height="30" />

0 comments on commit 3133619

Please sign in to comment.