@ngneat/hot-toast
Advanced tools
Comparing version 2.0.1 to 2.0.2
{ | ||
"name": "@ngneat/hot-toast", | ||
"version": "2.0.1", | ||
"version": "2.0.2", | ||
"description": "Smoking hot Notifications for Angular. Lightweight, customizable and beautiful by default.", | ||
"schematics": "./schematics/collection.json", | ||
"peerDependencies": { | ||
"@angular/common": ">= 8.2.14 < 12", | ||
"@angular/core": ">= 8.2.14 < 12", | ||
"@angular/common": ">= 8.2.14 < 13", | ||
"@angular/core": ">= 8.2.14 < 13", | ||
"@ngneat/overview": "^1.0.0" | ||
@@ -10,0 +10,0 @@ }, |
@@ -49,3 +49,3 @@ <p align="center"> | ||
```bash | ||
npm install @ngneat/overview @ngneat/hot-toast | ||
npm install @ngneat/overview@1 @ngneat/hot-toast | ||
``` | ||
@@ -152,20 +152,20 @@ | ||
| Name | Type | Description | Available in global config? | | ||
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | ||
| id | `string` | Unique id to associate with hot-toast. There can't be multiple hot-toasts opened with same id. | No | | ||
| duration | `number` | Duration in milliseconds after which hot-toast will be auto closed. Can be disabled via `autoClose: false`<br>_Default: `3000, error = 4000, loading = 30000`_ | Yes | | ||
| autoClose | `boolean` | Auto close hot-toast after duration<br>_Default: `true`_ | Yes | | ||
| position | [`ToastPosition`](https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts#L34) | The position to place the hot-toast.<br>_Default: `top-center`_ | Yes | | ||
| dismissible | `boolean` | Show close button in hot-toast<br>_Default: `false`_ | Yes | | ||
| role | [`ToastRole`](https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts#L53) | Role of the live region.<br>_Default: `status`_ | Yes | | ||
| ariaLive | [`ToastAriaLive`](https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts#L55) | aria-live value for the live region.<br>_Default: `polite`_ | Yes | | ||
| theme | [`ToastTheme`](https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts#L41) | Visual appearance of hot-toast<br>_Default: `toast`_ | Yes | | ||
| persist | [`{ToastPersistConfig}`](https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts#L232) | Useful when you want to keep a persistance for toast based on ids, across sessions. | No | | ||
| icon | [`Content`](https://github.com/ngneat/overview/blob/main/projects/ngneat/overview/src/lib/views/types.ts#L16) | Icon to show in the hot-toast | Yes | | ||
| iconTheme | [`IconTheme`](https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts#L36) | Use this to change icon color | Yes | | ||
| className | `string` | Extra CSS classes to be added to the hot toast container. | Yes | | ||
| style | `style object` | Extra styles to apply for hot-toast | Yes | | ||
| closeStyle | `style object` | Extra styles to apply for close button | Yes | | ||
| context | `Record<string, any>` | Allows you to pass context for your template. Please note that `$implicit` is reserved for `toastRef`. | No | | ||
| injector | `Injector` | Allows you to pass injector for your component | No | | ||
| Name | Type | Description | Available in global config? | | ||
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | | ||
| id | `string` | Unique id to associate with hot-toast. There can't be multiple hot-toasts opened with same id. <br>*[Example](https://ngneat.github.io/hot-toast/#only-one-at-a-time)* | No | | ||
| duration | `number` | Duration in milliseconds after which hot-toast will be auto closed. Can be disabled via `autoClose: false`<br>_Default: `3000, error = 4000, loading = 30000`_ | Yes | | ||
| autoClose | `boolean` | Auto close hot-toast after duration<br>_Default: `true`_ | Yes | | ||
| position | [`ToastPosition`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastPosition) | The position to place the hot-toast.<br>_Default: `top-center`_<br>*[Example](https://ngneat.github.io/hot-toast/#positions)* | Yes | | ||
| dismissible | `boolean` | Show close button in hot-toast<br>_Default: `false`_<br>*[Example](https://ngneat.github.io/hot-toast/#dismissible)* | Yes | | ||
| role | [`ToastRole`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastRole) | Role of the live region.<br>_Default: `status`_ | Yes | | ||
| ariaLive | [`ToastAriaLive`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastAriaLive) | aria-live value for the live region.<br>_Default: `polite`_ | Yes | | ||
| theme | [`ToastTheme`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastTheme) | Visual appearance of hot-toast<br>_Default: `toast`_<br>*[Example](https://ngneat.github.io/hot-toast/#snackbar)* | Yes | | ||
| persist | [`{ToastPersistConfig}`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20class%20ToastPersistConfig) | Useful when you want to keep a persistance for toast based on ids, across sessions.<br>*[Example](https://ngneat.github.io/hot-toast/#persistent)* | No | | ||
| icon | [`Content`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/overview/blob/main/projects/ngneat/overview/src/lib/views/types.ts&q=export%20type%20Content) | Icon to show in the hot-toast<br>*[Example](https://ngneat.github.io/hot-toast/#emoji)* | Yes | | ||
| iconTheme | [`IconTheme`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20IconTheme) | Use this to change icon color<br>*[Example](https://ngneat.github.io/hot-toast/#themed)* | Yes | | ||
| className | `string` | Extra CSS classes to be added to the hot toast container. | Yes | | ||
| style | `style object` | Extra styles to apply for hot-toast.<br>*[Example](https://ngneat.github.io/hot-toast/#themed)* | Yes | | ||
| closeStyle | `style object` | Extra styles to apply for close button | Yes | | ||
| data | [`DataType`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngneat/hot-toast/blob/master/projects/ngneat/hot-toast/src/lib/hot-toast.model.ts&q=export%20interface%20Toast%3CDataType%3E) | Allows you to pass data for your template and component. You can access the data using `toastRef.data`.<br>*Examples: [Template with Data](https://ngneat.github.io/hot-toast/#template-data), [Component with Data](https://ngneat.github.io/hot-toast/#component-data)* | No | | ||
| injector | `Injector` | Allows you to pass injector for your component.<br>*[Example](https://ngneat.github.io/hot-toast/#injector)* | No | | ||
@@ -176,3 +176,3 @@ --- | ||
Latest versions of Chrome, Edge, Firefox and Safari are supported. | ||
Latest versions of Chrome, Edge, Firefox and Safari are supported, with some known [issues](https://github.com/ngneat/hot-toast/labels/browser). | ||
@@ -179,0 +179,0 @@ ## Accessibility |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
516510