@agnos-ui/core-bootstrap 0.4.0-next.1 → 0.4.0

package/components/accordion/accordion.d.ts

@@ -1,5 +1,6 @@
 import type { AccordionApi, AccordionDirectives, AccordionItemActions, AccordionItemApi, AccordionProps as CoreProps, AccordionState as CoreState, AccordionItemState as CoreItemState, AccordionItemProps as CoreItemProps, AccordionItemDirectives } from '@agnos-ui/core/components/accordion';
 import type { SlotContent, Widget, WidgetFactory, WidgetSlotContext } from '@agnos-ui/core/types';
+import type { TransitionFn } from '@agnos-ui/core/services/transitions/baseTransitions';
 export * from '@agnos-ui/core/components/accordion';
 export type AccordionItemContext = WidgetSlotContext<AccordionItemWidget>;
 interface AccordionExtraProps {
@@ -39,6 +40,15 @@ interface AccordionItemExtraProps {
 export interface AccordionState extends CoreState, AccordionExtraProps {
 }
 export interface AccordionProps extends CoreProps, AccordionExtraProps {
+    /**
+     * The transition to use for the accordion-item body-container when the accordion-item is toggled.
+     *
+     * @defaultValue
+     * ```ts
+     * collapseVerticalTransition
+     * ```
+     */
+    itemTransition: TransitionFn;
 }
 export type AccordionWidget = Widget<AccordionProps, AccordionState, AccordionApi, object, AccordionDirectives>;
 export interface AccordionItemState extends CoreItemState, AccordionItemExtraProps {
@@ -47,14 +57,19 @@ export interface AccordionItemProps extends CoreItemProps, AccordionItemExtraPro
 }
 export type AccordionItemWidget = Widget<AccordionItemProps, AccordionItemState, AccordionItemApi, AccordionItemActions, AccordionItemDirectives>;
 /**
- * Create an AccordioItemnWidget with given config props
- * @param config - an optional alert config
- * @returns an AccordionWidget
+ * Create an AccordionItemWidget with given config props
+ * @param config - an optional AccordionItem config
+ * @returns an AccordionItemWidget
  */
-export declare const createAccordionItem: WidgetFactory<import("@agnos-ui/core/services/extendWidget").ExtendWidgetProps<import("@agnos-ui/core/components/accordion").AccordionItemWidget, AccordionItemExtraProps, object>>;
+export declare const createAccordionItem: WidgetFactory<AccordionItemWidget>;
 /**
  * Retrieve a shallow copy of the default accordion config
  * @returns the default accordion config
  */
 export declare function getAccordionDefaultConfig(): AccordionProps;
+/**
+ * Create an AccordionWidget with given config props
+ * @param config - an optional accordion config
+ * @returns an AccordionWidget
+ */
 export declare const createAccordion: WidgetFactory<AccordionWidget>;

package/components/alert/alert.d.ts

@@ -1,6 +1,7 @@
 import type { AlertDirectives, AlertState as CoreState, AlertProps as CoreProps, AlertApi } from '@agnos-ui/core/components/alert';
 import type { SlotContent, Widget, WidgetFactory, WidgetSlotContext } from '@agnos-ui/core/types';
 import type { BSContextualClass } from '../../types';
+import type { TransitionFn } from '@agnos-ui/core/services/transitions/baseTransitions';
 export * from '@agnos-ui/core/components/alert';
 export type AlertContext = WidgetSlotContext<AlertWidget>;
 interface AlertExtraProps {
@@ -14,12 +15,22 @@ interface AlertExtraProps {
     children: SlotContent<AlertContext>;
     /**
      * Type of the alert, following bootstrap types.
+     *
+     * @defaultValue `'primary'`
      */
     type: BSContextualClass;
 }
 export interface AlertState extends CoreState, AlertExtraProps {
 }
 export interface AlertProps extends CoreProps, AlertExtraProps {
+    /**
+     * 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;
 }
 export type AlertWidget = Widget<AlertProps, AlertState, AlertApi, object, AlertDirectives>;
 /**

package/components/modal/modal.d.ts

@@ -1,5 +1,6 @@
 import type { ModalProps as CoreProps, ModalState as CoreState, ModalActions, ModalApi as CoreApi, ModalDirectives } from '@agnos-ui/core/components/modal';
 import type { PropsConfig, SlotContent, Widget, WidgetSlotContext } from '@agnos-ui/core/types';
+import type { TransitionFn } from '@agnos-ui/core/services/transitions/baseTransitions';
 export * from '@agnos-ui/core/components/modal';
 export type ModalContext<Data> = WidgetSlotContext<ModalWidget<Data>>;
 interface ModalExtraProps<Data> {
@@ -16,12 +17,12 @@ interface ModalExtraProps<Data> {
      */
     footer: SlotContent<ModalContext<Data>>;
     /**
-     * Header of the modal. The default header includes {@link ModalCommonPropsAndState.title|title}.
+     * Header of the modal. The default header includes {@link ModalProps.title|title}.
      */
     header: SlotContent<ModalContext<Data>>;
     /**
      * Structure of the modal.
-     * The default structure uses {@link ModalCommonPropsAndState.header|header}, {@link ModalCommonPropsAndState.children|children} and {@link ModalCommonPropsAndState.footer|footer}.
+     * The default structure uses {@link ModalProps.header|header}, {@link ModalProps.children|children} and {@link ModalProps.footer|footer}.
      */
     structure: SlotContent<ModalContext<Data>>;
     /**
@@ -30,12 +31,26 @@ interface ModalExtraProps<Data> {
     title: SlotContent<ModalContext<Data>>;
     /**
      * Option to create a fullscreen modal, according to the bootstrap documentation.
+     *
+     * @defaultValue `false`
      */
     fullscreen: boolean;
 }
 export interface ModalState<Data> extends CoreState, ModalExtraProps<Data> {
 }
 export interface ModalProps<Data> extends CoreProps, ModalExtraProps<Data> {
+    /**
+     * The transition to use for the backdrop behind the modal (if present).
+     *
+     * @defaultValue `fadeTransition`
+     */
+    backdropTransition: TransitionFn;
+    /**
+     * The transition to use for the modal.
+     *
+     * @defaultValue `fadeTransition`
+     */
+    modalTransition: TransitionFn;
 }
 export interface ModalApi<Data> extends Omit<CoreApi, 'patch'> {
     /**

package/components/pagination/pagination.d.ts

@@ -27,35 +27,40 @@ interface PaginationExtraProps {
      * The template to use for the ellipsis slot
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue '…'
+     *
+     * @defaultValue `'…'`
      */
     ellipsisLabel: SlotContent<PaginationContext>;
     /**
      * The template to use for the first slot
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue '«'
+     *
+     * @defaultValue `'«'`
      */
     firstPageLabel: SlotContent<PaginationContext>;
     /**
      * The template to use for the previous slot
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue '‹'
+     *
+     * @defaultValue `'‹'`
      */
     previousPageLabel: SlotContent<PaginationContext>;
     /**
      * The template to use for the next slot
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue '›'
+     *
+     * @defaultValue `'›'`
      */
     nextPageLabel: SlotContent<PaginationContext>;
     /**
      * The template to use for the last slot
      * for I18n, we suggest to use the global configuration
      * override any configuration parameters provided for this
-     * @defaultValue '»'
+     *
+     * @defaultValue `'»'`
      */
     lastPageLabel: SlotContent<PaginationContext>;
     /**
@@ -68,11 +73,12 @@ interface PaginationExtraProps {
      * The template to use for the number slot
      * override any configuration parameters provided for this
      * for I18n, we suggest to use the global configuration
+     * @param displayedPage - The current page number
+     *
      * @defaultValue
      * ```ts
-     * ({displayedPage}) => `${displayedPage}`
+     * ({displayedPage}: PaginationNumberContext) => `${displayedPage}`
      * ```
-     * @param displayedPage - The current page number
      */
     numberLabel: SlotContent<PaginationNumberContext>;
 }

package/components/progressbar/progressbar.d.ts

@@ -14,15 +14,21 @@ interface ProgressbarExtraProps {
     children: SlotContent<ProgressbarContext>;
     /**
      * Height of the progressbar, can be any valid css height value.
+     *
+     * @defaultValue `''`
      */
     height: string;
     /**
      * If `true`, shows a striped progressbar.
+     *
+     * @defaultValue `false`
      */
     striped: boolean;
     /**
      * If `true`, animates a striped progressbar.
      * Takes effect only for browsers supporting CSS3 animations, and if `striped` is `true`.
+     *
+     * @defaultValue `false`
      */
     animated: boolean;
     /**

package/components/rating/rating.d.ts

@@ -4,6 +4,11 @@ export * from '@agnos-ui/core/components/rating';
 interface RatingExtraProps {
     /**
      * The template to override the way each star is displayed.
+     *
+     * @defaultValue
+     * ```ts
+     * ({fill}: StarContext) => String.fromCharCode(fill === 100 ? 9733 : 9734)
+     * ```
      */
     star: SlotContent<StarContext>;
 }
@@ -18,8 +23,8 @@ export type RatingWidget = Widget<RatingProps, RatingState, object, RatingAction
  */
 export declare function getRatingDefaultConfig(): RatingProps;
 /**
- * Create a Progressbar with given config props
- * @param config - an optional progressbar config
- * @returns a ProgressbarWidget
+ * Create a RatingWidget with given config props
+ * @param config - an optional rating config
+ * @returns a RatingWidget
  */
 export declare const createRating: WidgetFactory<RatingWidget>;

package/components/select/select.d.ts

@@ -15,11 +15,21 @@ interface SelectExtraProps<Item> {
     /**
      * The template to override the way each badge on the left of the input is displayed.
      * This define the content of the badge inside the badge container.
+     *
+     * @defaultValue
+     * ```ts
+     * ({itemContext}: SelectItemContext<any>) => itemContext.item
+     * ```
      */
     badgeLabel: SlotContent<SelectItemContext<Item>>;
     /**
      * The template to override the way each item is displayed in the list.
      * This define the content of the badge inside the badge container.
+     *
+     * @defaultValue
+     * ```ts
+     * ({itemContext}: SelectItemContext<any>) => itemContext.item
+     * ```
      */
     itemLabel: SlotContent<SelectItemContext<Item>>;
 }

package/components/slider/slider.d.ts

@@ -15,6 +15,11 @@ interface SliderExtraProps {
     structure: SlotContent<SliderContext>;
     /**
      * Slot to change the default labels of the slider
+     *
+     * @defaultValue
+     * ```ts
+     * ({value}: SliderSlotLabelContext) => '' + value
+     * ```
      */
     label: SlotContent<SliderSlotLabelContext>;
     /**
@@ -34,7 +39,7 @@ export type SliderWidget = Widget<SliderProps, SliderState, SliderApi, SliderAct
 export declare function getSliderDefaultConfig(): SliderProps;
 /**
  * Create a Slider with given config props
- * @param config - an optional progressbar config
+ * @param config - an optional slider config
  * @returns a SliderWidget
  */
 export declare const createSlider: WidgetFactory<SliderWidget>;

package/components/toast/toast.d.ts

@@ -1,5 +1,6 @@
 import type { ToastDirectives, ToastState as CoreState, ToastProps as CoreProps, ToastApi } from '@agnos-ui/core/components/toast';
 import type { SlotContent, Widget, WidgetFactory, WidgetSlotContext } from '@agnos-ui/core/types';
+import type { TransitionFn } from '@agnos-ui/core/services/transitions/baseTransitions';
 export * from '@agnos-ui/core/components/toast';
 export type ToastContext = WidgetSlotContext<ToastWidget>;
 export interface ToastExtraProps {
@@ -19,6 +20,14 @@ export interface ToastExtraProps {
 export interface ToastState extends CoreState, ToastExtraProps {
 }
 export interface ToastProps extends CoreProps, ToastExtraProps {
+    /**
+     * 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;
 }
 export type ToastWidget = Widget<ToastProps, ToastState, ToastApi, object, ToastDirectives>;
 /**

package/css/agnosui.css.map

@@ -1 +1 @@
-{"version":3,"sourceRoot":"","sources":["../../src/scss/_select.scss","../../src/scss/_slider.scss","../../src/scss/_toast.scss","../../src/scss/_variables.scss"],"names":[],"mappings":"AAAA;EACC;;;AAGD;EACC;;;ACeD;EACC;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EAEA;EACA;EACA;EAEA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;;AAEA;EA3EA;EACA;EAEA;EAEA;EACA;EACA;EACA;EAEA;EAEA;EACA;;AAkEA;EA/EA;EACA;EAEA;EAEA;EACA;EACA;EACA;EAEA;EAEA;EACA;;AAsEA;EACC;EACA;EACA;EACA;;AACA;EACC;EACA;;AAIF;EACC;EACA;EACA;EACA;;AACA;EACC;EACA;;AAIF;EACC;EACA;EACA;EACA;EACA;EACA;EACA;;AAEA;EACC;;AAED;EACC;;AAIF;EACC;EACA;EACA;;AAGD;EACC;;AAGD;EACC;EACA;EACA;;AAEA;EACC;;AAGD;EACC;;AAGD;EACC;;AAGD;EACC;;AAGD;EACC;EACA;;AAIF;EACC;EACA;EACA;;AAEA;EACC;EACA;;AAGD;EACC;EACA;;AAGD;EACC;EACA;;AAGD;EACC;EACA;;AAGD;EACC;;AAIF;EACC;EACA;EACA;;AAGD;EACC;EACA;EACA;EACA;;AAGD;EACC;;AACA;AAAA;EAEC;;AAED;AAAA;EAEC;EACA;;;ACvNH;EACC,OCDiB","file":"agnosui.css"}
+{"version":3,"sourceRoot":"","sources":["../../src/scss/_select.scss","../../src/scss/_slider.scss","../../src/scss/_toast.scss","../../src/scss/_variables.scss"],"names":[],"mappings":"AAAA;EACC;;;AAGD;EACC;;;ACeD;EAEC;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EAEA;EACA;EACA;EAEA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EAEA;EACA;EAGA;EACA;EACA;EACA;EACA;EACA;;AAEA;EA7EA;EACA;EAEA;EAEA;EACA;EACA;EACA;EAEA;EAEA;EACA;;AAoEA;EAjFA;EACA;EAEA;EAEA;EACA;EACA;EACA;EAEA;EAEA;EACA;;AAwEA;EACC;EACA;EACA;EACA;;AACA;EACC;EACA;;AAIF;EACC;EACA;EACA;EACA;;AACA;EACC;EACA;;AAIF;EACC;EACA;EACA;EACA;EACA;EACA;EACA;;AAEA;EACC;;AAED;EACC;;AAIF;EACC;EACA;EACA;;AAGD;EACC;;AAGD;EACC;EACA;EACA;;AAEA;EACC;;AAGD;EACC;;AAGD;EACC;;AAGD;EACC;;AAGD;EACC;EACA;;AAIF;EACC;EACA;EACA;;AAEA;EACC;EACA;;AAGD;EACC;EACA;;AAGD;EACC;EACA;;AAGD;EACC;EACA;;AAGD;EACC;;AAIF;EACC;EACA;EACA;;AAGD;EACC;EACA;EACA;EACA;;AAGD;EACC;;AACA;AAAA;EAEC;;AAED;AAAA;EAEC;EACA;;;ACzNH;EACC,OCDiB","file":"agnosui.css"}

package/index.d.ts

@@ -9,3 +9,4 @@ export * from './components/slider';
 export * from './components/toast';
 export * from './services/transitions';
 export * from './config';
+export * from './types';

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@agnos-ui/core-bootstrap",
 	"description": "Styles and widget interface extensions necessary to use AgnosUI with Bootstrap.",
-	"version": "0.4.0-next.1",
+	"version": "0.4.0",
 	"keywords": [
 		"bootstrap",
 		"css",
@@ -59,7 +59,7 @@
 		}
 	},
 	"dependencies": {
-		"@agnos-ui/core": "0.4.0-next.1"
+		"@agnos-ui/core": "0.4.0"
 	},
 	"sideEffects": false,
 	"homepage": "https://amadeusitgroup.github.io/AgnosUI/latest/",

package/scss/_slider.scss

@@ -19,6 +19,7 @@
 }
 
 .au-slider {
+	// scss-docs-start slider-css-vars
 	--#{$prefix}slider-background-color: #{$au-slider-color-background};
 	--#{$prefix}slider-font-size: #{$au-slider-font-size};
 	--#{$prefix}slider-border-radius: #{$au-slider-border-radius};
@@ -69,6 +70,7 @@
 
 	--#{$prefix}slider-disabled-color: #{$au-slider-disabled-color};
 	--#{$prefix}slider-disabled-cursor: #{$au-slider-disabled-cursor};
+	// scss-docs-end slider-css-vars
 
 	display: flex;
 	background-color: var(--#{$prefix}slider-background-color);

package/scss/_variables.scss

@@ -3,7 +3,12 @@ $toast-max-width: unset;
 // this prefix is linked to bootstrap prefix
 $prefix: bs- !default;
 
+$au-focus-ring-opacity: 0.25 !default;
+$au-focus-ring-width: 0.25rem !default;
+$au-focus-ring-color: rgba(#0d6efd, $au-focus-ring-opacity) !default;
+
 //slider variables
+// scss-docs-start slider-vars
 $au-slider-color-background: var(--#{$prefix}secondary-bg, #e9ecef) !default;
 $au-slider-font-size: 1rem !default;
 $au-slider-line-height: 1.5 !default;
@@ -14,9 +19,6 @@ $au-slider-vertical-margin-inline-start: 1rem !default;
 $au-slider-vertical-margin-inline-end: 3rem !default;
 $au-slider-translate-vertical: translateY(-50%) !default;
 $au-slider-translate-horizontal: translateX(-50%) !default;
-$au-focus-ring-opacity: 0.25 !default;
-$au-focus-ring-width: 0.25rem !default;
-$au-focus-ring-color: rgba(#0d6efd, $au-focus-ring-opacity) !default;
 $au-slider-handle-color: var(--#{$prefix}primary, #0d6efd) !default;
 $au-slider-handle-size: 1.25rem !default;
 $au-slider-handle-border: none !default;
@@ -61,3 +63,4 @@ $au-slider-bar-size-lg: 0.3125rem !default;
 $au-slider-handle-size-lg: 1.5rem !default;
 $au-slider-font-size-lg: 1.125rem !default;
 $au-slider-offset-lg: 0rem !default;
+// scss-docs-end slider-vars