@coreui/angular 5.7.26 → 5.7.27

package/fesm2022/coreui-angular.mjs

@@ -118,7 +118,7 @@ class ThemeDirective {
     #renderer = inject(Renderer2);
     /**
      * Sets the dark theme attribute on the host element.
-     * @returns 'dark' | 'light' | undefined
+     * @returns 'dark' | 'light'
      */
     colorScheme = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "colorScheme" }] : /* istanbul ignore next */ []));
@@ -178,7 +178,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
 class AccordionButtonDirective {
     /**
      * Toggles an accordion button collapsed state. Use in accordionHeaderTemplate.
-     * @returns boolean
+     * @returns boolean | undefined
      */
     collapsed = input(undefined, /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "collapsed" }] : /* istanbul ignore next */ []));
@@ -586,7 +586,7 @@ class ButtonDirective {
     ...(ngDevMode ? [undefined, { debugName: "shape" }] : /* istanbul ignore next */ []));
     /**
      * Size the component small or large.
-     * @returns 'sm' | 'lg' | ''
+     * @returns '' | 'sm' | 'lg'
      */
     size = input('', /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "size" }] : /* istanbul ignore next */ []));
@@ -743,8 +743,8 @@ class AlertComponent {
     ...(ngDevMode ? [{ debugName: "role" }] : /* istanbul ignore next */ []));
     /**
      * Set the alert variant to a solid.
-     * @returns string
-     * @default 'solid'
+     * @returns 'solid'
+     * @default undefined
      */
     variant = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "variant" }] : /* istanbul ignore next */ []));
@@ -876,7 +876,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
 class AlignDirective {
     /**
      * Set vertical alignment of inline, inline-block, inline-table, and table cell elements
-     * @returns Alignment
+     * @returns Alignment | undefined
      */
     align = input(undefined, { ...(ngDevMode ? { debugName: "align" } : /* istanbul ignore next */ {}), alias: 'cAlign' });
     hostClasses = computed(() => {
@@ -1215,7 +1215,7 @@ class AvatarComponent {
     /**
      * Size the component small, large, or extra large.
      * @returns Omit<Sizes, 'xxl'>
-     * @default 'md'
+     * @default ''
      */
     size = input('', /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "size" }] : /* istanbul ignore next */ []));
@@ -1897,7 +1897,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
 class CardImgDirective {
     /**
      * Optionally orientate the image to the top, bottom, or make it overlaid across the card.
-     * @returns 'top' | 'bottom' | 'start' | 'end'
+     * @returns 'top' | 'bottom' | 'start' | 'end' | undefined
      */
     orientation = input(undefined, { ...(ngDevMode ? { debugName: "orientation" } : /* istanbul ignore next */ {}), alias: 'cCardImg' });
     hostClasses = computed(() => {
@@ -2658,7 +2658,7 @@ class CarouselControlComponent {
     #carouselService = inject(CarouselService);
     /**
      * Carousel control caption
-     * @returns string
+     * @returns string | undefined
      */
     captionInput = input(undefined, { ...(ngDevMode ? { debugName: "captionInput" } : /* istanbul ignore next */ {}), alias: 'caption' });
     caption = linkedSignal({ ...(ngDevMode ? { debugName: "caption" } : /* istanbul ignore next */ {}), source: this.captionInput,
@@ -2667,7 +2667,7 @@ class CarouselControlComponent {
         } });
     /**
      * Carousel control direction.
-     * @returns 'next' | 'prev'
+     * @returns 'prev' | 'next'
      */
     direction = input('next', /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "direction" }] : /* istanbul ignore next */ []));
@@ -3169,7 +3169,7 @@ class DropdownToggleDirective {
     dropdown = inject(DropdownToken, { optional: true });
     /**
      * Reference to dropdown component.
-     * @returns DropdownComponent | undefined
+     * @returns DropdownComponent
      * @default undefined
      */
     dropdownComponent = input(/* @ts-ignore */
@@ -3556,7 +3556,7 @@ class DropdownItemDirective {
     /**
      * Disables a dropdown-item.
      * @returns boolean
-     * @default undefined
+     * @default false
      */
     disabledInput = input(false, { ...(ngDevMode ? { debugName: "disabledInput" } : /* istanbul ignore next */ {}), transform: booleanAttribute, alias: 'disabled' });
     #disabled = linkedSignal(this.disabledInput, /* @ts-ignore */
@@ -3758,7 +3758,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
 class FooterComponent {
     /**
      * Place footer in non-static positions
-     * @returns Positions
+     * @returns Positions | undefined
      */
     position = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "position" }] : /* istanbul ignore next */ []));
@@ -4079,7 +4079,8 @@ class FormLabelDirective {
     col = input('', { ...(ngDevMode ? { debugName: "col" } : /* istanbul ignore next */ {}), alias: 'cLabel' });
     /**
      * Size the label small or large.
-     * @default ''
+     * @returns '' | 'sm' | 'lg'
+     * @default undefined
      */
     sizing = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "sizing" }] : /* istanbul ignore next */ []));
