@apsc/glob-notify
v0.0.8
Published
Svelte component for notifications globally for the entire application
Downloads
24
Maintainers
Readme
Svelte component for notifications globally for the entire application
- no dependencies
- no inline styles
- one instance for the entire application
- custom notification transition
- custom notification element components
- configurable timeout for each notification
Docs & Demo • API
Install
NPM
npm i -D @apsc/glob-notify
PNPM
pnpm add -D @apsc/glob-notify
Usage
<Notifications />
<Application />
The Notifications
component has one instance for the entire application. Use the Notifications
component at the top level of your markup, before any components that send notifications.
The default slot (optional) of the Notifications
component is the markup for the notification element.
The Notifications
component exports the notifications
custom store corresponding to the store contract.
{
subscribe: Subscriber<NotificationData[]>,
clear: () => void,
push: (notification: NotificationData) => symbol,
pop: (id: symbol) => void
}
You can subscribe to changes in the store, and append and remove notifications anywhere in your app.
<script>
import { Notifications, notifications } from '@apsc/glob-notify';
function handleNotify() {
notifications.push({ message: 'Hello from NyApp' })
}
</script>
<Notifications />
<h1>Welcome to MyApp</h1>
<button on:click={handleNotify}>Notify</button>
Styling
Base
import '@apsc/glob-notify/style.css';
Bootstrap-like
import '@apsc/glob-notify/bootstrap-like.css';