diff --git a/README.md b/README.md
index 6add15c8..e9889587 100644
--- a/README.md
+++ b/README.md
@@ -93,6 +93,12 @@ ReactDOM.render(
- Accessible Accordion component for React. Inspired by rc-collapse and react-sanfona. -
-name | -type | -default | -description | -
---|---|---|---|
accordion | -Boolean | -true | -Open only one item at a time or not | -
onChange | -Function(keys) | -noop | -Triggered on change (open/close items) | -
className | -String | -accordion | -CSS class(es) applied to the component | -
name | -type | -default | -description | -
---|---|---|---|
expanded | -Boolean | -false | -Expands this item on first render | -
className | -String | -accordion__item | -CSS class(es) applied to the component | -
name | -type | -default | -description | -
---|---|---|---|
className | -String | -accordion__title | -CSS class(es) applied to the component | -
name | -type | -default | -description | -
---|---|---|---|
className | -String | -accordion__body | -CSS class(es) applied to the component | -
- hideBody - ClassName - | -String | -accordion__body--hidden | -Class name for hidden body state | -
+ Accessible Accordion component for React. Inspired by rc-collapse and react-sanfona. +
+name | -type | -default | -description | -
---|---|---|---|
accordion | -Boolean | -true | -Open only one item at a time or not | -
onChange | -Function(keys) | -noop | -Triggered on change (open/close items) | -
className | -String | -accordion | -CSS class(es) applied to the component | -
name | -type | -default | -description | -
---|---|---|---|
expanded | -Boolean | -false | -Expands this item on first render | -
className | -String | -accordion__item | -CSS class(es) applied to the component | -
name | -type | -default | -description | -
---|---|---|---|
className | -String | -accordion__title | -CSS class(es) applied to the component | -
name | -type | -default | -description | -
---|---|---|---|
className | -String | -accordion__body | -CSS class(es) applied to the component | -
- hideBody - ClassName - | -String | -accordion__body--hidden | -Class name for hidden body state | -
- Clone the project on your computer, and install Node. This project also uses nvm. -
-
- nvm install
- # Then, install all project dependencies.
- npm install
- # Install the git hooks.
- ./.githooks/deploy
- # Set up a `.env` file with the appropriate secrets.
- touch .env
-
name | +type | +default | +description | +
---|---|---|---|
accordion | +Boolean | +true | +Open only one item at a time or not | +
onChange | +Function(keys) | +noop | +Triggered on change (open/close items) | +
className | +String | +accordion | +CSS class(es) applied to the component | +
name | +type | +default | +description | +
---|---|---|---|
expanded | +Boolean | +false | +Expands this item on first render | +
className | +String | +accordion__item | +CSS class(es) applied to the component | +
name | +type | +default | +description | +
---|---|---|---|
className | +String | +accordion__title | +CSS class(es) applied to the component | +
name | +type | +default | +description | +
---|---|---|---|
className | +String | +accordion__body | +CSS class(es) applied to the component | +
+ hideBody + ClassName + | +String | +accordion__body--hidden | +Class name for hidden body state | +
- Everything mentioned in the installation process should already be done. -
-
- # Make sure you use the right node version.
- nvm use
- # Start the the development tools in watch mode.
- npm run start
- # Runs linting.
- npm run lint
- # Runs tests.
- npm run test
- # View other available commands with:
- npm run
-
- Everything mentioned in the installation process should already be done. -
-
- # Make sure you use the right node version.
- nvm use
- # Start the server and the development tools.
- npm run start-demo
-
name | +type | +default | +description | +
---|---|---|---|
accordion | +Boolean | +true | +Open only one item at a time or not | +
onChange | +Function(keys) | +noop | +Triggered on change (open/close items) | +
className | +String | +accordion | +CSS class(es) applied to the component | +
name | +type | +default | +description | +
---|---|---|---|
expanded | +Boolean | +false | +Expands this item on first render | +
className | +String | +accordion__item | +CSS class(es) applied to the component | +
name | +type | +default | +description | +
---|---|---|---|
className | +String | +accordion__title | +CSS class(es) applied to the component | +
name | +type | +default | +description | +
---|---|---|---|
className | +String | +accordion__body | +CSS class(es) applied to the component | +
+ hideBody + ClassName + | +String | +accordion__body--hidden | +Class name for hidden body state | +
+ Clone the project on your computer, and install Node. This project also uses nvm. +
+
+ nvm install
+ # Then, install all project dependencies.
+ npm install
+ # Install the git hooks.
+ ./.githooks/deploy
+ # Set up a `.env` file with the appropriate secrets.
+ touch .env
+
- Everything mentioned in the installation process should already be done. -
-
- # Make sure you use the right node version.
- nvm use
- # Start the the development tools in watch mode.
- npm run start
- # Runs linting.
- npm run lint
- # Runs tests.
- npm run test
- # View other available commands with:
- npm run
-
- Everything mentioned in the installation process should already be done. -
-
- # Make sure you use the right node version.
- nvm use
- # Start the server and the development tools.
- npm run start-demo
-
+ Everything mentioned in the installation process should already be done. +
+
+ # Make sure you use the right node version.
+ nvm use
+ # Start the the development tools in watch mode.
+ npm run start
+ # Runs linting.
+ npm run lint
+ # Runs tests.
+ npm run test
+ # View other available commands with:
+ npm run
+
+ Everything mentioned in the installation process should already be done. +
+
+ # Make sure you use the right node version.
+ nvm use
+ # Start the server and the development tools.
+ npm run start-demo
+
+ Everything mentioned in the installation process should already be done. +
+
+ # Make sure you use the right node version.
+ nvm use
+ # Start the the development tools in watch mode.
+ npm run start
+ # Runs linting.
+ npm run lint
+ # Runs tests.
+ npm run test
+ # View other available commands with:
+ npm run
+
+ Everything mentioned in the installation process should already be done. +
+
+ # Make sure you use the right node version.
+ nvm use
+ # Start the server and the development tools.
+ npm run start-demo
+
- Did you notice the animation on the arrow? -
-- Check css/demo.css in the demo/ folder :) -
-+ Did you notice the animation on the arrow? +
++ Check css/demo.css in the demo/ folder :) +
++ Why would you need more than one? +
+- Why would you need more than one? -
-+ This should be open by default. +
++ This shoud be open by default. +
++ This should open when clicking on the button. +
+