Skip to content

Commit

Permalink
Merge branch 'release/2.0.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
glennflanagan committed Sep 13, 2017
2 parents 3edd413 + 793b927 commit 20f4ff7
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 938 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ Supported by [Browserstack](https://www.browserstack.com).
![Browserstack Logo](example/img/browserstack-logo.png "Browserstack")

---
## Migrating from v1.x to v2.0
## Migrating from v1.x to v2.x
Version 2 is 100% API complete to version 1. However, there is a breaking change in the `onOpen` and `onClose` callbacks. These methods now fire at the end of the collapsing animation. There is also the addition of `onOpening` and `onClosing` callbacks which fire at the beginning of the animation.

To migrate to v2 from v1 simply change the `onOpen` prop to `onOpening` and `onClose` to `onClosing`.

## What's new in 2.0
# What's new in version 2.0.1
Issues fixed (#50, #52)

### 2.0.0 release notes
* Added `onClosing` and `onOpening` callback props.
* Several issue fixes (#12, #21, #24)

Expand Down Expand Up @@ -156,13 +159,13 @@ The state of the component is also reflected on this element with the modifier c
The outer container that hides the content. This is set to `overflow: hidden` within the javascript but everything else about it is for you to change.

### `.Collapsible__contentInner`
This is a container for the content passed into the compoenent. This keeps everything nice and neat and allows the component to do all it's whizzy calculations.
This is a container for the content passed into the component. This keeps everything nice and neat and allows the component to do all it's whizzy calculations.

If you're using a CSS framework such as Foundation or Bootstrap, you probably want to use their classes instead of styling `.Collapsible`. See Properties above.

---
## Example
An example of the component in action is available in the example folder. To see it in action you can run `wepback-dev-server` which will run the webpack build and open the example.
An example of the component in action is available in the example folder. To see it in action you can run `webpack-dev-server` which will run the webpack build and open the example.

---
## Licence
Expand Down
Loading

0 comments on commit 20f4ff7

Please sign in to comment.