Skip to content

Commit c135945

Browse files
authored
Capital Store in changelog
1 parent 77a8d58 commit c135945

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ const App = () => {
6666
};
6767
```
6868

69-
Import <code>store</code> where needed - will be used to access `addNotification` and `removeNotification` API methods
69+
Import <code>Store</code> where needed - will be used to access `addNotification` and `removeNotification` API methods
7070
```js
7171
import { Store } from 'react-notifications-component';
7272
```
7373

7474
Then call `addNotification` and watch the magic happens
7575

7676
```jsx
77-
store.addNotification({
77+
Store.addNotification({
7878
title: "Wonderful!",
7979
message: "teodosii@react-notifications-component",
8080
type: "success",
@@ -108,11 +108,11 @@ For more info on how to use `animate.css`, please refer to [animate.css docs](ht
108108

109109
## API
110110

111-
`store.addNotification(options)`
111+
`Store.addNotification(options)`
112112

113113
Render a new notification. Method returns a unique id for the rendered notification. Supplied options are internally validated and an exception will be thrown if validation fails.
114114

115-
`store.removeNotification(id)`
115+
`Store.removeNotification(id)`
116116

117117
Manually remove a notification by id.
118118

@@ -148,7 +148,7 @@ You have in total 6 containers for desktop and 2 for mobile, if component is set
148148
* `bottom-center`
149149

150150
```js
151-
store.addNotification({
151+
Store.addNotification({
152152
...notification,
153153
container: 'top-right'
154154
})
@@ -168,7 +168,7 @@ List of types:
168168

169169

170170
```js
171-
store.addNotification({
171+
Store.addNotification({
172172
...notification,
173173
type: 'danger'
174174
})
@@ -179,7 +179,7 @@ Will trigger a `danger` notification.
179179
#### Animating
180180

181181
```js
182-
store.addNotification({
182+
Store.addNotification({
183183
...notification,
184184
animationIn: ['animate__animated animate__fadeIn'], // `animate.css v4` classes
185185
animationOut: ['animate__animated animate__fadeOut'] // `animate.css v4` classes
@@ -193,7 +193,7 @@ store.addNotification({
193193
#### Dismiss notification automatically after timeout expires
194194

195195
```js
196-
store.addNotification({
196+
Store.addNotification({
197197
...notification,
198198
dismiss: {
199199
duration: 2000
@@ -204,7 +204,7 @@ store.addNotification({
204204
#### Dismiss notification automatically with the time left shown on UI
205205

206206
```js
207-
store.addNotification({
207+
Store.addNotification({
208208
...notification,
209209
dismiss: {
210210
duration: 2000,
@@ -218,7 +218,7 @@ store.addNotification({
218218
Easily subscribe to `onRemoval` by supplying callback as option to the notification object. Callback will get called after the removal animation finishes.
219219

220220
```js
221-
store.addNotification({
221+
Store.addNotification({
222222
...notification,
223223
onRemoval: (id, removedBy) => {
224224
...
@@ -229,7 +229,7 @@ store.addNotification({
229229
#### Pause notification's timeout by hovering
230230

231231
```js
232-
store.addNotification({
232+
Store.addNotification({
233233
...notification,
234234
dismiss: {
235235
duration: 2000,
@@ -241,7 +241,7 @@ store.addNotification({
241241
#### Change transition
242242

243243
```js
244-
store.addNotification({
244+
Store.addNotification({
245245
...notification,
246246
slidingExit: {
247247
duration: 800,
@@ -254,7 +254,7 @@ store.addNotification({
254254
`slidingEnter`, `touchRevert` and `touchSlidingExit` can all be configured in the same way, with the mention that `touchSlidingExit` has 2 transitions nested.
255255

256256
```js
257-
store.addNotification({
257+
Store.addNotification({
258258
...notification,
259259
touchSlidingExit: {
260260
swipe: {
@@ -472,7 +472,7 @@ store.addNotification({
472472

473473
## Migration from v1
474474

475-
* Ref usage has been deprecated. Import `store` from library and use it for adding and removing notifications
475+
* Ref usage has been deprecated. Import `Store` from library and use it for adding and removing notifications
476476
* `touchSlidingBack` has been renamed to `touchRevert`
477477
* Default values for transitions have been slightly changed
478478
* `dismissIcon` has been removed. Use `showIcon` instead. If you relly on customized close icon, then stick to custom content.

0 commit comments

Comments
 (0)