@agorapulse/ui-components 18.0.9 → 18.0.11

package/nav-selector/utils/nav-selector.builder.d.ts

@@ -0,0 +1,32 @@
+import { InternalNavSelectorEntry, NavSelectorEntry } from '../nav-selector';
+/**
+ * NavSelectorBuilder is a utility class that builds the NavSelector entries for single and multiple select modes.
+ * It also checks the structure of the entries to ensure they are valid.
+ */
+export declare class NavSelectorBuilder {
+    private static LEAF_LOGICS_PRIORITY;
+    /**
+     * Builds the NavSelector entries for single select mode.
+     * @param entries nav selector entries
+     * @param selectedEntryUid selected entry uid
+     * @param detailsDisplayedLimit number of details displayed limit
+     */
+    static build(entries: NavSelectorEntry[], selectedEntryUid: string | null, detailsDisplayedLimit: number): InternalNavSelectorEntry[];
+    /**
+     * Builds the NavSelector entries for multiple select mode.
+     * @param entries nav selector entries
+     * @param selectedEntryUids selected entry uids
+     * @param detailsDisplayedLimit number of details displayed limit
+     */
+    static buildInMultipleMode(entries: NavSelectorEntry[], selectedEntryUids: string[] | null, detailsDisplayedLimit: number): InternalNavSelectorEntry[];
+    private static structureChecker;
+    private static buildEntries;
+    private static buildEntry;
+    private static buildCategoryChildren;
+    private static buildCategory;
+    private static buildGroupChildren;
+    private static buildGroup;
+    private static buildLeaf;
+    private static buildLeafDetail;
+    private static isLeafLogicValid;
+}

package/nav-selector/utils/nav-selector.filter.d.ts

@@ -0,0 +1,30 @@
+import { InternalNavSelectorEntry } from '../nav-selector';
+/**
+ * NavSelectorFilter is a utility class that provides methods to filter entries
+ */
+export declare class NavSelectorFilter {
+    /**
+     * Filters the entries based on the search string
+     *
+     * The search string is normalized and lowercase and trimmed.
+     *
+     * If a category matches the search string, all its children are unfolded, marked as focusable, and not hidden.
+     *
+     * If a group matches the search string, the group is unfolded and all its children are unfolded, marked as focusable, and not hidden.
+     *
+     * If a leaf matches the search string, it is marked as not hidden and focusable.
+     *
+     * Else the entry marked as hidden and not focusable.
+     *
+     * It also determines whenever counter and token invalid should be displayed on groups and leaves.
+     *
+     * @param entries The entries to filter.
+     * @param search The search string.
+     * @returns The filtered entries.
+     */
+    static filter(entries: InternalNavSelectorEntry[], search: string): InternalNavSelectorEntry[];
+    private static filterEntries;
+    private static recursivelyUnfoldEntry;
+    private static matches;
+    private static cleanValue;
+}

package/nav-selector/utils/nav-selector.folding.d.ts

@@ -0,0 +1,47 @@
+import { InternalNavSelectorEntry } from '../nav-selector';
+/**
+ * Class to handle the folding and unfolding of nav selector entries.
+ */
+export declare class NavSelectorFolding {
+    /**
+     * Toggle the folding state of an entry.
+     *
+     * @see {@link NavSelectorFolding.fold} and {@link NavSelectorFolding.unfold} for more information on folding and unfolding.
+     *
+     * @param entries nav selector entries
+     * @param entryUid the entry uid to toggle
+     * @param minified true if the nav selector is minified. Needed for leaf as they are not foldable in minified mode
+     */
+    static toggleFolding<T extends InternalNavSelectorEntry>(entries: T[], entryUid: string, minified: boolean): InternalNavSelectorEntry[];
+    /**
+     * Fold an entry.
+     *
+     * Set unfocusable on all children of the folded entry.
+     * Compute whenever the counter and token invalid should be displayed on groups and leaves.
+     *
+     * @param entries nav selector entries
+     * @param entryUid the entry uid to fold
+     * @param minified true if the nav selector is minified. Needed for leaf as they are not foldable in minified mode
+     */
+    static fold<T extends InternalNavSelectorEntry>(entries: T[], entryUid: string, minified: boolean): InternalNavSelectorEntry[];
+    /**
+     * Unfold an entry.
+     *
+     * Set focusable on all children of the folded entry.
+     * Compute whenever the counter and token invalid should be displayed on groups and leaves.
+     *
+     * @param entries nav selector entries
+     * @param entryUid the entry uid to unfold
+     * @param minified true if the nav selector is minified. Needed for leaf as they are not foldable in minified mode
+     */
+    static unfold<T extends InternalNavSelectorEntry>(entries: T[], entryUid: string, minified: boolean): InternalNavSelectorEntry[];
+    private static toggleEntryFolding;
+    private static foldEntry;
+    private static unfoldEntry;
+    private static foldCategory;
+    private static unfoldCategory;
+    private static foldGroup;
+    private static unfoldGroup;
+    private static foldLeaf;
+    private static unfoldLeaf;
+}

