@skeletonlabs/skeleton
Version:
A SvelteKit component library.
37 lines (36 loc) • 1.24 kB
TypeScript
/// <reference types="svelte" />
import type { ModalSettings } from './types.js';
/**
* Retrieves the `modalStore`.
*
* This can *ONLY* be called from the **top level** of components!
*
* @example
* ```svelte
* <script>
* import { getModalStore } from "@skeletonlabs/skeleton";
*
* const modalStore = getModalStore();
*
* modalStore.trigger({ type: "alert", title: "Welcome!" });
* </script>
* ```
*/
export declare function getModalStore(): ModalStore;
/**
* Initializes the `modalStore`.
*/
export declare function initializeModalStore(): ModalStore;
export type ModalStore = ReturnType<typeof modalService>;
declare function modalService(): {
subscribe: (this: void, run: import("svelte/store").Subscriber<ModalSettings[]>, invalidate?: import("svelte/store").Invalidator<ModalSettings[]> | undefined) => import("svelte/store").Unsubscriber;
set: (this: void, value: ModalSettings[]) => void;
update: (this: void, updater: import("svelte/store").Updater<ModalSettings[]>) => void;
/** Append to end of queue. */
trigger: (modal: ModalSettings) => void;
/** Remove first item in queue. */
close: () => void;
/** Remove all items from queue. */
clear: () => void;
};
export {};