@base-framework/base 3.0.79 → 3.0.81

package/dist/types/modules/atom/atoms.d.ts

@@ -0,0 +1,343 @@
+/**
+ * Creates a div element.
+ *
+ * @param {object} props - Properties for the div element.
+ * @param {array} children - Children elements of the div.
+ * @returns {object} - Returns an object representing the div element.
+ */
+export const Div: Function;
+/**
+ * Creates a span element.
+ *
+ * @param {object} props - Properties for the span element.
+ * @param {array} children - Children elements of the span.
+ * @returns {object} - Returns an object representing the span element.
+ */
+export const Span: Function;
+/**
+ * Creates a paragraph (p) element.
+ *
+ * @param {object} props - Properties for the paragraph element.
+ * @param {array} children - Children elements of the paragraph.
+ * @returns {object} - Returns an object representing the paragraph element.
+ */
+export const P: Function;
+/**
+ * Creates an anchor (a) element.
+ *
+ * @param {object} props - Properties for the anchor element.
+ * @param {array} children - Children elements of the anchor.
+ * @returns {object} - Returns an object representing the anchor element.
+ */
+export const A: Function;
+/**
+ * Creates a button element.
+ */
+export const Button: Function;
+/**
+ * Creates an unordered list (ul) element.
+ */
+export const Ul: Function;
+/**
+ * Creates a list item (li) element.
+ */
+export const Li: Function;
+/**
+ * Creates an image (img) element.
+ */
+export const Img: Function;
+/**
+ * Create a br element.
+ *
+ * @param {object} props - Properties for the br element.
+ * @returns {object} - Returns an object representing the br element.
+ */
+export const Br: Function;
+/**
+ * Creates a horizontal rule (hr) element.
+ */
+export const Hr: Function;
+/**
+ * Creates a text (text) element.
+ */
+export const Text: Function;
+/**
+ * Creates a header 1 (h1) element.
+ */
+export const H1: Function;
+/**
+ * Creates a header 2 (h2) element.
+ */
+export const H2: Function;
+/**
+ * Creates a header 3 (h3) element.
+ */
+export const H3: Function;
+/**
+ * Creates a header 4 (h4) element.
+ */
+export const H4: Function;
+/**
+ * Creates a header 5 (h5) element.
+ */
+export const H5: Function;
+/**
+ * Creates a header 6 (h6) element.
+ */
+export const H6: Function;
+/**
+ * Creates an input element.
+ */
+export const Input: Function;
+/**
+ * Creates a label element.
+ */
+export const Label: Function;
+/**
+ * Creates a section element.
+ */
+export const Section: Function;
+/**
+ * Creates an article element.
+ */
+export const Article: Function;
+/**
+ * Creates a header (header) element.
+ */
+export const Header: Function;
+/**
+ * Creates a footer element.
+ */
+export const Footer: Function;
+/**
+ * Creates a nav element.
+ */
+export const Nav: Function;
+/**
+ * Creates an aside element.
+ */
+export const Aside: Function;
+/**
+ * Creates a figure element.
+ */
+export const Figure: Function;
+/**
+ * Creates a figcaption element.
+ */
+export const Figcaption: Function;
+/**
+ * Creates a main element.
+ */
+export const Main: Function;
+/**
+ * Creates a video element.
+ */
+export const Video: Function;
+/**
+ * Creates an audio element.
+ */
+export const Audio: Function;
+/**
+ * Creates a table element.
+ */
+export const Table: Function;
+/**
+ * Creates a table row (tr) element.
+ */
+export const Tr: Function;
+/**
+ * Creates a table header (th) element.
+ */
+export const Th: Function;
+/**
+ * Creates a table data (td) element.
+ */
+export const Td: Function;
+/**
+ * Creates a table header group (thead) element.
+ */
+export const Thead: Function;
+/**
+ * Creates a table body (tbody) element.
+ */
+export const Tbody: Function;
+/**
+ * Creates a table footer (tfoot) element.
+ */
+export const Tfoot: Function;
+/**
+ * Creates a form element.
+ */
+export const Form: Function;
+/**
+ * Creates a select element.
+ */
+export const Select: Function;
+/**
+ * Creates an option element for a select tag.
+ */
+export const Option: Function;
+/**
+ * Creates a textarea element.
+ */
+export const Textarea: Function;
+/**
+ * Creates a canvas element.
+ */
+export const Canvas: Function;
+/**
+ * Creates a progress element.
+ */
+export const Progress: Function;
+/**
+ * Creates a blockquote element.
+ */
+export const Blockquote: Function;
+/**
+ * Creates a preformatted text (pre) element.
+ */
+export const Pre: Function;
+/**
+ * Creates a code element.
+ */
+export const Code: Function;
+/**
+ * Creates an ordered list (ol) element.
+ */
+export const Ol: Function;
+/**
+ * Creates a definition list (dl) element.
+ */
+export const Dl: Function;
+/**
+ * Creates a definition term (dt) element.
+ */
+export const Dt: Function;
+/**
+ * Creates a definition description (dd) element.
+ */
+export const Dd: Function;
+/**
+ * Creates a fieldset element.
+ */
+export const Fieldset: Function;
+/**
+ * Creates a legend element.
+ */
+export const Legend: Function;
+/**
+ * Creates a meter element.
+ */
+export const Meter: Function;
+/**
+ * Creates an iframe element.
+ */
+export const Iframe: Function;
+/**
+ * Creates a details element.
+ */
+export const Details: Function;
+/**
+ * Creates a summary element.
+ */
+export const Summary: Function;
+/**
+ * Creates an em element.
+ */
+export const Em: Function;
+/**
+ * Creates a strong element.
+ */
+export const Strong: Function;
+/**
+ * Creates a small element.
+ */
+export const Small: Function;
+/**
+ * Creates a s element (strikethrough).
+ */
+export const S: Function;
+/**
+ * Creates a cite element.
+ */
+export const Cite: Function;
+/**
+ * Creates a q element (inline quotation).
+ */
+export const Q: Function;
+/**
+ * Creates a dfn element (definition element).
+ */
+export const Dfn: Function;
+/**
+ * Creates an abbr element (abbreviation).
+ */
+export const Abbr: Function;
+/**
+ * Creates a data element.
+ */
+export const Data: Function;
+/**
+ * Creates a time element.
+ */
+export const Time: Function;
+/**
+ * Creates a var element (variable).
+ */
+export const Var: Function;
+/**
+ * Creates a samp element (sample output).
+ */
+export const Samp: Function;
+/**
+ * Creates a kbd element (keyboard input).
+ */
+export const Kbd: Function;
+/**
+ * Creates a sub element (subscript).
+ */
+export const Sub: Function;
+/**
+ * Creates a sup element (superscript).
+ */
+export const Sup: Function;
+/**
+ * Creates an i element (italic).
+ */
+export const I: Function;
+/**
+ * Creates a b element (bold).
+ */
+export const B: Function;
+/**
+ * Creates a u element (underline).
+ */
+export const U: Function;
+/**
+ * Creates a mark element.
+ */
+export const Mark: Function;
+/**
+ * Creates a ruby element (for East Asian typography).
+ */
+export const Ruby: Function;
+/**
+ * Creates an rt element (explanation/pronunciation of characters in East Asian typography).
+ */
+export const Rt: Function;
+/**
+ * Creates an rp element (for East Asian fallback parenthesis).
+ */
+export const Rp: Function;
+/**
+ * Creates a bdi element (Bi-Directional Isolation).
+ */
+export const Bdi: Function;
+/**
+ * Creates a bdo element (Bi-Directional Override).
+ */
+export const Bdo: Function;
+/**
+ * Creates a wbr element (Word Break Opportunity).
+ */
+export const Wbr: Function;

