https://github.com/teamwertarbyte/material-ui-snackbar-provider
A convenient way to use material-ui's snackbars.
https://github.com/teamwertarbyte/material-ui-snackbar-provider
material-ui react snackbar
Last synced: 6 months ago
JSON representation
A convenient way to use material-ui's snackbars.
- Host: GitHub
- URL: https://github.com/teamwertarbyte/material-ui-snackbar-provider
- Owner: TeamWertarbyte
- License: mit
- Created: 2017-08-16T08:12:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T00:06:05.000Z (almost 3 years ago)
- Last Synced: 2025-04-02T22:36:01.439Z (6 months ago)
- Topics: material-ui, react, snackbar
- Language: JavaScript
- Size: 3.43 MB
- Stars: 81
- Watchers: 2
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Material-UI Snackbar Provider
[](https://standardjs.com)
[](https://travis-ci.org/TeamWertarbyte/material-ui-snackbar-provider)
[](https://coveralls.io/github/TeamWertarbyte/material-ui-snackbar-provider?branch=master)
A convenient way to use [material-ui][]'s snackbars.
## Installation
```shell
npm i --save material-ui-snackbar-provider
```
## Usage
Simply wrap all components that should display snackbars with the `SnackbarProvider` component,
e.g. by wrapping your router with it.
```js
import { SnackbarProvider } from 'material-ui-snackbar-provider'
// somewhere at the root of your app
{/* the rest of your app belongs here, e.g. the router */}
```
You can then display messages with the `useSnackbar` hook. More examples [can be found here](https://github.com/TeamWertarbyte/material-ui-snackbar-provider/tree/master/stories).
```js
import { useSnackbar } from 'material-ui-snackbar-provider'
export default function MyComponent (props) {
const snackbar = useSnackbar()
const handleSomething = () => {
snackbar.showMessage(
'Something happened!',
'Undo', () => handleUndo()
)
}
const handleUndo = () => {
// *snip*
}
return (
// *snip*
)
}
```
If you're not using React ^16.8.0 and our you can't use hooks (e.g. in a class component), you can use the `withSnackbar` HOC and the injected `snackbar` prop instead.
```js
import { withSnackbar } from 'material-ui-snackbar-provider'
class MyComponent {
// *snip*
handleSomething () {
this.props.snackbar.showMessage(
'Something happened!',
'Undo', () => this.handleUndo())
}
handleUndo () {
// *snip*
}
}
export default withSnackbar()(MyComponent) // export the wrapped component
```
### Snackbar variants
Snackbar variants (i.e. diffent styles for different types of messages) can be implemented using the `Alert` component from `@material-ui/lab`. An example that also adds a custom hook to display snackbars with different severities is available [here](https://github.com/TeamWertarbyte/material-ui-snackbar-provider/tree/master/stories/1-custom.stories.js).
### SnackbarProvider Props
|Name |Type |Default |Description
|----------------|------------|------------|--------------------------------
|ButtonProps|`object`||Props to pass through to the action [button][mui-button].
|children|`node`||The children that are wrapped by this provider.
|SnackbarComponent|`ReactElement`||Custom snackbar component.
|SnackbarProps|`object`||Props to pass through to the [snackbar][mui-snackbar].
\* required property
[mui-button]: https://material-ui.com/api/button/
[mui-snackbar]: https://material-ui.com/api/snackbar/
### Snackbar methods
`snackbar.showMessage(message, [action, handler, customParameters, closeWithoutActionHandler])`
* `message` (string) – message to display
* `action` (string, _optional_) – label for the action button
* `handler` (function, _optional_) – click handler for the action button
* `customParameters` (any, _optional_) - custom parameters that will be passed to the snackbar renderer
* `closeWithoutActionHandler` (function, _optional_) - function that is called when the snackbar hides and the action button was not clicked
## Concerns
> Dude, this is not pretty React-like, I don't want to call a function to do something that changes the UI! I want to display a snackbar based on the state only, e.g. by using Redux.
I agree. And if it wouldn't be an absolute pain to do that if you intend to display more than one snackbar, this package wouldn't even exist. The thing is that most of the time, snackbars are displayed when state _changes_ and not really depend on the _state_ itself.
Also, calling a method after dispatching the action is pretty convenient, especially when using something like [redux-thunk][]:
```js
deleteEmail (id) {
this.props.dispatch(someReduxThunkAction())
.then(() => {
this.snackbar.showMessage(
'E-mail deleted',
'Undo', () => this.restoreEmail(id))
})
.catch((e) => {
this.snackbar.showMessage(
'E-mail could not be deleted',
'Retry', () => this.deleteEmail(id))
})
}
```
So this package makes snackbars a lot easier to use, which is all it's intended to do.
[material-ui]: https://material-ui.com/
[redux-thunk]: https://github.com/gaearon/redux-thunk
## License
The files included in this repository are licensed under the MIT license.