@@ -4253,7 +4254,8 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
 class ContainerComponent {
     /**
      * Set container 100% wide until a breakpoint.
-     * @returns 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
+     * @returns Exclude<Breakpoints, 'xs'>
+     * @values 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
      * @default ''
      */
     breakpoint = input('', /* @ts-ignore */
@@ -4920,7 +4922,7 @@ class ListGroupItemDirective {
     active = input(false, { ...(ngDevMode ? { debugName: "active" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
     /**
      * Sets the color context of the component to one of CoreUI’s themed colors.
-     * @returns Colors
+     * @returns Colors | undefined
      */
     color = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "color" }] : /* istanbul ignore next */ []));
@@ -5179,13 +5181,13 @@ class NavGroupComponent {
     ...(ngDevMode ? [undefined, { debugName: "toggler" }] : /* istanbul ignore next */ []));
     /**
      * Template for the group toggler content, receives the visible state as `$implicit`.
-     * @returns TemplateRef
+     * @returns TemplateRef<{ $implicit: boolean; visible: boolean }>
      */
     togglerTemplate = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "togglerTemplate" }] : /* istanbul ignore next */ []));
     /**
      * Show nav group items. Sets the initial state, and follows every later change.
-     * @returns boolean
+     * @returns boolean | undefined
      */
     visible = input(undefined, { ...(ngDevMode ? { debugName: "visible" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
     /**
@@ -5265,7 +5267,7 @@ class NavItemComponent {
     static ngAcceptInputType_tabindex;
     /**
      * Toggle the active state for the nav link rendered for `href`.
-     * @returns boolean
+     * @returns boolean | undefined
      * @default undefined
      */
     active = input(undefined, { ...(ngDevMode ? { debugName: "active" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
@@ -5553,7 +5555,7 @@ class NavbarTogglerDirective {
     }
     /**
      * Reference to navbar collapse element (via # template variable)
-     * @returns CollapseDirective
+     * @returns CollapseDirective | undefined
      */
     collapseRef = input(undefined, { ...(ngDevMode ? { debugName: "collapseRef" } : /* istanbul ignore next */ {}), alias: 'cNavbarToggler' });
     /**
@@ -5859,7 +5861,7 @@ class ModalComponent {
     /**
      * Set aria-modal html attr for modal
      * @returns boolean
-     * @default null
+     * @default false
      */
     ariaModalInput = input(false, { ...(ngDevMode ? { debugName: "ariaModalInput" } : /* istanbul ignore next */ {}), transform: booleanAttribute, alias: 'ariaModal' });
     ariaModal = computed(() => {
@@ -6220,7 +6222,7 @@ class OffcanvasComponent {
     portal = input(false, { ...(ngDevMode ? { debugName: "portal" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
     /**
      * Responsive offcanvas property hides content outside the viewport from a specified breakpoint and down.
-     * @returns boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl';
+     * @returns (boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl') | undefined
      * @default true
      * @since 4.3.10
      */
@@ -6836,7 +6838,7 @@ class PopoverComponent {
     renderer = inject(Renderer2);
     /**
      * Content of popover
-     * @returns {string | TemplateRef}
+     * @returns string | TemplateRef<any>
      */
     content = input('', /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "content" }] : /* istanbul ignore next */ []));
@@ -6925,7 +6927,7 @@ class PopoverDirective {
     #timerId2;
     /**
      * Content of popover
-     * @returns {string | TemplateRef}
+     * @returns string | TemplateRef<any> | undefined
      */
     content = input(undefined, { ...(ngDevMode ? { debugName: "content" } : /* istanbul ignore next */ {}), alias: 'cPopover' });
     #contentEffect = effect(() => {
@@ -6953,21 +6955,22 @@ class PopoverDirective {
     ...(ngDevMode ? [{ debugName: "popperOptionsComputed" }] : /* istanbul ignore next */ []));
     /**
      * Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property.
-     * @return: 'top' | 'bottom' | 'left' | 'right'
-     * @default: 'top'
+     * @returns 'top' | 'bottom' | 'left' | 'right'
+     * @default 'top'
      */
     placement = input('top', { ...(ngDevMode ? { debugName: "placement" } : /* istanbul ignore next */ {}), alias: 'cPopoverPlacement' });
     /**
      * ElementRefDirective for positioning the tooltip on reference element
-     * @return: ElementRefDirective
-     * @default: undefined
+     * @returns ElementRefDirective | undefined
+     * @default undefined
+     * @since 5.7.27
      */
-    reference = input(undefined, { ...(ngDevMode ? { debugName: "reference" } : /* istanbul ignore next */ {}), alias: 'cTooltipRef' });
+    reference = input(undefined, { ...(ngDevMode ? { debugName: "reference" } : /* istanbul ignore next */ {}), alias: 'cPopoverRef' });
     referenceRef = computed(() => this.reference()?.elementRef ?? this.#hostElement, /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "referenceRef" }] : /* istanbul ignore next */ []));
     /**
      * Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.
-     * @return: Triggers | Triggers[]
+     * @returns Triggers | Triggers[]
      */
     trigger = input('hover', { ...(ngDevMode ? { debugName: "trigger" } : /* istanbul ignore next */ {}), alias: 'cPopoverTrigger' });
     /**
@@ -7128,7 +7131,7 @@ class PopoverDirective {
         this.#changeDetectorRef.markForCheck();
     }
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: PopoverDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive });
-    static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "17.1.0", version: "22.1.5", type: PopoverDirective, isStandalone: true, selector: "[cPopover]", inputs: { content: { classPropertyName: "content", publicName: "cPopover", isSignal: true, isRequired: false, transformFunction: null }, popperOptions: { classPropertyName: "popperOptions", publicName: "cPopoverOptions", isSignal: true, isRequired: false, transformFunction: null }, placement: { classPropertyName: "placement", publicName: "cPopoverPlacement", isSignal: true, isRequired: false, transformFunction: null }, reference: { classPropertyName: "reference", publicName: "cTooltipRef", isSignal: true, isRequired: false, transformFunction: null }, trigger: { classPropertyName: "trigger", publicName: "cPopoverTrigger", isSignal: true, isRequired: false, transformFunction: null }, visible: { classPropertyName: "visible", publicName: "cPopoverVisible", isSignal: true, isRequired: false, transformFunction: null } }, outputs: { visible: "cPopoverVisibleChange" }, host: { properties: { "aria-describedby": "ariaDescribedBy" } }, providers: [ListenersService, IntersectionService], exportAs: ["cPopover"], ngImport: i0 });
+    static ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "17.1.0", version: "22.1.5", type: PopoverDirective, isStandalone: true, selector: "[cPopover]", inputs: { content: { classPropertyName: "content", publicName: "cPopover", isSignal: true, isRequired: false, transformFunction: null }, popperOptions: { classPropertyName: "popperOptions", publicName: "cPopoverOptions", isSignal: true, isRequired: false, transformFunction: null }, placement: { classPropertyName: "placement", publicName: "cPopoverPlacement", isSignal: true, isRequired: false, transformFunction: null }, reference: { classPropertyName: "reference", publicName: "cPopoverRef", isSignal: true, isRequired: false, transformFunction: null }, trigger: { classPropertyName: "trigger", publicName: "cPopoverTrigger", isSignal: true, isRequired: false, transformFunction: null }, visible: { classPropertyName: "visible", publicName: "cPopoverVisible", isSignal: true, isRequired: false, transformFunction: null } }, outputs: { visible: "cPopoverVisibleChange" }, host: { properties: { "aria-describedby": "ariaDescribedBy" } }, providers: [ListenersService, IntersectionService], exportAs: ["cPopover"], ngImport: i0 });
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: PopoverDirective, decorators: [{
             type: Directive,
@@ -7138,7 +7141,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
                     providers: [ListenersService, IntersectionService],
                     host: { '[aria-describedby]': 'ariaDescribedBy' }
                 }]
-        }], propDecorators: { content: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopover", required: false }] }], popperOptions: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverOptions", required: false }] }], placement: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverPlacement", required: false }] }], reference: [{ type: i0.Input, args: [{ isSignal: true, alias: "cTooltipRef", required: false }] }], trigger: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverTrigger", required: false }] }], visible: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverVisible", required: false }] }, { type: i0.Output, args: ["cPopoverVisibleChange"] }] } });
+        }], propDecorators: { content: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopover", required: false }] }], popperOptions: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverOptions", required: false }] }], placement: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverPlacement", required: false }] }], reference: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverRef", required: false }] }], trigger: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverTrigger", required: false }] }], visible: [{ type: i0.Input, args: [{ isSignal: true, alias: "cPopoverVisible", required: false }] }, { type: i0.Output, args: ["cPopoverVisibleChange"] }] } });
 
 class PopoverModule {
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: PopoverModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -7220,7 +7223,7 @@ class ProgressBarDirective {
     animated = input(undefined, { ...(ngDevMode ? { debugName: "animated" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
     /**
      * Sets the color context of the component to one of CoreUI’s themed colors.
-     * @values 'primary', 'secondary', 'success', 'danger', 'warning', 'info', 'dark', 'light'
+     * @returns Colors
      */
     color = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "color" }] : /* istanbul ignore next */ []));
@@ -8579,7 +8582,7 @@ class SidebarNavComponent {
     #sidebarService = inject(SidebarService);
     /**
      * Configuration object for sidebar-nav.
-     * @returns INavData[]
+     * @returns INavData[] | undefined
      * @default []
      */
     navItems = input([], /* @ts-ignore */
@@ -8742,8 +8745,7 @@ class SpinnerComponent {
     ...(ngDevMode ? [{ debugName: "label" }] : /* istanbul ignore next */ []));
     /**
      * Size the component small.
-     * @returns string
-     * @values 'sm'
+     * @returns 'sm'
      */
     size = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "size" }] : /* istanbul ignore next */ []));
@@ -8803,7 +8805,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImpor
 class TableColorDirective {
     /**
      * Use contextual color for tables, table rows or individual cells.
-     * @returns Colors
+     * @returns Colors | undefined
      */
     color = input(undefined, { ...(ngDevMode ? { debugName: "color" } : /* istanbul ignore next */ {}), alias: 'cTableColor' });
     hostClasses = computed(() => {
@@ -8858,8 +8860,7 @@ class TableDirective {
     #hostElement = inject(ElementRef);
     /**
      * Set the vertical alignment.
-     * @returns string
-     * @values 'bottom' | 'middle' | 'top'
+     * @returns 'bottom' | 'middle' | 'top'
      */
     align = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "align" }] : /* istanbul ignore next */ []));
@@ -8899,7 +8900,8 @@ class TableDirective {
     hover = input(false, { ...(ngDevMode ? { debugName: "hover" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
     /**
      * Make table responsive across all viewports or pick a maximum breakpoint with which to have a responsive table up to.
-     * @values: {boolean | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'}
+     * @returns boolean | Omit<Breakpoints, 'xs'>
+     * @values true | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
      */
     responsive = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "responsive" }] : /* istanbul ignore next */ []));
@@ -9636,7 +9638,7 @@ class TabPanelComponent {
     #elementRef = inject(ElementRef);
     /**
      * aria-labelledby attribute
-     * @returns string
+     * @returns string | undefined
      * @default undefined
      */
     ariaLabelledBy = input(undefined, { ...(ngDevMode ? { debugName: "ariaLabelledBy" } : /* istanbul ignore next */ {}), alias: 'aria-labelledby' });
@@ -10089,7 +10091,7 @@ class ToasterComponent {
     }
     /**
      * Toaster position
-     * @returns (string | 'absolute' | 'fixed' | 'static')
+     * @returns string | 'absolute' | 'fixed' | 'static'
      */
     position = input('absolute', /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "position" }] : /* istanbul ignore next */ []));
@@ -10229,7 +10231,7 @@ class TooltipComponent {
     renderer = inject(Renderer2);
     /**
      * Content of tooltip
-     * @returns {string | TemplateRef}
+     * @returns string | TemplateRef<any>
      */
     content = input('', /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "content" }] : /* istanbul ignore next */ []));
@@ -10315,7 +10317,7 @@ class TooltipDirective {
     #timerId2;
     /**
      * Content of tooltip
-     * @returns {string | TemplateRef}
+     * @returns string | TemplateRef<any> | undefined
      */
     content = input(undefined, { ...(ngDevMode ? { debugName: "content" } : /* istanbul ignore next */ {}), alias: 'cTooltip' });
     #contentEffect = effect(() => {
@@ -10343,21 +10345,22 @@ class TooltipDirective {
     ...(ngDevMode ? [{ debugName: "popperOptionsComputed" }] : /* istanbul ignore next */ []));
     /**
      * Describes the placement of your component after Popper.js has applied all the modifiers that may have flipped or altered the originally provided placement property.
-     * @return: 'top' | 'bottom' | 'left' | 'right'
-     * @default: 'top'
+     * @returns 'top' | 'bottom' | 'left' | 'right'
+     * @default 'top'
      */
     placement = input('top', { ...(ngDevMode ? { debugName: "placement" } : /* istanbul ignore next */ {}), alias: 'cTooltipPlacement' });
     /**
      * ElementRefDirective for positioning the tooltip on reference element
-     * @return: ElementRefDirective
-     * @default: undefined
+     * @returns ElementRefDirective | undefined
+     * @default undefined
+     * @since 5.1.0
      */
     reference = input(undefined, { ...(ngDevMode ? { debugName: "reference" } : /* istanbul ignore next */ {}), alias: 'cTooltipRef' });
     referenceRef = computed(() => this.reference()?.elementRef ?? this.#hostElement, /* @ts-ignore */
     ...(ngDevMode ? [{ debugName: "referenceRef" }] : /* istanbul ignore next */ []));
     /**
      * Sets which event handlers you’d like provided to your toggle prop. You can specify one trigger or an array of them.
-     * @return: 'Triggers | Triggers[]
+     * @returns Triggers | Triggers[]
      */
     trigger = input('hover', { ...(ngDevMode ? { debugName: "trigger" } : /* istanbul ignore next */ {}), alias: 'cTooltipTrigger' });
     /**
@@ -10739,7 +10742,7 @@ class WidgetStatDComponent extends CardComponent {
     // override readonly color = input<Colors>();
     /**
      * Values and subtitles for your component.
-     * @returns WidgetStatDValue
+     * @returns WidgetStatDValue[]
      */
     values = input(/* @ts-ignore */
     ...(ngDevMode ? [undefined, { debugName: "values" }] : /* istanbul ignore next */ []));