package/dist/types/modules/component/component.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Component
+ *
+ * This will allow components to be extended
+ * from a single factory.
+ *
+ * @class
+ * @augments Unit
+ *
+ * @example
+ * class QuickFlashPanel extends Component
+ *	{
+ *		render()
+ *		{
+ *			return {
+ *
+ *			};
+ *		}
+ *	}
+ */
+export class Component extends Unit {
+    /**
+     * @param {boolean} isComponent
+     */
+    isComponent: boolean;
+    /**
+     * @member {string} [stateTargetId] // optional override of state id
+     */
+    stateTargetId: any;
+    /**
+     * This will initialize the component.
+     *
+     * @protected
+     * @returns {object}
+     */
+    protected initialize(): object;
+    /**
+     * This will setup the state target.
+     *
+     * @protected
+     * @param {string} [id]
+     * @returns {void}
+     */
+    protected setupStateTarget(id?: string): void;
+    /**
+     * Override this to setup the component states.
+     *
+     * @protected
+     * @returns {object}
+     */
+    protected setupStates(): object;
+    /**
+     * This will add the states.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected addStates(): void;
+    stateHelper: StateHelper;
+    /**
+     * This will remove the states.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected removeStates(): void;
+    /**
+     * This will setup the event helper.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected setupEventHelper(): void;
+    events: EventHelper;
+    /**
+     * This will setup the events.
+     *
+     * @protected
+     * @returns {array}
+     */
+    protected setupEvents(): any[];
+    /**
+     * This will add the events.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected addEvents(): void;
+    /**
+     * This will remove the events.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected removeEvents(): void;
+}
+import { Unit } from './unit.js';
+import { StateHelper } from './state-helper.js';
+import { EventHelper } from './event-helper.js';

package/dist/types/modules/component/event-helper.d.ts

@@ -0,0 +1,59 @@
+/**
+ * EventHelper
+ *
+ * This will create an event object to make
+ * adding and removing events easier.
+ *
+ * @class
+ */
+export class EventHelper {
+    /**
+     * @member {array} events
+     */
+    events: any[];
+    /**
+     * This will add an array of events.
+     *
+     * @param {array} events
+     * @returns {void}
+     */
+    addEvents(events: any[]): void;
+    /**
+     * This will add an event.
+     *
+     * @param {string} event
+     * @param {object} obj
+     * @param {function} callBack
+     * @param {boolean} capture
+     * @returns {void}
+     */
+    on(event: string, obj: object, callBack: Function, capture: boolean): void;
+    /**
+     * This will remove an event.
+     *
+     * @param {string} event
+     * @param {object} obj
+     * @param {function} callBack
+     * @param {boolean} capture
+     * @returns {void}
+     */
+    off(event: string, obj: object, callBack: Function, capture: boolean): void;
+    /**
+     * This will set all events.
+     *
+     * @returns {void}
+     */
+    set(): void;
+    /**
+     * This will unset all events.
+     *
+     * @returns {void}
+     */
+    unset(): void;
+    /**
+     * This will reset the events.
+     *
+     * @returns {void}
+     */
+    reset(): void;
+}

package/dist/types/modules/component/jot.d.ts

@@ -0,0 +1 @@
+export function Jot(layout: object | Function): Function | object;

package/dist/types/modules/component/parse-args.d.ts

@@ -0,0 +1 @@
+export function parseArgs(args: any[]): object;

package/dist/types/modules/component/state-helper.d.ts

@@ -0,0 +1,102 @@
+/**
+ * StateHelper
+ *
+ * This is a helper to manage component states.
+ *
+ * @class
+ */
+export class StateHelper {
+    /**
+     * This will create a state helper.
+     *
+     * @constructor
+     * @param {object} state
+     * @param {object} states
+     */
+    constructor(state: object, states: object);
+    /**
+     * @member {array} remoteStates
+     */
+    remoteStates: any[];
+    /**
+     * This will add states to a state.
+     *
+     * @param {object} state
+     * @param {object} states
+     * @returns {void}
+     */
+    addStates(state: object, states: object): void;
+    /**
+     * This will create a state object.
+     *
+     * @param {string} action
+     * @param {*} state
+     * @param {function} callBack
+     * @param {string} [targetId]
+     * @returns {object}
+     */
+    createState(action: string, state: any, callBack: Function, targetId?: string): object;
+    /**
+     * This will convert an action object to a state array.
+     *
+     * @protected
+     * @param {object} action
+     * @returns {array}
+     */
+    protected convertStates(action: object): any[];
+    /**
+     * This will setup remote states.
+     *
+     * @protected
+     * @param {array} remotes
+     * @param {array} actions
+     * @returns {void}
+     */
+    protected setupRemoteStates(remotes: any[], actions: any[]): void;
+    /**
+     * This will remove remote states.
+     *
+     * @returns {void}
+     */
+    removeRemoteStates(): void;
+    /**
+     * This will remove the actions.
+     *
+     * @param {array} actions
+     * @returns {void}
+     */
+    removeActions(actions: any[]): void;
+    /**
+     * This will restore a state.
+     *
+     * @param {object} state
+     * @returns {void}
+     */
+    restore(state: object): void;
+    /**
+     * This will setup a two way bind to a remote state.
+     *
+     * @param {object} target
+     * @param {string} actionEvent
+     * @param {string} remoteTargetId
+     * @returns {string}
+     */
+    bindRemoteState(target: object, actionEvent: string, remoteTargetId: string): string;
+    /**
+     * This will add the states to the target.
+     *
+     * @protected
+     * @param {object} state
+     * @param {array} actions
+     * @returns {void}
+     */
+    protected addStatesToTarget(state: object, actions: any[]): void;
+    /**
+     * This will add an action.
+     *
+     * @param {object} target
+     * @param {object} action
+     * @returns {string}
+     */
+    addAction(target: object, action: object): string;
+}