@zag-js/toast 0.1.9 → 0.1.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Chakra UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -1,11 +1,201 @@
-import { groupConnect } from "./toast-group.connect";
-import { groupMachine } from "./toast-group.machine";
-import { createToastMachine as createMachine } from "./toast.machine";
-export { connect } from "./toast.connect";
-export type { GroupMachineContext, MachineContext, MachineState, Placement, Service, Type } from "./toast.types";
-export { createMachine };
-export declare const group: {
+import * as _zag_js_core from '@zag-js/core';
+import { Machine, StateMachine } from '@zag-js/core';
+import { RootProperties, CommonProperties, Direction, DirectionProperty, Context, RequiredBy, PropTypes, NormalizeProps } from '@zag-js/types';
+
+declare type Type = "success" | "error" | "loading" | "info" | "custom";
+declare type Placement = "top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end";
+declare type SharedContext = {
+    /**
+     * Whether to pause toast when the user leaves the browser tab
+     */
+    pauseOnPageIdle?: boolean;
+    /**
+     * Whether to pause the toast when interacted with
+     */
+    pauseOnInteraction?: boolean;
+};
+declare type ToastOptions = {
+    /**
+     * The unique id of the toast
+     */
+    id: string;
+    /**
+     * The type of the toast
+     */
+    type: Type;
+    /**
+     * The placement of the toast
+     */
+    placement: Placement;
+    /**
+     * The message of the toast
+     */
+    title?: string;
+    /**
+     * The description of the toast
+     */
+    description?: string;
+    /**
+     * The duration the toast will be visible
+     */
+    duration: number;
+    /**
+     * Custom function to render the toast element.
+     */
+    render?: (options: RenderOptions) => any;
+    /**
+     * The duration for the toast to kept alive before it is removed.
+     * Useful for exit transitions.
+     */
+    removeDelay?: number;
+    /**
+     * Function called when the toast has been closed and removed
+     */
+    onClose?: VoidFunction;
+    /**
+     * Function called when the toast is leaving
+     */
+    onClosing?: VoidFunction;
+    /**
+     * Function called when the toast is shown
+     */
+    onOpen?: VoidFunction;
+    /**
+     * Function called when the toast is updated
+     */
+    onUpdate?: VoidFunction;
+};
+declare type Options = Partial<ToastOptions>;
+declare type RenderOptions = Omit<ToastOptions, "render"> & {
+    dismiss(): void;
+};
+declare type MachineContext = SharedContext & RootProperties & CommonProperties & Omit<ToastOptions, "removeDelay"> & {
+    /**
+     * The duration for the toast to kept alive before it is removed.
+     * Useful for exit transitions.
+     */
+    removeDelay: number;
+    /**
+     * The document's text/writing direction.
+     */
+    dir?: Direction;
+    /**
+     * The time the toast was created
+     */
+    createdAt: number;
+    /**
+     * The time left before the toast is removed
+     */
+    remaining: number;
+};
+declare type MachineState = {
+    value: "active" | "active:temp" | "dismissing" | "inactive" | "persist";
+    tags: "visible" | "paused" | "updating";
+};
+declare type State = StateMachine.State<MachineContext, MachineState>;
+declare type Send = StateMachine.Send;
+declare type Service = Machine<MachineContext, MachineState>;
+declare type GroupPublicContext = SharedContext & DirectionProperty & CommonProperties & {
+    /**
+     * The gutter or spacing between toasts
+     */
+    gutter: string;
+    /**
+     * The z-index applied to each toast group
+     */
+    zIndex: number;
+    /**
+     * The maximum number of toasts that can be shown at once
+     */
+    max: number;
+    /**
+     * The offset from the safe environment edge of the viewport
+     */
+    offsets: string | Record<"left" | "right" | "bottom" | "top", string>;
+};
+declare type UserDefinedGroupContext = RequiredBy<GroupPublicContext, "id">;
+declare type GroupComputedContext = Readonly<{
+    /**
+     * @computed
+     * The total number of toasts in the group
+     */
+    readonly count: number;
+}>;
+declare type GroupPrivateContext = Context<{}>;
+declare type GroupMachineContext = GroupPublicContext & GroupComputedContext & GroupPrivateContext;
+declare type GroupState = StateMachine.State<GroupMachineContext>;
+declare type GroupSend = (event: StateMachine.Event<StateMachine.AnyEventObject>) => void;
+declare type MaybeFunction<Value, Args> = Value | ((arg: Args) => Value);
+declare type PromiseOptions<Value> = {
+    loading: ToastOptions;
+    success: MaybeFunction<ToastOptions, Value>;
+    error: MaybeFunction<ToastOptions, Error>;
+};
+declare type GroupProps = {
+    placement: Placement;
+    label?: string;
+};
+declare type Toaster = {
+    count: number;
+    isVisible(id: string): boolean;
+    upsert(options: ToastOptions): string | undefined;
+    create(options: ToastOptions): string | undefined;
+    success(options: ToastOptions): string | undefined;
+    error(options: ToastOptions): string | undefined;
+    loading(options: ToastOptions): string | undefined;
+    dismiss(id?: string | undefined): void;
+    remove(id?: string | undefined): void;
+    promise<T>(promise: Promise<T>, options: PromiseOptions<T>, shared?: ToastOptions): Promise<T>;
+};
+
+declare function groupConnect<T extends PropTypes>(state: GroupState, send: GroupSend, normalize: NormalizeProps<T>): {
+    count: number;
+    toasts: Service[];
+    toastsByPlacement: Partial<Record<Placement, Service[]>>;
+    isVisible(id: string): boolean;
+    create(options: Options): string | undefined;
+    upsert(options: Options): string | undefined;
+    dismiss(id?: string): void;
+    remove(id?: string): void;
+    dismissByPlacement(placement: Placement): void;
+    update(id: string, options: Options): string | undefined;
+    loading(options: Options): string | undefined;
+    success(options: Options): string | undefined;
+    error(options: Options): string | undefined;
+    promise<T_1>(promise: Promise<T_1>, options: PromiseOptions<T_1>, shared?: Options): Promise<T_1>;
+    pause(id?: string): void;
+    resume(id?: string): void;
+    getGroupProps(options: GroupProps): T["element"];
+    createPortal(): HTMLElement;
+    subscribe(fn: (toasts: GroupMachineContext["toasts"]) => void): () => void;
+};
+
+declare function groupMachine(ctx: UserDefinedGroupContext): _zag_js_core.Machine<GroupMachineContext, _zag_js_core.StateMachine.StateSchema, _zag_js_core.StateMachine.AnyEventObject>;
+
+declare function createToastMachine(options?: Options): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
+
+declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): {
+    type: Type;
+    title: string | undefined;
+    description: string | undefined;
+    placement: Placement;
+    isVisible: boolean;
+    isPaused: boolean;
+    pause(): void;
+    resume(): void;
+    dismiss(): void;
+    rootProps: T["element"];
+    progressbarProps: T["element"];
+    titleProps: T["element"];
+    descriptionProps: T["element"];
+    closeButtonProps: T["button"];
+    render(): any;
+};
+
+declare const group: {
     connect: typeof groupConnect;
     machine: typeof groupMachine;
 };
-export declare function api(): import("./toast.types").Toaster;
+declare function api(): Toaster | undefined;
+
+export { GroupMachineContext, MachineContext, MachineState, Placement, Service, Type, api, connect, createToastMachine as createMachine, group };