@agnos-ui/svelte-bootstrap 0.4.0-next.0 → 0.4.0

package/components/toast/toast.gen.d.ts

@@ -1,5 +1,11 @@
-import type { WidgetSlotContext, SlotContent, Widget, Directive } from '@agnos-ui/svelte-headless/types';
+import type { WidgetSlotContext, SlotContent, Widget, WidgetFactory, Directive } from '@agnos-ui/svelte-headless/types';
 import type { TransitionFn } from '@agnos-ui/svelte-headless/services/transitions/baseTransitions';
+/**
+ * Retrieve a shallow copy of the default Toast config
+ * @returns the default Toast config
+ */
+declare const export_getToastDefaultConfig: () => ToastProps;
+export { export_getToastDefaultConfig as getToastDefaultConfig };
 export type ToastContext = WidgetSlotContext<ToastWidget>;
 export interface ToastState {
     /**
@@ -9,26 +15,38 @@ export interface ToastState {
     /**
      * If `true`, alert can be dismissed by the user.
      * The close button (×) will be displayed and you can be notified of the event with the (close) output.
+     *
+     * @defaultValue `true`
      */
     dismissible: boolean;
     /**
      * If `true` the alert is visible to the user
+     *
+     * @defaultValue `true`
      */
     visible: boolean;
     /**
      * Accessibility close button label
+     *
+     * @defaultValue `'Close'`
      */
     ariaCloseButtonLabel: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
      * If `true` automatically hides the toast after the delay.
+     *
+     * @defaultValue `true`
      */
     autoHide: boolean;
     /**
      * Delay in milliseconds before hiding the toast.
+     *
+     * @defaultValue `5000`
      */
     delay: number;
     /**
@@ -45,29 +63,48 @@ export interface ToastState {
     header: SlotContent<ToastContext>;
 }
 export interface ToastProps {
+    /**
+     * The transition function will be executed when the alert is displayed or hidden.
+     *
+     * Depending on the value of `animatedOnInit`, the animation can be optionally skipped during the showing process.
+     *
+     * @defaultValue `fadeTransition`
+     */
+    transition: TransitionFn;
     /**
      * Callback called when the alert visibility changed.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onVisibleChange: (visible: boolean) => void;
     /**
      * Callback called when the alert is hidden.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onHidden: () => void;
     /**
      * Callback called when the alert is shown.
-     */
-    onShown: () => void;
-    /**
-     * The transition function will be executed when the alert is displayed or hidden.
      *
-     * Depending on the value of `animatedOnInit`, the animation can be optionally skipped during the showing process.
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
-    transition: TransitionFn;
+    onShown: () => void;
     /**
      * If `true`, alert opening will be animated.
      *
      * Animation is triggered  when the `.open()` function is called
      * or the visible prop is changed
+     *
+     * @defaultValue `false`
      */
     animatedOnInit: boolean;
     /**
@@ -75,31 +112,45 @@ export interface ToastProps {
      *
      * Animation is triggered  when clicked on the close button (×),
      * via the `.close()` function or the visible prop is changed
+     *
+     * @defaultValue `true`
      */
     animated: boolean;
     /**
      * If `true`, alert can be dismissed by the user.
      * The close button (×) will be displayed and you can be notified of the event with the (close) output.
+     *
+     * @defaultValue `true`
      */
     dismissible: boolean;
     /**
      * If `true` the alert is visible to the user
+     *
+     * @defaultValue `true`
      */
     visible: boolean;
     /**
      * Accessibility close button label
+     *
+     * @defaultValue `'Close'`
      */
     ariaCloseButtonLabel: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
      * If `true` automatically hides the toast after the delay.
+     *
+     * @defaultValue `true`
      */
     autoHide: boolean;
     /**
      * Delay in milliseconds before hiding the toast.
+     *
+     * @defaultValue `5000`
      */
     delay: number;
     /**
@@ -116,6 +167,13 @@ export interface ToastProps {
     header: SlotContent<ToastContext>;
 }
 export type ToastWidget = Widget<ToastProps, ToastState, ToastApi, object, ToastDirectives>;
+/**
+ * Create an ToastWidget with given config props
+ * @param config - an optional alert config
+ * @returns an ToastWidget
+ */
+declare const export_createToast: WidgetFactory<ToastWidget>;
+export { export_createToast as createToast };
 export interface ToastApi {
     /**
      * Triggers alert closing programmatically (same as clicking on the close button (×)).

package/components/toast/toast.gen.js

@@ -1 +1,14 @@
-export {};
+import { getToastDefaultConfig, createToast } from '@agnos-ui/core-bootstrap/components/toast';
+/**
+ * Retrieve a shallow copy of the default Toast config
+ * @returns the default Toast config
+ */
+const export_getToastDefaultConfig = getToastDefaultConfig;
+export { export_getToastDefaultConfig as getToastDefaultConfig };
+/**
+ * Create an ToastWidget with given config props
+ * @param config - an optional alert config
+ * @returns an ToastWidget
+ */
+const export_createToast = createToast;
+export { export_createToast as createToast };

package/components/toast/toast.js

@@ -1,3 +1 @@
-import { createToast as coreCreateToast, getToastDefaultConfig as coreGetToastDefaultConfig } from '@agnos-ui/core-bootstrap/components/toast';
-export const createToast = coreCreateToast;
-export const getToastDefaultConfig = coreGetToastDefaultConfig;
+export * from './toast.gen';

package/config.d.ts

@@ -15,5 +15,5 @@ type WidgetFactoryInput<W extends Widget> = {
 type AdaptParentConfig = (config: Partial2Levels<WidgetsConfig>) => Partial2Levels<WidgetsConfig>;
 type CreateWidgetsDefaultConfig = (adaptParentConfig?: AdaptParentConfig) => WidgetsConfigStore<WidgetsConfig>;
 export declare const widgetsDefaultConfigKey: symbol, createWidgetsDefaultConfig: CreateWidgetsDefaultConfig, getContextWidgetConfig: <N extends keyof WidgetsConfig>(widgetName: N) => ReadableSignal<Partial<WidgetsConfig[N]> | undefined>, callWidgetFactory: <W extends Widget>({ factory, widgetName, $$slots, defaultConfig, events, $$props, }: WidgetFactoryInput<W>) => W & {
-    patchChangedProps: W['patch'];
+    patchChangedProps: W["patch"];
 };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@agnos-ui/svelte-bootstrap",
 	"description": "Bootstrap-based widget library for Svelte.",
-	"version": "0.4.0-next.0",
+	"version": "0.4.0",
 	"type": "module",
 	"main": "./index.js",
 	"module": "./index.js",
@@ -49,8 +49,8 @@
 		}
 	},
 	"dependencies": {
-		"@agnos-ui/core-bootstrap": "0.4.0-next.0",
-		"@agnos-ui/svelte-headless": "0.4.0-next.0"
+		"@agnos-ui/core-bootstrap": "0.4.0",
+		"@agnos-ui/svelte-headless": "0.4.0"
 	},
 	"peerDependencies": {
 		"@amadeus-it-group/tansu": "^1.0.0",