![\"Light](\"./site/public/images/flat-dark.png\")
\n ![\"Dark](\"./site/public/images/flat-light.png\")
\n![\"Logo\"](\"./site/public/images/logo.svg\"){kind=logo}
\n\n# Svelte-Toasts\n\nA highly configurable toast/notification component with individual toast state management capabilities.\n\n## Demo & Docs\n\nhttps://mzohaibqc.github.io/svelte-toasts/\n\nREPL: https://svelte.dev/repl/ff34bad88213493ab878c71497c01152?version=3.35.0\n\n## ![\"Dynamic](\"./site/public/images/dynamic-toast.gif\")
\n\n#### Flat Toast\n\n\n \n \n
\n ![\"Light](\"./site/public/images/bootstrap-dark.png\")
\n ![\"Dark](\"./site/public/images/bootstrap-light.png\")
\n
| Prop | Type | Default | Description |
|---|---|---|---|
title | string | - | Title of toast |
description | string | - | Description/body of toast |
remove | Function | - | Invoking remove method will remove the respective toast object from store/UI. e.g. toast1.remove() |
update | Function | - | Invoke update method to update a specific toast values like title, description or duration etc. toast.update({ title; \"Progress: 80%\" }) |
onClick | Function | () => {} | You can provide onClick callback which will be invoked when toast will be clicked (except toast close icon/button) |
onRemove | Function | () => {} | You can provide onRemove callback which will be invoked when toast will be auto removed or removed by clicking on cross icon/button. |
component | Svelte Component | - | You can provide your own toast component to render toast for a specific toast object |
placement | string | - | Set placement of current toast, it will override default placement set by ToastContainer |
showProgress | boolean | - | If set to \"true\" and duration is greater than 0 then a timeout progress bar will be shown at the bottom of current toast. It will override default value set by ToastContainer. |
theme | string | - | \"dark\" and \"light\" themes are implemented for builtin Toast components but in case of your own Toast component, you can implement or leave this feature. This will override default value set by ToastContainer if you are using builtin Toast components. |
type | string | - | Four types of toasts are available i.e. success, info, error and warning. It will override toast type set by ToastContainer. |
duration | number | - | Duration in milliseconds after which toast will be auto removed. If duration will be 0 or negative, toast will not be auto removed but user can click on cross icon to remove it. It will override duration specified by ToastContainer. |
| Name | Type | Description |
|---|---|---|
add | Function | This is key function to show toast. You can pass options and modify the generated toast. It will return toast object which you can use to modify or remove that specific toast programmatically, e.g. toast1.update({ title: 'New Title'}) |
removeAll | Function | This function removes all toasts and clears store state to empty array |
removeLast | Function | This function removes one toast (if any) that was generated at the end |
getById | Function | This function returns toast data for given id. Every toast has a unique uid |
setDefaults | Function | This function sets default options so you don't need to pass those options again and again, e.g. theme, placement etc. |
success | Function | Show success/green toast. |
info | Function | Show info/blue toast. |
error | Function | Show error/red toast. |
warning | Function | Show warning/orange toast. |
let | No | [Theme](#theme) | 'light' | Default theme for all toasts |\n| data | let | No | [ToastProps](#ToastProps) | {} | Default theme for all toasts |\n\n### Slots\n\n| Slot name | Default | Props | Fallback |\n| :--------- | :------ | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| close-icon | No | -- | <svg
xmlns=\"http://www.w3.org/2000/svg\"
class=\"bx--toast-notification\\_\\_close-icon\"
width=\"20\"
height=\"20\"
viewBox=\"0 0 32 32\"
aria-hidden=\"true\"
>
<path
d=\"M24 9.4L22.6 8 16 14.6 9.4 8 8 9.4 14.6 16 8 22.6 9.4 24 16 17.4 22.6 24 24 22.6 17.4 16 24 9.4z\"
/>
</svg> |\n| extra | No | -- | -- |\n| icon | No | -- | Svg icons based on type |\n\n### Events\n\nNone.\n\n## `FlatToast`\n\n```javascript\nimport { FlatToast } from 'svelte-toasts';\n```\n\n### Props\n\n| Prop name | Kind | Reactive | Type | Default value | Description |\n| :-------- | :--------------- | :------- | :--------------------------------------- | -------------------- | ---------------------------- |\n| theme | let | No | [Theme](#theme) | 'light' | Default theme for all toasts |\n| data | let | No | [ToastProps](#ToastProps) | {} | Default theme for all toasts |\n\n### Slots\n\n| Slot name | Default | Props | Fallback |\n| :--------- | :------ | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| close-icon | No | -- | <svg
xmlns=\"http://www.w3.org/2000/svg\"
class=\"bx--toast-notification\\_\\_close-icon\"
width=\"20\"
height=\"20\"
viewBox=\"0 0 32 32\"
aria-hidden=\"true\"
>
<path
d=\"M24 9.4L22.6 8 16 14.6 9.4 8 8 9.4 14.6 16 8 22.6 9.4 24 16 17.4 22.6 24 24 22.6 17.4 16 24 9.4z\"
/>
</svg> |\n| extra | No | -- | -- |\n| icon | No | -- | Svg icons based on type |\n\n### Events\n\nNone.\n\n## `ToastContainer`\n\n```javascript\nimport { ToastContainer } from 'svelte-toasts';\n```\n\n### Props\n\n| Prop name | Kind | Reactive | Type | Default value | Description |\n| :----------- | :--------------- | :------- | :------------------------------------- | --------------------------- | ---------------------------------------------------------------------- |\n| theme | let | No | [Theme](#Theme) | 'dark' | Default theme for all toasts |\n| placement | let | No | [Placement](#Placement) | 'bottom-right' | Default placement for all toasts |\n| type | let | No | [ToastType](#ToastType) | 'info' | Default type of all toasts |\n| showProgress | let | No | boolean | false | Show progress if showProgress is true and duration is greater then 0 |\n| duration | let | No | number | 3000 | Default duration for all toasts to auto close. 0 to disable auto close |\n| width | let | No | 'string' | '320px' | Width of all toasts |\n\n### Slots\n\n| Slot name | Default | Props | Fallback |\n| :-------- | :------ | :------------------------------------------------ | :------- |\n| -- | Yes | { data: [ToastProps](#ToastProps) } | -- |\n\n### Events\n\nNone.\n\n## Types\n\n#### `Theme`\n\n```ts\nexport type Theme = 'dark' | 'light';\n```\n\n#### `ToastType`\n\n```ts\nexport type ToastType = 'success' | 'info' | 'error' | 'warning';\n```\n\n#### `Placement`\n\n```ts\nexport type Placement =\n | 'bottom-right'\n | 'bottom-left'\n | 'top-right'\n | 'top-left'\n | 'top-center'\n | 'bottom-center'\n | 'center-center';\n```\n\n#### `ToastProps`\n\n```ts\nexport interface ToastProps {\n uid: number;\n title?: string;\n description: string;\n duration: number;\n type: ToastType;\n theme?: Theme;\n placement: Placement;\n showProgress?: boolean;\n remove?: Function;\n update?: Function;\n onRemove?: Function;\n onClick?: Function;\n}\n```\n\n#### `ToastStore`\n\n```ts\nexport interface ToastStore extends Writable {\n add(options: Partial): ToastProps;\n success(options: Partial): ToastProps;\n success(description: string): ToastProps;\n success(description: string, options: Partial): ToastProps;\n success(\n title: string,\n description: string,\n options?: Partial\n ): ToastProps;\n\n info(options: Partial): ToastProps;\n info(description: string): ToastProps;\n info(description: string, options: Partial): ToastProps;\n info(\n title: string,\n description: string,\n options?: Partial\n ): ToastProps;\n\n error(options: Partial): ToastProps;\n error(description: string): ToastProps;\n error(description: string, options: Partial): ToastProps;\n error(\n title: string,\n description: string,\n options?: Partial\n ): ToastProps;\n\n warning(options: Partial): ToastProps;\n warning(description: string): ToastProps;\n warning(description: string, options: Partial): ToastProps;\n warning(\n title: string,\n description: string,\n options?: Partial\n ): ToastProps;\n\n getById(uid: number): ToastProps;\n clearAll(): void;\n clearLast(): void;\n setDefaults(options: Partial): void;\n}\n```\n","readmeFilename":"README.md","author":{"name":"Zohaib Ijaz @mzohaibqc"},"bugs":{"url":"https://github.com/mzohaibqc/svelte-toasts/issues"}}