@cntwg/html-ctrls-lists 0.0.30 → 0.0.32

package/index.d.ts

@@ -0,0 +1,19 @@
+import {
+  THtmlStubItemsSet,
+} from "./lib/lists-stubs";
+
+import {
+  BTS_DEF_GROUP_NAME,
+  THtmlListButtonsController,
+} from "./lib/lists-btn";
+
+import {
+  THtmlItemsListContainer, THtmlItemsListController,
+} from "./lib/list";
+
+export {
+  THtmlStubItemsSet,
+  THtmlItemsListContainer, THtmlItemsListController,
+  BTS_DEF_GROUP_NAME,
+  THtmlListButtonsController,
+};

package/lib/list.d.ts

@@ -0,0 +1,278 @@
+export type ISearchListElementResultOnFail = {
+    /**
+     * - element index
+     */
+    index: number;
+    /**
+     * - found element
+     */
+    item: null;
+};
+export type ISearchListElementResultOnSuccess = {
+    /**
+     * - element index
+     */
+    index: number;
+    /**
+     * - found element
+     */
+    item: any;
+};
+export type ISearchListElementResult = ISearchListElementResultOnFail | ISearchListElementResultOnSuccess;
+/**
+ * An options set for `THtmlItemsListContainer`-class
+ */
+export type OPT_hlconsett = {
+    /**
+     * - indicates whether to hide a new element
+     */
+    autoHideNewItems?: boolean;
+    /**
+     * - indicates whether to mark a current element
+     */
+    markCurrentItem?: boolean | undefined;
+    /**
+     * - contains a base class
+     * attributes applayed to each a newly added list member
+     */
+    itemBaseClassID?: string | string[];
+};
+/**
+ * An options set for `THtmlItemsListController`-class
+ */
+export type OPT_hlctlsett = {
+    /**
+     * - indicates whether to hide a new element
+     */
+    autoHideNewItems?: boolean;
+    /**
+     * - indicates whether to mark a current element
+     */
+    markCurrentItem?: boolean;
+    /**
+     * - contains a base class
+     * attributes applayed to each a newly added list member
+     */
+    itemBaseClassID?: string | string[];
+    /**
+     * - indicates whether to show stubs if empty
+     */
+    showStubsIfEmpty?: boolean;
+    /**
+     * - indicates whether a selection of the elements group is allowed
+     */
+    allowGroupSelection?: boolean;
+    /**
+     * - indicates whether locking of an element selection is allowed
+     */
+    allowSelectionLocks?: boolean;
+    /**
+     * - stub elements options
+     */
+    stubs?: IStubItemsSetOptions | undefined;
+};
+import type { IStubItemsSetOptions } from "./lists-stubs";
+
+/**
+ * This class implements an interfaco for a list container
+ */
+export class THtmlItemsListContainer {
+    /**
+     * Creates an instance of a list container
+     */
+    constructor(host: HTMLElement | null, opt?: OPT_hlconsett);
+    /**
+     * Contains a Qty of an elements
+     */
+    get count(): number;
+    /**
+     * Contains an index of the current element
+     */
+    get curIndex(): number;
+    /**
+     * Returns a minimum value of an index
+     */
+    get minIndex(): number;
+    /**
+     * Returns a maximum value of an index
+     */
+    get maxIndex(): number;
+    /**
+     * Returns a value of a previous index
+     */
+    get prevIndex(): number;
+    /**
+     * Returns a value of a next index
+     */
+    get nextIndex(): number;
+    /**
+     * Returns an element in the current index
+     */
+    get curItem(): HTMLElement | null;
+    /**
+     * Clears an instance content.
+     */
+    clear(): void;
+    /**
+     * Checks if an instance contains no items.
+     */
+    isEmpty(): boolean;
+    /**
+     * Checks if an instance contains any items.
+     */
+    isNotEmpty(): boolean;
+    /**
+     * Checks if a given value is a valid index and
+     * it fits an index range within an instance.
+     * @deprecated
+     * @todo \[since v0.0.31] deprecated. Use
+     *     {@link THtmlItemsListContainer.checkIndex} instead
+     */
+    chkIndex(value: number | string): boolean;
+    /**
+     * Checks if a given value is a valid index and
+     * it fits an index range within an instance.
+     * @since 0.0.31
+     */
+    checkIndex(value: number | string): boolean;
+    /**
+     * Checks if a given value is a valid index and
+     * it fits an index range within an instance.
+     * @deprecated
+     * @todo \[since v0.0.31] deprecated. Use
+     *     {@link THtmlItemsListContainer.checkIndex} or
+     *     {@link THtmlItemsListContainer.tryIndex} instead
+     */
+    chkIndexEx(value: number | string, opt?: boolean): boolean | number;
+    /**
+     * Returns an index in case a given value is a valid index value and not exceeds
+     * an index range within the list. If failed a `-1` returned
+     * @since 0.0.31
+     */
+    tryIndex(value: any): number;
+    /**
+     * Returns an index of a given element.
+     * @param {HTMLElement} item  - element to search
+     * @todo add 2nd param
+     * @see TItemsListEx.srchIndex
+     */
+    srchIndex(item: HTMLElement): number;
+    /**
+     * Returns an index of an element wich has an attribute
+     * with a given name and value.
+     */
+    srchIndexByAttr(name: string, value?: any): number;
+    /**
+     * Returns an index of an element wich has a given ID.
+     */
+    srchIndexByID(value: string): number;
+    /**
+     * Sets a current index.
+     */
+    setCurIndex(index: number | string): boolean;
+    /**
+     * Resets a current index.
+     */
+    rstCurIndex(): void;
+    /**
+     * Returns an item addressed by a given index.
+     */
+    getItem(index: number | string): HTMLElement | null;
+    /**
+     * Returns an item wich has an attribute with a given name and value.
+     */
+    getItemByAttr(name: string, value?: any): HTMLElement | null;
+    /**
+     * Returns an item wich has a given ID.
+     */
+    getItemByID(value: string): HTMLElement | null;
+    /**
+     * Adds an item to an instance.
+     */
+    addItem(item: HTMLElement, opt?: boolean): number;
+    /**
+     * Deletes an item from an instance.
+     */
+    delItem(index: number | string, opt?: any, optEx?: boolean): boolean;
+    /**
+     * Selects an item addressed by a given index.
+     */
+    selectItem(index: number | string, opt?: boolean): boolean;
+    /**
+     * Unselects an item addressed by a given index.
+     */
+    unselectItem(index: number | string): boolean;
+    /**
+     * Hides an item addressed by a given index.
+     */
+    hideItem(index: number | string): boolean;
+    /**
+     * Shows an item addressed by a given index.
+     */
+    showItem(index: number | string): boolean;
+    /**
+     * Checks whether an item is selected.
+     */
+    isSelectedItem(index: number | string): boolean;
+    /**
+     * Checks whether an item is hidden.
+     */
+    isHiddenItem(index: number | string): boolean;
+    [Symbol.iterator](): {
+        next: () => {
+            done: boolean;
+            value: HTMLElement | null;
+        } | {
+            done: boolean;
+            value: undefined;
+        };
+        return(): {
+            done: boolean;
+            value: undefined;
+        };
+    };
+    #private;
+}
+
+/**
+ * This class enhanced a capabilities implemented
+ * in the `THtmlItemsListContainer` class
+ */
+export class THtmlItemsListController extends THtmlItemsListContainer {
+    /**
+     * Creates a new instance of the class.
+     */
+    constructor(host: HTMLElement | null, opt?: OPT_hlctlsett);
+    /**
+     * Returns a list of the selected elements
+     */
+    get SelectedItems(): HTMLElement[];
+    /**
+     * Returns a `THtmlStubItemsSet` instance
+     */
+    get StubItems(): THtmlStubItemsSet;
+    /**
+     * Indicates whether a selection is locked
+     */
+    get isSelectionLocked(): boolean;
+    /**
+     * Locks an element selection.
+     */
+    lockItemsSelection(): void;
+    /**
+     * Unlocks an element selection.
+     */
+    unlockItemsSelection(): void;
+    /**
+     * Deletes an element from an instance members.
+     * @fires THtmlItemsListController#list-clear
+     * @fires THtmlItemsListController#item-removed
+     */
+    delItem(index: number | string, opt?: any): boolean;
+    /**
+     * Sets a callback function to handle event.
+     */
+    on(name: string, evnt: Function): void;
+    #private;
+}
+import { THtmlStubItemsSet } from "./lists-stubs";