lfk/frontend
2
0
Fork 0
Code Issues 3 Pull Requests Actions Projects Releases Wiki Activity
frontend/.pnpm-store/v3/files/81/24c693218f5af87fd3f8f1e1ac9a84c567542a575b6ff0da6f7472686e522996925c6adb354a6bb89c23e7542cdc61b2fa1f4381075e6180a48cb7bbdca459

440 lines
12 KiB
Plaintext
Raw Blame History

# Toastify
![Built with JavaScript](https://img.shields.io/badge/Built%20with-JavaScript-red?style=for-the-badge&logo=javascript)
[![toastify-js](https://img.shields.io/badge/toastify--js-1.12.0-brightgreen.svg)](https://www.npmjs.com/package/toastify-js)
![MIT License](https://img.shields.io/npm/l/toastify-js)
Toastify is a lightweight, vanilla JS toast notification library.
## Demo
[Click here](https://apvarun.github.io/toastify-js/)
## Features
* Multiple stacked notifications
* Customizable
* No blocking of execution thread
### Customization options
* Notification Text
* Duration
* Toast background color
* Close icon display
* Display position
* Offset position
## Installation
#### Toastify now supports installation via NPM
* Run the below command to add toastify-js to your exisitng or new project.
```
npm install --save toastify-js
```
or
```
yarn add toastify-js -S
```
* Import toastify-js into your module to start using it.
```
import Toastify from 'toastify-js'
```
You can use the default CSS from Toastify as below and later override it or choose to write your own CSS.
```
import "toastify-js/src/toastify.css"
```
#### Adding ToastifyJs to HTML page using the traditional method
To start using **Toastify**, add the following CSS on to your page.
```html
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/toastify-js/src/toastify.min.css">
```
And the script at the bottom of the page
```html
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/toastify-js"></script>
```
> Files are delivered via the CDN service provided by [jsdeliver](https://www.jsdelivr.com/)
## Documentation
```javascript
Toastify({
text: "This is a toast",
duration: 3000,
destination: "https://github.com/apvarun/toastify-js",
newWindow: true,
close: true,
gravity: "top", // `top` or `bottom`
position: "left", // `left`, `center` or `right`
stopOnFocus: true, // Prevents dismissing of toast on hover
style: {
background: "linear-gradient(to right, #00b09b, #96c93d)",
},
onClick: function(){} // Callback after click
}).showToast();
```
> Toast messages will be centered on devices with screen width less than 360px.
* See the [changelog](https://github.com/apvarun/toastify-js/blob/master/CHANGELOG.md)
### Add own custom classes
If you want to use custom classes on the toast for customizing (like info or warning for example), you can do that as follows:
```javascript
Toastify({
text: "This is a toast",
className: "info",
style: {
background: "linear-gradient(to right, #00b09b, #96c93d)",
}
}).showToast();
```
Multiple classes also can be assigned as a string, with spaces between class names.
### Add some offset
If you want to add offset to the toast, you can do that as follows:
```javascript
Toastify({
text: "This is a toast with offset",
offset: {
x: 50, // horizontal axis - can be a number or a string indicating unity. eg: '2em'
y: 10 // vertical axis - can be a number or a string indicating unity. eg: '2em'
},
}).showToast();
```
Toast will be pushed 50px from right in x axis and 10px from top in y axis.
**Note:**
If `position` is equals to `left`, it will be pushed from left.
If `gravity` is equals to `bottom`, it will be pushed from bottom.
## API
| Option Key | type | Usage | Defaults |
|-----------------|----------------------|----------------------------------------------------------------------------|-------------|
| text | string | Message to be displayed in the toast | "Hi there!" |
| node | ELEMENT_NODE | Provide a node to be mounted inside the toast. `node` takes higher precedence over `text` | |
| duration | number | Duration for which the toast should be displayed.<br>-1 for permanent toast | 3000 |
| selector | string \| ELEMENT_NODE | ShadowRoot | CSS Selector or Element Node on which the toast should be added | body |
| destination | URL string | URL to which the browser should be navigated on click of the toast | |
| newWindow | boolean | Decides whether the `destination` should be opened in a new window or not | false |
| close | boolean | To show the close icon or not | false |
| gravity | "top" or "bottom" | To show the toast from top or bottom | "top" |
| position | "left" or "right" | To show the toast on left or right | "right" |
| backgroundColor | CSS background value | To be deprecated, use `style.background` option instead. Sets the background color of the toast | |
| avatar | URL string | Image/icon to be shown before text | |
| className | string | Ability to provide custom class name for further customization | |
| stopOnFocus | boolean | To stop timer when hovered over the toast (Only if duration is set) | true |
| callback | Function | Invoked when the toast is dismissed | |
| onClick | Function | Invoked when the toast is clicked | |
| offset | Object | Ability to add some offset to axis | |
| escapeMarkup | boolean | Toggle the default behavior of escaping HTML markup | true |
| style | object | Use the HTML DOM Style properties to add any style directly to toast | |
| ariaLive | string | Announce the toast to screen readers, see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions for options | "polite" |
| oldestFirst | boolean | Set the order in which toasts are stacked in page | true |
> Deprecated properties: `backgroundColor` - use `style.background` option instead
## Browsers support
| ![][ie]<br />IE / Edge | ![][firefox]<br />Firefox | ![][chrome]<br />Chrome | ![][safari]<br />Safari | ![][opera]<br />Opera |
| ---------------------- | ------------------------- | ----------------------- | ----------------------- | --------------------- |
| IE10, IE11, Edge | last 10 versions | last 10 versions | last 10 versions | last 10 versions |
## Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table>
<tr>
<td align="center">
<a href="https://github.com/AStoker">
<img
alt="AStoker"
src="https://avatars.githubusercontent.com/u/2907279?v=4"
width="117"
/>
<br />
AStoker
</a>
</td>
<td align="center">
<a href="https://github.com/caiomoura1994">
<img
alt="caiomoura1994"
src="https://avatars.githubusercontent.com/u/9389139?v=4"
width="117"
/>
<br />
caiomoura1994
</a>
</td>
<td align="center">
<a href="https://github.com/rndevfx">
<img
alt="rndevfx"
src="https://avatars.githubusercontent.com/u/5052076?v=4"
width="117"
/>
<br />
rndevfx
</a>
</td>
<td align="center">
<a href="https://github.com/1ess">
<img
alt="1ess"
src="https://avatars.githubusercontent.com/u/36092926?v=4"
width="117"
/>
<br />
1ess
</a>
</td>
<td align="center">
<a href="https://github.com/d4rn0k">
<img
alt="d4rn0k"
src="https://avatars.githubusercontent.com/u/2183269?v=4"
width="117"
/>
<br />
d4rn0k
</a>
</td>
<td align="center">
<a href="https://github.com/danielkaiser80">
<img
alt="danielkaiser80"
src="https://avatars.githubusercontent.com/u/33827555?v=4"
width="117"
/>
<br />
danielkaiser80
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/skjnldsv">
<img
alt="skjnldsv"
src="https://avatars.githubusercontent.com/u/14975046?v=4"
width="117"
/>
<br />
skjnldsv
</a>
</td>
<td align="center">
<a href="https://github.com/chasedeanda">
<img
alt="chasedeanda"
src="https://avatars.githubusercontent.com/u/8203134?v=4"
width="117"
/>
<br />
chasedeanda
</a>
</td>
<td align="center">
<a href="https://github.com/chrisgraham">
<img
alt="chrisgraham"
src="https://avatars.githubusercontent.com/u/195389?v=4"
width="117"
/>
<br />
chrisgraham
</a>
</td>
<td align="center">
<a href="https://github.com/Wachiwi">
<img
alt="Wachiwi"
src="https://avatars.githubusercontent.com/u/4199845?v=4"
width="117"
/>
<br />
Wachiwi
</a>
</td>
<td align="center">
<a href="https://github.com/FeixuRuins">
<img
alt="FeixuRuins"
src="https://avatars.githubusercontent.com/u/66232834?v=4"
width="117"
/>
<br />
FeixuRuins
</a>
</td>
<td align="center">
<a href="https://github.com/gavinhungry">
<img
alt="gavinhungry"
src="https://avatars.githubusercontent.com/u/744538?v=4"
width="117"
/>
<br />
gavinhungry
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/haydster7">
<img
alt="haydster7"
src="https://avatars.githubusercontent.com/u/4540595?v=4"
width="117"
/>
<br />
haydster7
</a>
</td>
<td align="center">
<a href="https://github.com/joaquinwojcik">
<img
alt="joaquinwojcik"
src="https://avatars.githubusercontent.com/u/3205737?v=4"
width="117"
/>
<br />
joaquinwojcik
</a>
</td>
<td align="center">
<a href="https://github.com/juliushaertl">
<img
alt="juliushaertl"
src="https://avatars.githubusercontent.com/u/3404133?v=4"
width="117"
/>
<br />
juliushaertl
</a>
</td>
<td align="center">
<a href="https://github.com/mort3za">
<img
alt="mort3za"
src="https://avatars.githubusercontent.com/u/510242?v=4"
width="117"
/>
<br />
mort3za
</a>
</td>
<td align="center">
<a href="https://github.com/Sandip124">
<img
alt="Sandip124"
src="https://avatars.githubusercontent.com/u/37034590?v=4"
width="117"
/>
<br />
Sandip124
</a>
</td>
<td align="center">
<a href="https://github.com/Tadaz">
<img
alt="Tadaz"
src="https://avatars.githubusercontent.com/u/10881931?v=4"
width="117"
/>
<br />
Tadaz
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/t12ung">
<img
alt="t12ung"
src="https://avatars.githubusercontent.com/u/9781423?v=4"
width="117"
/>
<br />
t12ung
</a>
</td>
<td align="center">
<a href="https://github.com/victorfeijo">
<img
alt="victorfeijo"
src="https://avatars.githubusercontent.com/u/8865899?v=4"
width="117"
/>
<br />
victorfeijo
</a>
</td>
<td align="center">
<a href="https://github.com/fiatjaf">
<img
alt="fiatjaf"
src="https://avatars.githubusercontent.com/u/1653275?v=4"
width="117"
/>
<br />
fiatjaf
</a>
</td>
<td align="center">
<a href="https://github.com/prousseau-korem">
<img
alt="prousseau-korem"
src="https://avatars.githubusercontent.com/u/59747802?v=4"
width="117"
/>
<br />
prousseau-korem
</a>
</td>
</tr>
</table>
<!-- ALL-CONTRIBUTORS-LIST:END -->
## License
MIT © [Varun A P](https://github.com/apvarun)
<a href="https://www.buymeacoffee.com/apvarun" target="_blank" rel="noopener"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="40" width="145" alt="Buy Me A Coffee"></a>
[ie]: https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/edge.png
[firefox]: https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/firefox.png
[chrome]: https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/chrome.png
[safari]: https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/safari.png
[opera]: https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/opera.png
Reference in New Issue View Git Blame Copy Permalink