sit-onyx 1.0.0-beta.185 → 1.0.0-beta.186

package/dist/components/OnyxInfoCard/types.d.ts

@@ -6,7 +6,7 @@ export type OnyxInfoCardProps = DensityProp & {
      */
     headline?: string;
     /**
-     * Toast color.
+     * Card color.
      */
     color?: OnyxColor;
     /**

package/dist/components/OnyxNotificationMessage/OnyxNotificationMessage.vue.d.ts

@@ -0,0 +1,25 @@
+import type { OnyxNotificationMessageProps } from "./types";
+type __VLS_Slots = {
+    /**
+     * Description/preview of the notification content.
+     */
+    default(): unknown;
+    /**
+     * Slot to provide optional buttons/actions.
+     */
+    buttons?(): unknown;
+};
+declare const __VLS_component: import("vue").DefineComponent<OnyxNotificationMessageProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    close: () => any;
+}, string, import("vue").PublicProps, Readonly<OnyxNotificationMessageProps> & Readonly<{
+    onClose?: (() => any) | undefined;
+}>, {
+    duration: number;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/OnyxNotificationMessage/types.d.ts

@@ -0,0 +1,17 @@
+export type OnyxNotificationMessageProps = {
+    /**
+     * Notification headline/title.
+     */
+    headline: string;
+    /**
+     * Duration in milliseconds for the notification to close automatically.
+     * Timer will be paused when hovering the toast.
+     *
+     * Can be set to `0` to disable the auto closing.
+     */
+    duration?: number;
+    /**
+     * Optional icon to display.
+     */
+    icon?: string;
+};

package/dist/components/OnyxNotifications/OnyxNotifications.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/OnyxNotifications/examples/DefaultExample.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/OnyxNotifications/useNotification.d.ts

@@ -0,0 +1,60 @@
+import { type ComputedRef, type InjectionKey } from "vue";
+import type { OnyxButtonProps } from "../OnyxButton/types";
+import type { OnyxNotificationMessageProps } from "../OnyxNotificationMessage/types";
+export type NotificationsProvider = {
+    /**
+     * Readonly list of currently active notifications.
+     */
+    notifications: ComputedRef<ProvidedNotification[]>;
+    /**
+     * Shows a single notification.
+     */
+    show: (notification: ShowNotificationOptions) => void;
+    /**
+     * Removes the notification with the given `id`.
+     */
+    remove: (id: ProvidedNotification["id"]) => void;
+};
+export type ProvidedNotification = ShowNotificationOptions & {
+    /**
+     * Unique notification id used to identify the notification.
+     */
+    id: number;
+    /**
+     * Handler that should remove the notification. Will be called when the notification closes.
+     * Is only used for internal onyx usage.
+     */
+    onClose: () => void;
+};
+export type ShowNotificationOptions = OnyxNotificationMessageProps & {
+    /**
+     * Description/preview of the notification content.
+     */
+    description: string;
+    /**
+     * Slot to provide optional buttons/actions.
+     */
+    buttons?: (OnyxButtonProps & {
+        /**
+         * Callback that is called when the button is clicked.
+         */
+        onClick?: () => void;
+    })[];
+};
+export declare const NOTIFICATIONS_PROVIDER_INJECTION_KEY: InjectionKey<NotificationsProvider>;
+/**
+ * Creates a new notifications provider that can be used with `useNotification()`.
+ * Should be provided once on global app level with:
+ *
+ * @example
+ * ```ts
+ * import { createNotificationsProvider, NOTIFICATIONS_PROVIDER_INJECTION_KEY } from "sit-onyx";
+ *
+ * app.provide(NOTIFICATIONS_PROVIDER_INJECTION_KEY, createNotificationsProvider());
+ * ```
+ */
+export declare const createNotificationsProvider: () => NotificationsProvider;
+/**
+ * Composable for showing notifications.
+ */
+export declare const useNotification: () => NotificationsProvider;