package/nav-selector/utils/nav-selector.minifying.d.ts

@@ -0,0 +1,27 @@
+import { InternalNavSelectorEntry } from '../nav-selector';
+/**
+ * NavSelectorMinifying is a utility class that provides methods to apply rules on entries when minifying or expanded nav selector.
+ */
+export declare class NavSelectorMinifying {
+    /**
+     * When minifying the nav selector, compute the focusable state of the entries.
+     *
+     * Leaf are not focusable in any error state when minified.
+     * Detail are not focusable when minified.
+     *
+     * @param entries The entries to minify.
+     * @returns The modified entries.
+     */
+    static minify<T extends InternalNavSelectorEntry>(entries: T[]): InternalNavSelectorEntry[];
+    /**
+     * When expanding the nav selector, compute the focusable state of the entries.
+     *
+     * Leaf are not focusable in disabled state when expanded.
+     * Detail are focusable when expanded.
+     *
+     * @param entries The entries to minify.
+     * @returns The modified entries.
+     */
+    static expand<T extends InternalNavSelectorEntry>(entries: T[]): InternalNavSelectorEntry[];
+    private static compute;
+}

package/nav-selector/utils/nav-selector.multi-select.d.ts

@@ -0,0 +1,54 @@
+import { InternalNavSelectorEntry } from '../nav-selector';
+/**
+ * NavSelectorMultiSelect is a utility class that provides methods to select an entry in multiple mode.
+ */
+export declare class NavSelectorMultiSelect {
+    /**
+     * Select an entry in multiple mode.
+     *
+     * Categories are not selectable.
+     *
+     * Groups and leaves are selectable.
+     *
+     * Groups may be in undetermined state if some of their children are selected and some are not.
+     * @param entries nav selector entries
+     * @param entryUid the entry uid to select
+     */
+    static selectInMultipleMode(entries: InternalNavSelectorEntry[], entryUid: string): InternalNavSelectorEntry[];
+    /**
+     * Select only a leaf in multiple mode.
+     *
+     * Categories are not selectable.
+     *
+     * Groups may be in undetermined state if some of their children are selected and some are not.
+     * @param entries nav selector entries
+     * @param entryUid the entry uid to select
+     */
+    static selectOnlyALeafInMultipleMode<T extends InternalNavSelectorEntry>(entries: T[], entryUid: string): InternalNavSelectorEntry[];
+    /**
+     * Select all entries in multiple mode.
+     *
+     * Categories are not selectable.
+     *
+     * Groups and leaves are selectable.
+     * @param entries nav selector entries
+     */
+    static selectAll(entries: InternalNavSelectorEntry[]): InternalNavSelectorEntry[];
+    /**
+     * Unselect all entries in multiple mode.
+     *
+     * Categories are not selectable.
+     *
+     * Groups and leaves are selectable.
+     * @param entries nav selector entries
+     */
+    static unselectAll(entries: InternalNavSelectorEntry[]): InternalNavSelectorEntry[];
+    private static selectALeafInMultipleMode;
+    private static selectACategoryInMultipleMode;
+    private static selectAGroupInMultipleMode;
+    private static toggleSelectLeaf;
+    private static selectLeafs;
+    private static unselectLeafs;
+    private static unselectChildren;
+    private static selectChildren;
+}

package/nav-selector/utils/nav-selector.single-select.d.ts

