@decaf-ts/for-angular 0.0.44 → 0.0.45

package/index.d.ts

@@ -1523,6 +1523,15 @@ declare abstract class NgxComponentDirective extends LoggedClass implements OnCh
      * @memberOf module:lib/engine/NgxComponentDirective
      */
     initialized: boolean;
+    /**
+     * @description Controls whether borders are displayed around the component.
+     * @summary Boolean flag that determines if the component should be visually outlined with borders.
+     * When true, borders are shown to visually separate the component from surrounding content.
+     *
+     * @type {boolean}
+     * @default false
+     */
+    borders: boolean;
     /**
      * @description Component name identifier for logging and localization contexts.
      * @summary Stores the component's name which is used as a key for logging contexts
@@ -1836,7 +1845,7 @@ declare abstract class NgxComponentDirective extends LoggedClass implements OnCh
      */
     changeOperation(operation: string, id?: string): Promise<boolean>;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxComponentDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxComponentDirective, never, never, { "enableDarkMode": { "alias": "enableDarkMode"; "required": false; }; "isDarkMode": { "alias": "isDarkMode"; "required": false; }; "name": { "alias": "name"; "required": false; }; "childOf": { "alias": "childOf"; "required": false; }; "uid": { "alias": "uid"; "required": false; }; "model": { "alias": "model"; "required": false; }; "modelId": { "alias": "modelId"; "required": false; }; "pk": { "alias": "pk"; "required": false; }; "mapper": { "alias": "mapper"; "required": false; }; "operations": { "alias": "operations"; "required": false; }; "operation": { "alias": "operation"; "required": false; }; "row": { "alias": "row"; "required": false; }; "col": { "alias": "col"; "required": false; }; "className": { "alias": "className"; "required": false; }; "locale": { "alias": "locale"; "required": false; }; "item": { "alias": "item"; "required": false; }; "props": { "alias": "props"; "required": false; }; "route": { "alias": "route"; "required": false; }; "isModalChild": { "alias": "isModalChild"; "required": false; }; }, { "listenEvent": "listenEvent"; }, never, never, true, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxComponentDirective, never, never, { "enableDarkMode": { "alias": "enableDarkMode"; "required": false; }; "isDarkMode": { "alias": "isDarkMode"; "required": false; }; "name": { "alias": "name"; "required": false; }; "childOf": { "alias": "childOf"; "required": false; }; "uid": { "alias": "uid"; "required": false; }; "model": { "alias": "model"; "required": false; }; "modelId": { "alias": "modelId"; "required": false; }; "pk": { "alias": "pk"; "required": false; }; "mapper": { "alias": "mapper"; "required": false; }; "operations": { "alias": "operations"; "required": false; }; "operation": { "alias": "operation"; "required": false; }; "row": { "alias": "row"; "required": false; }; "col": { "alias": "col"; "required": false; }; "className": { "alias": "className"; "required": false; }; "locale": { "alias": "locale"; "required": false; }; "item": { "alias": "item"; "required": false; }; "props": { "alias": "props"; "required": false; }; "route": { "alias": "route"; "required": false; }; "borders": { "alias": "borders"; "required": false; }; "isModalChild": { "alias": "isModalChild"; "required": false; }; }, { "listenEvent": "listenEvent"; }, never, never, true, never>;
 }
 
 declare class NgxRenderableComponentDirective extends NgxComponentDirective implements OnChanges, OnDestroy, IRenderedModel {
@@ -3085,15 +3094,6 @@ declare class NgxParentComponentDirective extends NgxComponentDirective implemen
      * @default 'clear'
      */
     cardType: 'clear' | 'shadow';
-    /**
-     * @description Controls whether borders are displayed around the fieldset.
-     * @summary Boolean flag that determines if the fieldset should be visually outlined with borders.
-     * When true, borders are shown to visually separate the fieldset from surrounding content.
-     *
-     * @type {boolean}
-     * @default true
-     */
-    borders: boolean;
     /**
      * @description Media breakpoint for responsive behavior.
      * @summary Determines the responsive breakpoint at which the layout should adapt.
@@ -3138,7 +3138,7 @@ declare class NgxParentComponentDirective extends NgxComponentDirective implemen
     ngOnDestroy(): Promise<void> | void;
     protected getActivePage(page: number): UIModelMetadata | UIModelMetadata[] | FieldDefinition | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<NgxParentComponentDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxParentComponentDirective, never, never, { "page": { "alias": "page"; "required": false; }; "pages": { "alias": "pages"; "required": false; }; "parentForm": { "alias": "parentForm"; "required": false; }; "children": { "alias": "children"; "required": false; }; "cols": { "alias": "cols"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "cardBody": { "alias": "cardBody"; "required": false; }; "cardType": { "alias": "cardType"; "required": false; }; "borders": { "alias": "borders"; "required": false; }; "breakpoint": { "alias": "breakpoint"; "required": false; }; "match": { "alias": "match"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxParentComponentDirective, never, never, { "page": { "alias": "page"; "required": false; }; "pages": { "alias": "pages"; "required": false; }; "parentForm": { "alias": "parentForm"; "required": false; }; "children": { "alias": "children"; "required": false; }; "cols": { "alias": "cols"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "cardBody": { "alias": "cardBody"; "required": false; }; "cardType": { "alias": "cardType"; "required": false; }; "breakpoint": { "alias": "breakpoint"; "required": false; }; "match": { "alias": "match"; "required": false; }; }, {}, never, never, true, never>;
 }
 
 declare abstract class NgxFormDirective extends NgxParentComponentDirective implements OnInit, AfterViewInit, IFormElement, OnDestroy, IRenderedModel {
@@ -3372,17 +3372,137 @@ declare class CrudFormComponent extends NgxFormDirective {
     static ɵcmp: i0.ɵɵComponentDeclaration<CrudFormComponent, "ngx-decaf-crud-form", never, {}, {}, never, ["*", "*"], true, never>;
 }
 
+/**
+ * @module lib.components.card
+ * @description Reusable Card UI component module.
+ * @summary
+ * Exports the `CardComponent`, a standalone Angular component built on Ionic's `IonCard` primitives.
+ * The component exposes inputs to control visual style, content and layout and integrates with
+ * the application's media service to react to dark-mode changes. See {@link CardComponent}.
+ */
+
+/**
+ * @description Reusable, presentational card UI component for use across the application.
+ * @summary
+ * CardComponent is a standalone Angular component built on Ionic's `IonCard` primitives.
+ * It exposes several `@Input()` properties to control appearance and content:
+ * `type`, `title`, `body`, `subtitle`, `color`, `separator`, `borders`, `inlineContent`, and `inlineContentPosition`.
+ * The component integrates with the application's media service to react to dark-mode changes
+ * and toggles the dark-palette CSS class on the host element accordingly.
+ *
+ * @param {('clear'|'shadow')} type - Visual rendering style for the card; 'clear' (default) or 'shadow'.
+ * @param {string} title - Primary title text displayed in the card header.
+ * @param {('small'|'default'|'blank')} body - Body size preset controlling padding/typography; defaults to 'default'.
+ * @param {string} subtitle - Optional subtitle rendered under the title.
+ * @param {import('@ionic/core').Color} color - Ionic color token applied to the card header/title.
+ * @param {boolean} separator - When true, renders a divider between header and body.
+ * @param {boolean} borders - Controls whether borders are rendered; defaults to true.
+ * @param {string|import('@angular/platform-browser').SafeHtml} inlineContent - Inline HTML/SafeHtml to render inside the body.
+ * @param {('top'|'bottom')} inlineContentPosition - Where to render `inlineContent` relative to the body; defaults to 'bottom'.
+ * @return {void}
+ * @class CardComponent
+ * @example
+ * <ngx-decaf-card
+ *   [type]="'shadow'"
+ *   [title]="'Account overview'"
+ *   [subtitle]="'Summary for the current user'"
+ *   [color]="'primary'"
+ *   [separator]="true"
+ *   [borders]="true"
+ *   [inlineContent]="safeHtmlValue"
+ *   inlineContentPosition="top"
+ * >
+ *   <!-- card content here -->
+ * </ngx-decaf-card>
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant App as Consumer
+ *   participant Card as CardComponent
+ *   participant Media as MediaService
+ *   App->>Card: instantiate
+ *   Card->>Media: isDarkMode()
+ *   Media-->>Card: Observable<boolean> (isDark)
+ *   Card->>Card: toggleClass(..., isDark)
+ */
 declare class CardComponent extends NgxComponentDirective implements OnInit {
+    /**
+     * @description Visual rendering style for the card.
+     * @summary Controls the card's surface treatment. Use 'clear' for a flat look or 'shadow' to add elevation.
+     * @type {'clear'|'shadow'}
+     * @default 'clear'
+     */
     type: 'clear' | 'shadow';
+    /**
+     * @description Primary title text for the card header.
+     * @summary Rendered prominently at the top of the card; consumers should pass a short, human-friendly string.
+     * @type {string}
+     * @default ''
+     */
     title: string;
+    /**
+     * @description Body size preset for the card.
+     * @summary Adjusts padding and typographic scale inside the card body. 'small' reduces spacing, 'blank' hides the body area.
+     * @type {'small'|'default'|'blank'}
+     * @default 'default'
+     */
     body: 'small' | 'default' | 'blank';
+    /**
+     * @description Optional subtitle shown below the title in the header area.
+     * @summary Use for short secondary text such as an explanation or contextual note.
+     * @type {string}
+     * @default ''
+     */
     subtitle: string;
+    /**
+     * @description Ionic color token applied to the card.
+     * @summary When provided, the color token (for example 'primary' or 'tertiary') is applied to title/header elements where supported.
+     * @type {import('@ionic/core').Color}
+     * @default ''
+     */
     color: Color;
+    /**
+     * @description Toggle to render a visual separator between header and content.
+     * @summary When true, a divider line (or equivalent styling) is rendered to separate the header from the body.
+     * @type {boolean}
+     * @default false
+     */
     separator: boolean;
+    /**
+     * @description Controls whether the card renders borders.
+     * @summary Set to false to remove borders for inline or transparent card designs. Marked `override` to explicitly shadow the base directive's value.
+     * @type {boolean}
+     * @default true
+     */
     borders: boolean;
+    /**
+     * @description Inline HTML or SafeHtml content to render inside the card body.
+     * @summary Useful for short snippets of rich content provided by the consumer. When passing raw HTML prefer `SafeHtml` to avoid sanitization issues.
+     * @type {string|import('@angular/platform-browser').SafeHtml}
+     */
     inlineContent?: string | SafeHtml;
+    /**
+     * @description Position where `inlineContent` is rendered within the body.
+     * @summary Pass 'top' to render inline content above the body or 'bottom' to render it below. Defaults to 'bottom'.
+     * @type {'top'|'bottom'}
+     */
     inlineContentPosition: 'top' | 'bottom';
+    /**
+     * @description Internal component identifier used by the base `NgxComponentDirective`.
+     * @summary Read-only-ish string identifying the concrete component class for instrumentation, styling helpers and debug logs.
+     * @type {string}
+     */
     protected componentName: string;
+    /**
+     * @description Angular lifecycle hook: component initialization.
+     * @summary
+     * ngOnInit sets the component as initialized and subscribes to the application's media service
+     * dark-mode observable. On each emission it updates the local isDarkMode flag and calls the
+     * media service helper to toggle the dark-palette CSS class on the component host element.
+     * The subscription uses the provided mediaService observable and performs side effects only.
+     *
+     * @return {void}
+     */
     ngOnInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CardComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CardComponent, "ngx-decaf-card", never, { "type": { "alias": "type"; "required": false; }; "title": { "alias": "title"; "required": false; }; "body": { "alias": "body"; "required": false; }; "subtitle": { "alias": "subtitle"; "required": false; }; "color": { "alias": "color"; "required": false; }; "separator": { "alias": "separator"; "required": false; }; "borders": { "alias": "borders"; "required": false; }; "inlineContent": { "alias": "inlineContent"; "required": false; }; "inlineContentPosition": { "alias": "inlineContentPosition"; "required": false; }; }, {}, never, ["*"], true, never>;
@@ -4257,6 +4377,7 @@ declare class FilterComponent extends NgxComponentDirective implements OnInit, O
      * @memberOf FilterComponent
      */
     indexes: string[];
+    multiple: boolean;
     /**
      * @description Available comparison conditions for filters.
      * @summary Defines the list of comparison operators that can be used when creating filters.
@@ -4609,7 +4730,7 @@ declare class FilterComponent extends NgxComponentDirective implements OnInit, O
      * @returns {void}
      * @memberOf FilterComponent
      */
-    reset(): void;
+    reset(submit?: boolean): void;
     /**
      * @description Clears all filters and notifies parent components.
      * @summary Resets the component state and emits undefined to notify parent components
@@ -4691,7 +4812,7 @@ declare class FilterComponent extends NgxComponentDirective implements OnInit, O
      */
     handleSearch(value: string | undefined): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<FilterComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FilterComponent, "ngx-decaf-filter", never, { "indexes": { "alias": "indexes"; "required": false; }; "conditions": { "alias": "conditions"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; }, { "filterEvent": "filterEvent"; "searchEvent": "searchEvent"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FilterComponent, "ngx-decaf-filter", never, { "indexes": { "alias": "indexes"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "conditions": { "alias": "conditions"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; }, { "filterEvent": "filterEvent"; "searchEvent": "searchEvent"; }, never, never, true, never>;
 }
 
 /**
@@ -4931,11 +5052,11 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * users to filter the list items. The search functionality works by filtering the
      * existing data or by triggering a new data fetch with search parameters.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default true
      * @memberOf ListComponent
      */
-    showSearchbar: StringOrBoolean;
+    showSearchbar: boolean;
     /**
      * @description Direct data input for the list component.
      * @summary Provides a way to directly pass data to the list component instead of
@@ -4985,11 +5106,11 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * through infinite scrolling or pagination. When false, the component will not
      * attempt to load more data beyond what is initially displayed.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default true
      * @memberOf ListComponent
      */
-    loadMoreData: StringOrBoolean;
+    loadMoreData: boolean;
     /**
      * @description The style of dividing lines between list items.
      * @summary Determines how dividing lines appear between list items. Options include:
@@ -5007,11 +5128,11 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * @summary When set to true, the list will have inset styling with rounded corners
      * and margin around the edges. This creates a card-like appearance for the list.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default false
      * @memberOf ListComponent
      */
-    inset: StringOrBoolean;
+    inset: boolean;
     /**
      * @description The threshold for triggering infinite scroll loading.
      * @summary Specifies how close to the bottom of the list the user must scroll
@@ -5047,11 +5168,20 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * @summary When set to true, enables the pull-to-refresh functionality that allows
      * users to refresh the list data by pulling down from the top of the list.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default true
      * @memberOf ListComponent
      */
-    showRefresher: StringOrBoolean;
+    showRefresher: boolean;
+    /**
+     * @description Controls the visibility of the create button.
+     * @summary When set to true, displays a button to create new items in the list.
+     *
+     * @type {boolean}
+     * @default false
+     * @memberOf ListComponent
+     */
+    createButton: boolean;
     /**
      * @description The type of spinner to display during loading operations.
      * @summary Specifies the visual style of the loading spinner shown during data
@@ -5068,11 +5198,11 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * complex search criteria with multiple field filters, conditions, and values.
      * When false, disables the filter interface entirely.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default true
      * @memberOf ListComponent
      */
-    enableFilter: StringOrBoolean;
+    enableFilter: boolean;
     /**
      * @description Sorting parameters for data fetching.
      * @summary Specifies how the fetched data should be sorted. This can be provided
@@ -5097,27 +5227,27 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
      * changing the sort order or field. The list will maintain its default or
      * programmatically set sort configuration without user interaction.
      *
-     * @type {StringOrBoolean}
+     * @type {boolean}
      * @default false
      * @memberOf ListComponent
      */
-    disableSort: StringOrBoolean;
+    disableSort: boolean;
     /**
-   * @description Configuration for the empty state display.
-   * @summary Customizes how the empty state is displayed when no data is available.
-   * This includes the title, subtitle, button text, icon, and navigation link.
-   *
-   * @type {Partial<IListEmptyOptions>}
-   * @default {
-   *   title: 'empty.title',
-   *   subtitle: 'empty.subtitle',
-   *   showButton: false,
-   *   icon: 'alert-circle-outline',
-   *   buttonText: 'locale.empty.button',
-   *   link: ''
-   * }
-   * @memberOf ListComponent
-   */
+     * @description Configuration for the empty state display.
+     * @summary Customizes how the empty state is displayed when no data is available.
+     * This includes the title, subtitle, button text, icon, and navigation link.
+     *
+     * @type {Partial<IListEmptyOptions>}
+     * @default {
+     *   title: 'empty.title',
+     *   subtitle: 'empty.subtitle',
+     *   showButton: false,
+     *   icon: 'alert-circle-outline',
+     *   buttonText: 'locale.empty.button',
+     *   link: ''
+     * }
+     * @memberOf ListComponent
+     */
     empty: Partial<IListEmptyOptions>;
     /**
      * @description The current page number in paginated mode.
@@ -5661,7 +5791,7 @@ declare class ListComponent extends NgxComponentDirective implements OnInit, OnD
     mapResults(data: KeyValue[]): KeyValue[];
     parseSearchValue(): string | IFilterQuery;
     static ɵfac: i0.ɵɵFactoryDeclaration<ListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ListComponent, "ngx-decaf-list", never, { "type": { "alias": "type"; "required": false; }; "showSearchbar": { "alias": "showSearchbar"; "required": false; }; "data": { "alias": "data"; "required": false; }; "source": { "alias": "source"; "required": false; }; "start": { "alias": "start"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "loadMoreData": { "alias": "loadMoreData"; "required": false; }; "lines": { "alias": "lines"; "required": false; }; "inset": { "alias": "inset"; "required": false; }; "scrollThreshold": { "alias": "scrollThreshold"; "required": false; }; "scrollPosition": { "alias": "scrollPosition"; "required": false; }; "loadingText": { "alias": "loadingText"; "required": false; }; "showRefresher": { "alias": "showRefresher"; "required": false; }; "loadingSpinner": { "alias": "loadingSpinner"; "required": false; }; "enableFilter": { "alias": "enableFilter"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; "empty": { "alias": "empty"; "required": false; }; }, { "refreshEvent": "refreshEvent"; "clickEvent": "clickEvent"; }, never, ["*"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ListComponent, "ngx-decaf-list", never, { "type": { "alias": "type"; "required": false; }; "showSearchbar": { "alias": "showSearchbar"; "required": false; }; "data": { "alias": "data"; "required": false; }; "source": { "alias": "source"; "required": false; }; "start": { "alias": "start"; "required": false; }; "limit": { "alias": "limit"; "required": false; }; "loadMoreData": { "alias": "loadMoreData"; "required": false; }; "lines": { "alias": "lines"; "required": false; }; "inset": { "alias": "inset"; "required": false; }; "scrollThreshold": { "alias": "scrollThreshold"; "required": false; }; "scrollPosition": { "alias": "scrollPosition"; "required": false; }; "loadingText": { "alias": "loadingText"; "required": false; }; "showRefresher": { "alias": "showRefresher"; "required": false; }; "createButton": { "alias": "createButton"; "required": false; }; "loadingSpinner": { "alias": "loadingSpinner"; "required": false; }; "enableFilter": { "alias": "enableFilter"; "required": false; }; "sortDirection": { "alias": "sortDirection"; "required": false; }; "sortBy": { "alias": "sortBy"; "required": false; }; "disableSort": { "alias": "disableSort"; "required": false; }; "empty": { "alias": "empty"; "required": false; }; }, { "refreshEvent": "refreshEvent"; "clickEvent": "clickEvent"; }, never, ["*"], true, never>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decaf-ts/for-angular",
-  "version": "0.0.44",
+  "version": "0.0.45",
   "author": "Tiago Venceslau and Contributors",
   "license": "MPL-2.0 OR AGPL-3.0",
   "repository": {