notistack

Highly customizable notification snackbars (toasts) that can be stacked on top of each other

Github星跟蹤圖

notistack

npm downloads
npm version
npm version

Notistack is a Snackbar library which makes it extremely easy to display notifications on your web apps. It is highly customizable and enables you to stack snackbars/toasts on top of one another. See demos for more info.

Play with online demo here, Stacking behaviour, Dismiss oldest when reached maxSnack (3 here), ---, ---, , , Table of Contents

--

Getting Started

Use your preferred package manager:

npm install notistack
yarn add notistack 

How to use

1: Wrap your app inside a SnackbarProvider component: (see docs for a full list of available props)

Note: If you're using material-ui ThemeProvider, make sure SnackbarProvider is a child of it.

import { SnackbarProvider } from 'notistack';

<SnackbarProvider maxSnack={3}>
    <App />
</SnackbarProvider>

2: Export any component that needs to send notification using withSnackbar. By doing this, you'll have access to methods enqueueSnackbar and closeSnackbar, where the former can be used to send snackbars.

import { withSnackbar } from 'notistack';

class MyComponent extends Component {
  handleNetworkRequest = () => {
     fetchSomeData()
        .then(() => this.props.enqueueSnackbar('Successfully fetched the data.'))
        .catch(() => this.props.enqueueSnackbar('Failed fetching data.'));
  };

  render(){
     //...
  };
  
};

export default withSnackbar(MyComponent);

Online demo

You can see the online demo and experiment all the possible configurations here.
Or see the code for a minimal working example: codesandbox

Documentation

Visit the documentation website

Redux and Mobx support:

notistack is compatible with state management libraries such as Redux and Mobx. See notistack documentation for more info.

Contribution

Open an issue and your problem will be solved.

Notes

Material Design guidelines suggests that only one snackbar should be displayed at a time. But I liked to stack them. ? So I made notistack. But if you'd like to stick to the guidelines, you can set maxSnack to 1 and just take advantage of enqueueSnackbar function.

Author - Contact

Hossein Dehnokhalaji



主要指標

概覽
名稱與所有者iamhosseindhv/notistack
主編程語言TypeScript
編程語言JavaScript (語言數: 2)
平台
許可證Other
所有者活动
創建於2018-08-04 21:05:47
推送於2025-01-18 06:39:52
最后一次提交2025-01-18 06:38:49
發布數66
最新版本名稱v3.0.2 (發布於 2025-01-18 06:38:49)
第一版名稱v0.4.3 (發布於 )
用户参与
星數4k
關注者數22
派生數300
提交數515
已啟用問題?
問題數436
打開的問題數51
拉請求數99
打開的拉請求數10
關閉的拉請求數74
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?