# Toasted-notes
[](https://www.npmjs.com/package/toasted-notes)
[](https://twitter.com/intent/tweet?text=toasted%20notes%20is%20a%20react%20library%20for%20creating%20simple%2C%20flexible%20toast%20notifications.&url=https://github.com/bmcmahen/toasted-notes&hashtags=react,javascript)
[](
https://twitter.com/intent/follow?screen_name=benmcmahen
)
A simple but flexible implementation of toast style notifications for React extracted from [Sancho UI](https://github.com/bmcmahen/sancho).
[View the demo and documentation](https://toasted-notes.netlify.com/).
## Features
- **An imperative API.** This means that you don't need to set component state or render elements to trigger notifications. Instead, just call a function.
- **Render whatever you want.** Utilize the render callback to create entirely custom notifications.
- **Functional default styles.** Import the provided css for some nice styling defaults or write your own styles.
## Install
Install `toasted-notes` and its peer dependency, `react-spring`, using yarn or npm.
```
yarn add toasted-notes react-spring
```
## Example
```jsx
import toaster from "toasted-notes";
import "toasted-notes/src/styles.css"; // optional styles
const HelloWorld = () => (
);
```
## API
The notify function accepts either a string, a react node, or a render callback.
```jsx
// using a string
toaster.notify("With a simple string");
// using jsx
toaster.notify(
Hi there
);
// using a render callback
toaster.notify(({ onClose }) => (
My custom toaster
));
```
It also accepts options.
```javascript
toaster.notify("Hello world", {
position: "bottom-left", // top-left, top, top-right, bottom-left, bottom, bottom-right
duration: null // This notification will not automatically close
});
```
## Using Context
One downside to the current API is that render callbacks and custom nodes won't get access to any application context, such as theming variables provided by styled-components. To ensure that render callbacks have access to the necessary context, you'll need to supply that context to the callback.
```jsx
const CustomNotification = ({ title }) => {
const theme = useTheme();
return
{title}
;
};
const CustomNotificationWithTheme = withTheme(CustomNotification);
toaster.notify(() => );
```
## Contributors
- [Einar Löve](https://github.com/einarlove)
## License
MIT
## Prior art
Way back, this was originally based on the wonderful implementation of notifications in [evergreen](https://evergreen.segment.com).
---
_Source: https://npm.io/package/toasted-notes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._