diff --git a/README.md b/README.md index 7fb8c0e..0bd7178 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
[![npm](https://img.shields.io/npm/v/@ngxpert/hot-toast?style=flat-square)](https://www.npmjs.com/package/@ngxpert/hot-toast) -[![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg?style=flat-square)](https://github.com/ngxpert/hot-toast/blob/master/LICENSE) +[![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg?style=flat-square)](https://github.com/ngxpert/hot-toast/blob/main/LICENSE) [![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)]() [![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/ngxpert/hot-toast/compare) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) @@ -263,19 +263,19 @@ Configuration used when opening an hot-toast. | id | `string` | Unique id to associate with hot-toast. There can't be multiple hot-toasts opened with same id.
_[Example](https://ngxpert.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`
_Default: `3000, error = 4000, loading = 30000`_ | Yes | | autoClose | `boolean` | Auto close hot-toast after duration
_Default: `true`_ | Yes | -| position | [`ToastPosition`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/master/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastPosition) | The position to place the hot-toast.
_Default: `top-center`_
_[Example](https://ngxpert.github.io/hot-toast/#positions)_ | Yes | +| position | [`ToastPosition`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastPosition) | The position to place the hot-toast.
_Default: `top-center`_
_[Example](https://ngxpert.github.io/hot-toast/#positions)_ | Yes | | dismissible | `boolean` | Show close button in hot-toast
_Default: `false`_
_[Example](https://ngxpert.github.io/hot-toast/#dismissible)_ | Yes | -| role | [`ToastRole`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/master/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastRole) | Role of the live region.
_Default: `status`_ | Yes | -| ariaLive | [`ToastAriaLive`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/master/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastAriaLive) | aria-live value for the live region.
_Default: `polite`_ | Yes | -| theme | [`ToastTheme`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/master/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastTheme) | Visual appearance of hot-toast
_Default: `toast`_
_[Example](https://ngxpert.github.io/hot-toast/#snackbar)_ | Yes | -| persist | [`{ToastPersistConfig}`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/master/projects/ngxpert/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.
_[Example](https://ngxpert.github.io/hot-toast/#persistent)_ | No | +| role | [`ToastRole`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastRole) | Role of the live region.
_Default: `status`_ | Yes | +| ariaLive | [`ToastAriaLive`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastAriaLive) | aria-live value for the live region.
_Default: `polite`_ | Yes | +| theme | [`ToastTheme`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20ToastTheme) | Visual appearance of hot-toast
_Default: `toast`_
_[Example](https://ngxpert.github.io/hot-toast/#snackbar)_ | Yes | +| persist | [`{ToastPersistConfig}`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/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.
_[Example](https://ngxpert.github.io/hot-toast/#persistent)_ | No | | icon | [`Content`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/overview/blob/main/projects/ngxpert/overview/src/lib/views/types.ts&q=export%20type%20Content) | Icon to show in the hot-toast
_[Example](https://ngxpert.github.io/hot-toast/#emoji)_ | Yes | -| iconTheme | [`IconTheme`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/master/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20IconTheme) | Use this to change icon color
_[Example](https://ngxpert.github.io/hot-toast/#themed)_ | Yes | +| iconTheme | [`IconTheme`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/hot-toast/src/lib/hot-toast.model.ts&q=export%20type%20IconTheme) | Use this to change icon color
_[Example](https://ngxpert.github.io/hot-toast/#themed)_ | Yes | | className | `string` | Extra CSS classes to be added to the hot toast container. | Yes | | attributes | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeystype) | Extra attributes to be added to the hot toast container. Can be used for e2e tests. | Yes | | style | `style object` | Extra styles to apply for hot-toast.
_[Example](https://ngxpert.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/ngxpert/hot-toast/blob/master/projects/ngxpert/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`.
_Examples: [Template with Data](https://ngxpert.github.io/hot-toast/#template-data), [Component with Data](https://ngxpert.github.io/hot-toast/#component-data)_ | No | +| data | [`DataType`](https://github-link.vercel.app/api?ghUrl=https://github.com/ngxpert/hot-toast/blob/main/projects/ngxpert/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`.
_Examples: [Template with Data](https://ngxpert.github.io/hot-toast/#template-data), [Component with Data](https://ngxpert.github.io/hot-toast/#component-data)_ | No | | injector | `Injector` | Allows you to pass injector for your component.
_[Example](https://ngxpert.github.io/hot-toast/#injector)_ | No | ---