@agnos-ui/svelte-bootstrap 0.4.0-next.1 → 0.4.1

package/components/accordion/Accordion.svelte.d.ts

@@ -2,7 +2,7 @@ import { SvelteComponent } from "svelte";
 import type { AccordionApi, AccordionProps, AccordionSlots } from './accordion';
 declare const __propDef: {
     props: {
-        api?: AccordionApi | undefined;
+        api?: AccordionApi;
     } & Partial<AccordionProps>;
     events: {
         [evt: string]: CustomEvent<any>;

package/components/accordion/Item.svelte.d.ts

@@ -2,7 +2,7 @@ import { SvelteComponent } from "svelte";
 import type { AccordionItemApi, AccordionItemProps, AccordionItemSlots } from './accordion';
 declare const __propDef: {
     props: {
-        api?: AccordionItemApi | undefined;
+        api?: AccordionItemApi;
     } & Partial<AccordionItemProps>;
     events: {
         [evt: string]: CustomEvent<any>;

package/components/accordion/accordion.d.ts

@@ -1,9 +1,6 @@
-import type { WidgetFactory, WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
-import type { AccordionWidget, AccordionApi, AccordionProps, AccordionItemProps, AccordionItemWidget } from './accordion.gen';
-export type * from './accordion.gen';
-export declare const createAccordion: WidgetFactory<AccordionWidget>;
-export declare const getAccordionDefaultConfig: () => AccordionProps;
-export declare const createAccordionItem: WidgetFactory<AccordionItemWidget>;
+import type { WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
+import type { AccordionApi, AccordionItemProps, AccordionProps } from './accordion.gen';
+export * from './accordion.gen';
 export interface AccordionSlots extends WidgetPropsSlots<AccordionProps> {
 }
 export interface AccordionItemSlots extends WidgetPropsSlots<AccordionItemProps> {

package/components/accordion/accordion.gen.d.ts

@@ -1,5 +1,11 @@
-import type { WidgetSlotContext, SlotContent, Widget, PropsConfig, Directive } from '@agnos-ui/svelte-headless/types';
+import type { WidgetSlotContext, SlotContent, Widget, WidgetFactory, ConfigValidator, PropsConfig, 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 accordion config
+ * @returns the default accordion config
+ */
+declare const export_getAccordionDefaultConfig: () => AccordionProps;
+export { export_getAccordionDefaultConfig as getAccordionDefaultConfig };
 export type AccordionItemContext = WidgetSlotContext<AccordionItemWidget>;
 export interface AccordionState {
     /**
@@ -8,6 +14,8 @@ export interface AccordionState {
     itemWidgets: AccordionItemWidget[];
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -21,61 +29,96 @@ export interface AccordionState {
     itemStructure: SlotContent<AccordionItemContext>;
 }
 export interface AccordionProps {
+    /**
+     * The transition to use for the accordion-item body-container when the accordion-item is toggled.
+     *
+     * @defaultValue
+     * ```ts
+     * collapseVerticalTransition
+     * ```
+     */
+    itemTransition: TransitionFn;
     /**
      * If `true`, only one accordion-item at the time can stay open.
+     *
+     * @defaultValue `false`
      */
     closeOthers: boolean;
     /**
      * An event fired when an item is shown.
      *
      * Event payload is the id of the item.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onItemShown: (itemId: string) => void;
     /**
      * An event fired when an item is hidden.
      *
      * Event payload is the id of the item.
+     *
+     * @defaultValue
+     * ```ts
+     * () => {}
+     * ```
      */
     onItemHidden: (itemId: string) => void;
     /**
      * If `true`, the accordion-item body container will be removed from the DOM when the accordion-item is collapsed. It will be just hidden otherwise.
+     *
+     * @defaultValue `true`
      */
     itemDestroyOnHide: boolean;
     /**
      * If `true`, accordion-item will be animated.
+     *
+     * @defaultValue `true`
      */
     itemAnimated: boolean;
-    /**
-     * The transition to use for the accordion-item body-container when the accordion-item is toggled.
-     */
-    itemTransition: TransitionFn;
     /**
      * CSS classes to add on the accordion-item DOM element.
+     *
+     * @defaultValue `''`
      */
     itemClassName: string;
     /**
      * CSS classes to add on the accordion-item header DOM element.
+     *
+     * @defaultValue `''`
      */
     itemHeaderClassName: string;
     /**
      * CSS classes to add on the accordion-item toggle button DOM element.
+     *
+     * @defaultValue `''`
      */
     itemButtonClassName: string;
     /**
      * CSS classes to add on the accordion-item body container DOM element.
      * The accordion-item body container is the DOM element on what the itemTransition is applied.
+     *
+     * @defaultValue `''`
      */
     itemBodyContainerClassName: string;
     /**
      * CSS classes to add on the accordion-item body DOM element.
+     *
+     * @defaultValue `''`
      */
     itemBodyClassName: string;
     /**
      * The html tag to use for the accordion-item-header.
+     *
+     * @defaultValue `''`
      */
     itemHeadingTag: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -131,6 +174,8 @@ export interface AccordionItemState {
     headingTag: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -218,6 +263,8 @@ export interface AccordionItemProps {
     headingTag: string;
     /**
      * CSS classes to be applied on the widget main container
+     *
+     * @defaultValue `''`
      */
     className: string;
     /**
@@ -243,6 +290,31 @@ export interface AccordionItemProps {
     header: SlotContent<AccordionItemContext>;
 }
 export type AccordionItemWidget = Widget<AccordionItemProps, AccordionItemState, AccordionItemApi, AccordionItemActions, AccordionItemDirectives>;
+/**
+ * Create an AccordionItemWidget with given config props
+ * @param config - an optional AccordionItem config
+ * @returns an AccordionItemWidget
+ */
+declare const export_createAccordionItem: WidgetFactory<AccordionItemWidget>;
+export { export_createAccordionItem as createAccordionItem };
+/**
+ * Create an AccordionWidget with given config props
+ * @param config - an optional accordion config
+ * @returns an AccordionWidget
+ */
+declare const export_createAccordion: WidgetFactory<AccordionWidget>;
+export { export_createAccordion as createAccordion };
+/**
+ * Create an accordion WidgetFactory based on a item factory and the list of item props that should inherit from the parent accordion
+ *
+ * @param itemFactory - the item factory
+ * @param accordionItemProps - the list of item props
+ * @param accordionConfig - the default accordion config
+ * @param accordionValidator - the validator of props
+ * @returns the accordion widget factory
+ */
+declare const export_factoryCreateAccordion: (itemFactory?: WidgetFactory<AccordionItemWidget>, accordionItemProps?: string[], accordionConfig?: AccordionProps, accordionValidator?: ConfigValidator<AccordionProps>) => WidgetFactory<AccordionWidget>;
+export { export_factoryCreateAccordion as factoryCreateAccordion };
 export interface AccordionApi {
     /**
      * Given the itemId, will expand the corresponding accordion-item.

package/components/accordion/accordion.gen.js

@@ -1 +1,32 @@
-export {};
+import { getAccordionDefaultConfig, createAccordionItem, createAccordion, factoryCreateAccordion } from '@agnos-ui/core-bootstrap/components/accordion';
+/**
+ * Retrieve a shallow copy of the default accordion config
+ * @returns the default accordion config
+ */
+const export_getAccordionDefaultConfig = getAccordionDefaultConfig;
+export { export_getAccordionDefaultConfig as getAccordionDefaultConfig };
+/**
+ * Create an AccordionItemWidget with given config props
+ * @param config - an optional AccordionItem config
+ * @returns an AccordionItemWidget
+ */
+const export_createAccordionItem = createAccordionItem;
+export { export_createAccordionItem as createAccordionItem };
+/**
+ * Create an AccordionWidget with given config props
+ * @param config - an optional accordion config
+ * @returns an AccordionWidget
+ */
+const export_createAccordion = createAccordion;
+export { export_createAccordion as createAccordion };
+/**
+ * Create an accordion WidgetFactory based on a item factory and the list of item props that should inherit from the parent accordion
+ *
+ * @param itemFactory - the item factory
+ * @param accordionItemProps - the list of item props
+ * @param accordionConfig - the default accordion config
+ * @param accordionValidator - the validator of props
+ * @returns the accordion widget factory
+ */
+const export_factoryCreateAccordion = factoryCreateAccordion;
+export { export_factoryCreateAccordion as factoryCreateAccordion };

package/components/accordion/accordion.js

@@ -1,7 +1,4 @@
-import { createAccordion as coreCreateAccordion, getAccordionDefaultConfig as coreGetAccordionDefaultConfig, createAccordionItem as coreCreateAccordionItem, } from '@agnos-ui/core-bootstrap/components/accordion';
-export const createAccordion = coreCreateAccordion;
-export const getAccordionDefaultConfig = coreGetAccordionDefaultConfig;
-export const createAccordionItem = coreCreateAccordionItem;
+export * from './accordion.gen';
 // context
 import { getContext, setContext } from 'svelte';
 const contextInjectionKey = Symbol('accordion-api');

package/components/alert/Alert.svelte.d.ts

@@ -2,7 +2,7 @@ import { SvelteComponent } from "svelte";
 import { type AlertApi, type AlertProps, type AlertSlots } from './alert';
 declare const __propDef: {
     props: {
-        api?: AlertApi | undefined;
+        api?: AlertApi;
     } & Partial<AlertProps>;
     events: {
         [evt: string]: CustomEvent<any>;

package/components/alert/alert.d.ts

@@ -1,7 +1,5 @@
-import type { WidgetPropsSlots, WidgetFactory } from '@agnos-ui/svelte-headless/types';
-import type { AlertProps, AlertWidget } from './alert.gen';
-export type * from './alert.gen';
-export declare const createAlert: WidgetFactory<AlertWidget>;
-export declare const getAlertDefaultConfig: () => AlertProps;
+import type { WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
+import type { AlertProps } from './alert.gen';
+export * from './alert.gen';
 export interface AlertSlots extends WidgetPropsSlots<AlertProps> {
 }

package/components/alert/alert.gen.d.ts

@@ -1,6 +1,12 @@
-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 { BSContextualClass } from '@agnos-ui/core-bootstrap/types';
 import type { TransitionFn } from '@agnos-ui/svelte-headless/services/transitions/baseTransitions';
+/**
+ * Retrieve a shallow copy of the default Alert config
+ * @returns the default Alert config
+ */
+declare const export_getAlertDefaultConfig: () => AlertProps;
+export { export_getAlertDefaultConfig as getAlertDefaultConfig };
 export type AlertContext = WidgetSlotContext<AlertWidget>;
 export interface AlertState {
     /**
@@ -10,18 +16,26 @@ export interface AlertState {
     /**
      * 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;
     /**
@@ -34,33 +48,54 @@ export interface AlertState {
     children: SlotContent<AlertContext>;
     /**
      * Type of the alert, following bootstrap types.
+     *
+     * @defaultValue `'primary'`
      */
     type: BSContextualClass;
 }
 export interface AlertProps {
+    /**
+     * 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;
     /**
@@ -68,23 +103,33 @@ export interface AlertProps {
      *
      * 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;
     /**
@@ -97,10 +142,19 @@ export interface AlertProps {
     children: SlotContent<AlertContext>;
     /**
      * Type of the alert, following bootstrap types.
+     *
+     * @defaultValue `'primary'`
      */
     type: BSContextualClass;
 }
 export type AlertWidget = Widget<AlertProps, AlertState, AlertApi, object, AlertDirectives>;
+/**
+ * Create an AlertWidget with given config props
+ * @param config - an optional alert config
+ * @returns an AlertWidget
+ */
+declare const export_createAlert: WidgetFactory<AlertWidget>;
+export { export_createAlert as createAlert };
 export interface AlertApi {
     /**
      * Triggers alert closing programmatically (same as clicking on the close button (×)).

package/components/alert/alert.gen.js

@@ -1 +1,14 @@
-export {};
+import { getAlertDefaultConfig, createAlert } from '@agnos-ui/core-bootstrap/components/alert';
+/**
+ * Retrieve a shallow copy of the default Alert config
+ * @returns the default Alert config
+ */
+const export_getAlertDefaultConfig = getAlertDefaultConfig;
+export { export_getAlertDefaultConfig as getAlertDefaultConfig };
+/**
+ * Create an AlertWidget with given config props
+ * @param config - an optional alert config
+ * @returns an AlertWidget
+ */
+const export_createAlert = createAlert;
+export { export_createAlert as createAlert };

package/components/alert/alert.js

@@ -1,3 +1 @@
-import { createAlert as coreCreateAlert, getAlertDefaultConfig as coreGetAlertDefaultConfig } from '@agnos-ui/core-bootstrap/components/alert';
-export const createAlert = coreCreateAlert;
-export const getAlertDefaultConfig = coreGetAlertDefaultConfig;
+export * from './alert.gen';

package/components/modal/modal.d.ts

@@ -1,8 +1,5 @@
-import type { WidgetPropsSlots, PropsConfig } from '@agnos-ui/svelte-headless/types';
-import type { ModalProps, ModalWidget } from './modal.gen';
-export type * from './modal.gen';
-export declare const createModal: <Data>(propsConfig?: PropsConfig<ModalProps<Data>>) => ModalWidget<Data>;
-export { modalCloseButtonClick, modalOutsideClick } from '@agnos-ui/core-bootstrap/components/modal';
-export declare const getModalDefaultConfig: () => ModalProps<any>;
+import type { WidgetPropsSlots } from '@agnos-ui/svelte-headless/types';
+import type { ModalProps } from './modal.gen';
+export * from './modal.gen';
 export interface ModalSlots extends WidgetPropsSlots<ModalProps<any>> {
 }