@base-framework/organisms 1.0.18 → 1.0.19

package/dist/types/lists/list.d.ts

@@ -0,0 +1,8 @@
+/**
+ * List
+ *
+ * This will create a list component.
+ *
+ * @class
+ */
+export const List: object | Function;

package/dist/types/organisms.d.ts

@@ -0,0 +1,405 @@
+export function Doctype(props: object): object;
+/**
+ * Creates an HTML tag.
+ *
+ * @param {object} props - Properties for the HTML element.
+ * @param {array} children - Children elements of the HTML element.
+ * @return {object} - Returns an object representing the HTML element.
+ */
+export const Html: Function;
+/**
+ * Creates a script tag.
+ *
+ * @param {object} props - Properties for the HTML element.
+ * @param {array} children - Children elements of the HTML element.
+ * @return {object} - Returns an object representing the HTML element.
+ */
+export const Script: Function;
+/**
+ * Creates a style tag.
+ *
+ * @param {object} props - Properties for the HTML element.
+ * @param {array} children - Children elements of the HTML element.
+ * @return {object} - Returns an object representing the HTML element.
+ */
+export const Style: Function;
+/**
+ * Creates a head tag.
+ *
+ * @param {object} props - Properties for the head element.
+ * @param {array} children - Children elements of the head.
+ * @return {object} - Returns an object representing the head element.
+ */
+export const Head: Function;
+export function Title(props: object): any;
+export function Meta(props: object): object;
+/**
+ * Creates a body tag.
+ *
+ * @param {object} props - Properties for the body element.
+ * @param {array} children - Children elements of the body.
+ * @return {object} - Returns an object representing the body element.
+ */
+export const Body: Function;
+/**
+ * Creates a div element.
+ *
+ * @param {object} props - Properties for the div element.
+ * @param {array} children - Children elements of the div.
+ * @return {object} - Returns an object representing the div element.
+ */
+export const Div: Function;
+/**
+ * Creates a dialog element.
+ *
+ * @param {object} props - Properties for the div element.
+ * @param {array} children - Children elements of the div.
+ * @return {object} - Returns an object representing the dialog element.
+ */
+export const Dialog: Function;
+/**
+ * Creates a span element.
+ *
+ * @param {object} props - Properties for the span element.
+ * @param {array} children - Children elements of the span.
+ * @return {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.
+ * @return {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.
+ * @return {object} - Returns an object representing the anchor element.
+ */
+export const A: Function;
+/**
+ * Creates a button element.
+ */
+export const Button: Function;
+/**
+ * Creates a submit button element.
+ */
+export const SubmitButton: 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.
+ * @return {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 checkbox input element.
+ *
+ * @param {object} props - Properties for the checkbox input element.
+ * @return {object} - Returns an object representing the checkbox input element.
+ */
+export const Checkbox: 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/router/nav-link.d.ts

@@ -0,0 +1,50 @@
+/**
+ * NavLink
+ *
+ * This will create a nav link that will add an active
+ * class when the browser route path matches the link
+ * href.
+ *
+ * @class
+ * @extends Component
+ */
+export class NavLink extends Component {
+    selectedClass: any;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will get string.
+     *
+     * @param {string} string
+     * @returns {(string|null)}
+     */
+    getString(string: string): (string | null);
+    /**
+     * This will setup the watchers.
+     *
+     * @protected
+     * @param {string} href
+     * @param {string} text
+     * @returns {array}
+     */
+    protected setupWatchers(href: string, text: string): any[];
+    /**
+     * This will setup the states.
+     *
+     * @protected
+     * @returns {object}
+     */
+    protected setupStates(): object;
+    /**
+     * This will update the class on the element.
+     *
+     * @param {boolean} selected
+     * @returns {void}
+     */
+    update(selected: boolean): void;
+}
+import { Component } from '@base-framework/base';

package/dist/types/utils/child-helper.d.ts

@@ -0,0 +1,93 @@
+/**
+ * ChildHelper
+ *
+ * This class will help with getting children of a node.
+ *
+ * @class
+ */
+export class ChildHelper {
+    /**
+     * This will get the first child.
+     *
+     * @param {object} parent
+     * @returns {object|null}
+     */
+    static first(parent: object): object | null;
+    /**
+     * This will get the last child.
+     *
+     * @param {object} parent
+     * @returns {object|null}
+     */
+    static last(parent: object): object | null;
+    /**
+     * This will get the child at the specified index.
+     *
+     * @param {object} parent
+     * @param {number} index
+     * @returns {object|null}
+     */
+    static get(parent: object, index: number): object | null;
+    /**
+     * This will get the parent of the node.
+     *
+     * @param {object} node
+     * @returns {object|null}
+     */
+    static next(node: object): object | null;
+    /**
+     * This will get the previous sibling.
+     *
+     * @param {object} node
+     * @returns {object|null}
+     */
+    static previous(node: object): object | null;
+    /**
+     * This will get the index of the node.
+     *
+     * @param {object} node
+     * @returns {number}
+     */
+    static index(node: object): number;
+    /**
+     * This will get the previous index of the node.
+     *
+     * @param {object} node
+     * @returns {number}
+     */
+    static getPreviousIndex(node: object): number;
+    /**
+     * This will replace a child layout.
+     *
+     * @param {object} layout
+     * @param {object} oldChild
+     * @param {object} parent
+     * @returns {void}
+     */
+    static replace(layout: object, oldChild: object, parent: object): void;
+    /**
+     * This will remove a child.
+     *
+     * @param {object} node
+     * @returns {void}
+     */
+    static remove(node: object): void;
+    /**
+     * This will append a child layout.
+     *
+     * @param {object} childrenLayout
+     * @param {object} container
+     * @param {object} parent
+     * @returns {void}
+     */
+    static append(childrenLayout: object, container: object, parent: object): void;
+    /**
+     * This will prepend a child layout.
+     *
+     * @param {object} childrenLayout
+     * @param {object} container
+     * @param {object} parent
+     * @returns {void}
+     */
+    static prepend(childrenLayout: object, container: object, parent: object): void;
+}

package/dist/types/utils/data-helper.d.ts

@@ -0,0 +1,37 @@
+/**
+ * DataHelper
+ *
+ * This will help with data manipulation.
+ *
+ * @class
+ */
+export class DataHelper {
+    /**
+     * Compares two arrays of objects and returns the differences based on a specified key.
+     *
+     * @param {Array<Object>} oldArray - The original array of objects.
+     * @param {Array<Object>} newArray - The updated array of objects.
+     * @param {string} key - The key used to compare objects in the arrays.
+     * @returns {Object} An object containing arrays of added, updated, and deleted items.
+     */
+    static diff(oldArray: Array<any>, newArray: Array<any>, key: string): any;
+    /**
+     * Converts an array of objects into a Map keyed by the specified property.
+     * Each value in the Map is an object containing the item and its index in the array.
+     *
+     * @param {Array<Object>} array - The array to convert.
+     * @param {string} key - The key used to map the objects.
+     * @returns {Map} A Map with keys as specified property and values as objects.
+     * @private
+     */
+    private static arrayToMap;
+    /**
+     * Performs a deep comparison between two objects.
+     *
+     * @param {Object} obj1 - The first object to compare.
+     * @param {Object} obj2 - The second object to compare.
+     * @returns {boolean} True if objects are equal, else false.
+     * @private
+     */
+    private static deepEqual;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@base-framework/organisms",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "description": "This will add default organisms to the base framework.",
   "main": "./dist/organisms.js",
   "scripts": {