@@ -0,0 +1,15 @@
+import { InternalNavSelectorEntry } from '../nav-selector';
+/**
+ * NavSelectorSingleSelect is a utility class that provides methods to select a single entry in a nav selector.
+ */
+export declare class NavSelectorSingleSelect {
+    /**
+     * Selects a single entry in the nav selector.
+     * @param entries nav selector entries
+     * @param entryUid the entry uid to select
+     */
+    static select<T extends InternalNavSelectorEntry>(entries: T[], entryUid: string): InternalNavSelectorEntry[];
+    private static selectALeaf;
+    private static selectALeafWithDetails;
+    private static selectALeafWithoutDetails;
+}

package/nav-selector/utils/nav-selector.view-more.d.ts

@@ -0,0 +1,30 @@
+import { InternalNavSelectorEntry } from '../nav-selector';
+/**
+ * Utility class to handle the view more functionality on leaves
+ */
+export declare class NavSelectorViewMore {
+    /**
+     * Change the view more details displayed limit on leaves
+     * @param entries nav selector entries
+     * @param limit the number of details we want to display by default
+     */
+    static changeViewMoreDetailsDisplayedLimit<T extends InternalNavSelectorEntry>(entries: T[], limit: number): InternalNavSelectorEntry[];
+    /**
+     * We want to display all details of the leaf
+     *
+     * set viewMoreDisplayed to false and set all details as focusable
+     *
+     * @param entries nav selector entries
+     * @param leafUid the uid of the leaf we want to view all details
+     */
+    static viewMore<T extends InternalNavSelectorEntry>(entries: T[], leafUid: string): InternalNavSelectorEntry[];
+    /**
+     * We want to display only the number of details of the leaf corresponding to the viewMoreDetailsDisplayedLimit
+     *
+     * set viewMoreDisplayed to true and set only the details with an index lower than the limit as focusable
+     *
+     * @param entries nav selector entries
+     * @param uid the uid of the leaf we want to view all details
+     */
+    static viewLess<T extends InternalNavSelectorEntry>(entries: T[], uid: string): InternalNavSelectorEntry[];
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@agorapulse/ui-components",
   "description": "Agorapulse UI Components Library",
-  "version": "18.0.9",
+  "version": "18.0.11",
   "author": "Benoit Hediard",
   "repository": {
     "type": "git",
@@ -49,18 +49,18 @@
       "esm": "./esm2022/autocomplete/agorapulse-ui-components-autocomplete.mjs",
       "default": "./fesm2022/agorapulse-ui-components-autocomplete.mjs"
     },
-    "./badge": {
-      "types": "./badge/index.d.ts",
-      "esm2022": "./esm2022/badge/agorapulse-ui-components-badge.mjs",
-      "esm": "./esm2022/badge/agorapulse-ui-components-badge.mjs",
-      "default": "./fesm2022/agorapulse-ui-components-badge.mjs"
-    },
     "./avatar": {
       "types": "./avatar/index.d.ts",
       "esm2022": "./esm2022/avatar/agorapulse-ui-components-avatar.mjs",
       "esm": "./esm2022/avatar/agorapulse-ui-components-avatar.mjs",
       "default": "./fesm2022/agorapulse-ui-components-avatar.mjs"
     },
+    "./badge": {
+      "types": "./badge/index.d.ts",
+      "esm2022": "./esm2022/badge/agorapulse-ui-components-badge.mjs",
+      "esm": "./esm2022/badge/agorapulse-ui-components-badge.mjs",
+      "default": "./fesm2022/agorapulse-ui-components-badge.mjs"
+    },
     "./button": {
       "types": "./button/index.d.ts",
       "esm2022": "./esm2022/button/agorapulse-ui-components-button.mjs",
@@ -175,6 +175,12 @@
       "esm": "./esm2022/modal/agorapulse-ui-components-modal.mjs",
       "default": "./fesm2022/agorapulse-ui-components-modal.mjs"
     },
+    "./nav-selector": {
+      "types": "./nav-selector/index.d.ts",
+      "esm2022": "./esm2022/nav-selector/agorapulse-ui-components-nav-selector.mjs",
+      "esm": "./esm2022/nav-selector/agorapulse-ui-components-nav-selector.mjs",
+      "default": "./fesm2022/agorapulse-ui-components-nav-selector.mjs"
+    },
     "./neo-datepicker": {
       "types": "./neo-datepicker/index.d.ts",
       "esm2022": "./esm2022/neo-datepicker/agorapulse-ui-components-neo-datepicker.mjs",