@base-framework/ui 0.0.0

package/dist/types/components/organisms/navigation/nav-button-link.d.ts

@@ -0,0 +1,44 @@
+/**
+ * NavButtonLink
+ *
+ * This will create a button to open and close
+ * nested navigations.
+ * @class
+ */
+export class NavButtonLink extends Component {
+    /**
+     * This will set the class.
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    /**
+     * This will set the check callback.
+     * @member {function} checkCallBack
+     * @default null
+     */
+    checkCallBack: any;
+    /**
+     * This will render the component.
+     *
+     * @override
+     * @returns {object}
+     */
+    override render(): object;
+    /**
+     * This will set up the states.
+     *
+     * @override
+     * @protected
+     * @returns {object}
+     */
+    protected override setupStates(): object;
+    /**
+     * This will update the states.
+     *
+     * @param {object} selected
+     * @returns {void}
+     */
+    update(selected: object): void;
+}
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/navigation/navigation-atoms.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This will return a navigation group.
+ *
+ * @param {object} props
+ * @param {object} children
+ * @returns {object}
+ */
+export const NavigationGroup: Function;

package/dist/types/components/organisms/navigation/navigation-menu/navigation-menu.d.ts

@@ -0,0 +1,58 @@
+/**
+ * NavigationMenu
+ *
+ * This will create a tab navigation component.
+ *
+ * @class
+ */
+export class NavigationMenu extends Component {
+    /**
+     * This will set the options.
+     * @member {array} options
+     * @default []
+     */
+    options: any[];
+    /**
+     * This will set the class.
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    links: any[];
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will update the links based on the current path.
+     *
+     * @param {string} path
+     * @returns {void}
+     */
+    updateLinks(path: string): void;
+    /**
+     * This will deactivate all links.
+     *
+     * @returns {void}
+     */
+    deactivateAllLinks(): void;
+    /**
+     * This will update the link's active state.
+     *
+     * @param {object} link
+     * @param {boolean} selected
+     * @returns {void}
+     */
+    updateLink(link: object, selected: boolean): void;
+    /**
+     * This will add a link to the navigation.
+     *
+     * @param {object} option
+     * @returns {object}
+     */
+    addLink({ label: text, href, exact, hidden }: object): object;
+}
+export default NavigationMenu;
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/navigation/navigation.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Navigation
+ *
+ * This will create a navigation component.
+ * @class
+ */
+export class Navigation extends Component {
+    /**
+     * This will set the options.
+     * @member {array} options
+     */
+    options: any[];
+    /**
+     * This will set the class.
+     * @member {string} class
+     */
+    class: string;
+    /**
+     * This will set the mobile border.
+     * @member {boolean} mobileBorder
+     * @default false
+     */
+    mobileBorder: boolean;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will get the options.
+     *
+     * @param {array} options
+     * @returns {array}
+     */
+    mapOptions(options?: any[]): any[];
+    /**
+     * This will get the subs.
+     *
+     * @returns {array}
+     */
+    addSubs(): any[];
+    /**
+     * This will add a group.
+     *
+     * @param {object} option
+     * @returns {object}
+     */
+    addGroup(option: object): object;
+    /**
+     * This will add a link.
+     *
+     * @param {object} option
+     * @returns {object}
+     */
+    addLink(option: object): object;
+}
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/navigation/sidebar-menu/sidebar-menu.d.ts

@@ -0,0 +1,2 @@
+export function SidebarMenu({ title, options, class: className, mobileBorder, sticky }: object): object;
+export default SidebarMenu;

package/dist/types/components/organisms/organisms.d.ts

@@ -0,0 +1,38 @@
+export * from "./button-group.js";
+export * from "./panel.js";
+export * from "./calendar/month/calendar-cells.js";
+export * from "./calendar/month/day-cell.js";
+export * from "./calendar/month/day-header.js";
+export * from "./calendar/month/month-calendar.js";
+export * from "./calendar/week/utils.js";
+export * from "./calendar/week/week-calendar.js";
+export * from "./calendar/week/week-cell.js";
+export * from "./calendar/week/week-cells.js";
+export * from "./calendar/week/week-header.js";
+export * from "./calendar/calendar.js";
+export * from "./calendar/utils.js";
+export * from "./lists/checkbox-col.js";
+export * from "./lists/data-table-body.js";
+export * from "./lists/data-table.js";
+export * from "./lists/header-col.js";
+export * from "./lists/table-header.js";
+export * from "./lists/user-list.js";
+export * from "./navigation/inline-navigation.js";
+export * from "./navigation/main-link.js";
+export * from "./navigation/nav-button-link.js";
+export * from "./navigation/navigation-atoms.js";
+export * from "./navigation/navigation-menu/navigation-menu.js";
+export * from "./navigation/navigation.js";
+export * from "./navigation/sidebar-menu/sidebar-menu.js";
+export * from "./navigation/mobile/nav-wrapper/mobile-nav-wrapper.js";
+export * from "./navigation/mobile/nav-wrapper/navigation-popover.js";
+export * from "./navigation/mobile/nav-wrapper/popup-header.js";
+export * from "./navigation/mobile/nav-wrapper/title-header.js";
+export * from "./overlays/dockable-overlay.js";
+export * from "./overlays/inline-overlay.js";
+export * from "./overlays/overlay.js";
+export * from "./search/search-dropdown.js";
+export * from "./tabs/button-tab.js";
+export * from "./tabs/tab-group.js";
+export * from "./tabs/tab-navigation.js";
+export * from "./tabs/tab.js";

package/dist/types/components/organisms/overlays/dockable-overlay.d.ts

@@ -0,0 +1,38 @@
+/**
+ * DockableOverlay
+ *
+ * This will create an dockable overlay.
+ *
+ * @class
+ * @extends Overlay
+ */
+export class DockableOverlay extends Overlay {
+    dockSize: any;
+    /**
+     * This will get the docked className.
+     *
+     * @returns {string}
+     */
+    getDockedClassName(): string;
+    /**
+     * This will setup and render the component.
+     *
+     * @param {object} container
+     * @returns {void}
+     */
+    setup(container: object): void;
+    /**
+     * This will check if the overlay can dock.
+     *
+     * @returns {boolean}
+     */
+    canDock(): boolean;
+    /**
+     * This will handle the overlay resize.
+     *
+     * @returns {void}
+     */
+    onResize(): void;
+}
+export default Overlay;
+import { Overlay } from "./overlay.js";

package/dist/types/components/organisms/overlays/inline-overlay.d.ts

@@ -0,0 +1,18 @@
+/**
+ * InlineOverlay
+ *
+ * This will create an inline overlay.
+ *
+ * @class
+ * @extends Overlay
+ */
+export class InlineOverlay extends Overlay {
+    /**
+     * This will setup and render the component.
+     *
+     * @param {object} container
+     * @returns {void}
+     */
+    setup(container: object): void;
+}
+import { Overlay } from './overlay.js';

package/dist/types/components/organisms/overlays/overlay.d.ts

@@ -0,0 +1,73 @@
+/**
+ * This will create an overlay back button.
+ *
+ * @param {object} props
+ * @returns {object}
+ */
+export const BackButton: Function;
+/**
+ * Overlay
+ *
+ * This will create an overlay.
+ *
+ * @class
+ * @extends Component
+ */
+export class Overlay extends Component {
+    /**
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will get the overlay className.
+     *
+     * @returns {string}
+     */
+    getClassName(): string;
+    /**
+     * This will setup and render the component.
+     *
+     * @param {object} container
+     * @returns {void}
+     */
+    setContainer(container: object): void;
+    /**
+     * This will setup the overlay states.
+     *
+     * @returns {object}
+     */
+    setupStates(): object;
+    /**
+     * This will set the loading state.= to true.
+     *
+     * @returns {void}
+     */
+    addLoading(): void;
+    /**
+     * This will set the loading state to false.
+     *
+     * @returns {void}
+     */
+    removeLoading(): void;
+    /**
+     * This will add the body of the overlay.
+     *
+     * @returns {object}
+     */
+    addBody(): object;
+    /**
+     * This will get the body contents.
+     *
+     * @returns {array|null}
+     */
+    getContents(): any[] | null;
+}
+export default Overlay;
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/panel.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Panel
+ *
+ * This will create a panel.
+ *
+ * @class
+ * @extends Component
+ */
+export class Panel extends Component {
+    /**
+     * @member {string} class
+     */
+    class: any;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+}
+export default Panel;
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/search/dropdown.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This will create a dropdown.
+ *
+ * @param {object} props - The properties of the component.
+ * @returns {object} - The dropdown component.
+ */
+export const Dropdown: Function;
+export default Dropdown;

package/dist/types/components/organisms/search/search-dropdown.d.ts

@@ -0,0 +1,10 @@
+/**
+ * SearchDropdown
+ *
+ * This will create a search dropdown.
+ *
+ * @param {object} props - The properties of the component.
+ * @returns {ComponentConstructor} - The search dropdown component.
+ */
+export const SearchDropdown: import("node_modules/@base-framework/base/dist/types/modules/component/jot.js").ComponentConstructor;
+export default SearchDropdown;

package/dist/types/components/organisms/search/search-input.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This will create a search input.
+ *
+ * @param {object} props - The properties of the component.
+ * @returns {object} - The search input component.
+ */
+export const SearchInput: Function;

package/dist/types/components/organisms/tabs/button-tab.d.ts

@@ -0,0 +1,65 @@
+/**
+ * ButtonTab
+ *
+ * This will create a button tabs component.
+ *
+ * @class
+ */
+export class ButtonTab extends Component {
+    /**
+     * This will set the options.
+     * @member {array} options
+     * @default []
+     */
+    options: any[];
+    /**
+     * This will set the class.
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    /**
+     * This will set the call back.
+     * @member {function} callBack
+     */
+    callBack: any;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will get the first value.
+     *
+     * @returns {*}
+     */
+    getFirstValue(): any;
+    /**
+     * This will update the component.
+     *
+     * @returns {void}
+     */
+    update(): void;
+    /**
+     * This will select a value.
+     *
+     * @param {*} value
+     * @returns {void}
+     */
+    select(value: any): void;
+    /**
+     * This will update the content.
+     *
+     * @param {*} value
+     * @returns {object}
+     */
+    updateContent(value: any): object;
+    /**
+     * This will setup the states.
+     *
+     * @returns {object}
+     */
+    setupStates(): object;
+}
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/tabs/tab-group.d.ts

@@ -0,0 +1,48 @@
+/**
+ * TabGroup
+ *
+ * This will create a tab group.
+ *
+ * @class
+ * @extends Component
+ */
+export class TabGroup extends Component {
+    /**
+     * This will set the options.
+     * @member {array} options
+     * @default []
+     */
+    options: any[];
+    /**
+     * This will set the class.
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    /**
+     * This will set the on select call back.
+     * @member {function} onSelect
+     */
+    onSelect: any;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will select a value.
+     *
+     * @param {*} value
+     * @returns {void}
+     */
+    select(value: any): void;
+    /**
+     * This will setup the states.
+     *
+     * @returns {object}
+     */
+    setupStates(): object;
+}
+export default TabGroup;
+import { Component } from '@base-framework/base';

package/dist/types/components/organisms/tabs/tab-navigation.d.ts

@@ -0,0 +1,62 @@
+/**
+ * TabNavigation
+ *
+ * This will create a tab navigation component.
+ *
+ * @class
+ */
+export class TabNavigation extends Component {
+    /**
+     * This will set the options.
+     * @member {array} options
+     * @default []
+     */
+    options: any[];
+    /**
+     * This will set the class.
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    /**
+     * This will set the on select call back.
+     * @member {function} onSelect
+     */
+    onSelect: any;
+    links: any[];
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will update the links.
+     *
+     * @param {string} value
+     * @returns {void}
+     */
+    updateLinks(value: string): void;
+    /**
+     * This will deactivate all links.
+     *
+     * @returns {void}
+     */
+    deactivateAllLinks(): void;
+    /**
+     * This will update the link.
+     *
+     * @param {object} link
+     * @param {boolean} selected
+     * @returns {void}
+     */
+    updateLink(link: object, selected: boolean): void;
+    /**
+     * This will add a link.
+     *
+     * @param {object} option
+     * @returns {object}
+     */
+    addLink({ label: text, href, exact }: object): object;
+}
+import { Component } from "@base-framework/base";

package/dist/types/components/organisms/tabs/tab.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Tab
+ *
+ * This will create a tab component that can route
+ * to tab panels.
+ *
+ * @class
+ */
+export class Tab extends Component {
+    /**
+     * This will set the options.
+     * @member {array} options
+     * @default []
+     */
+    options: any[];
+    /**
+     * This will set the class.
+     * @member {string} class
+     * @default ''
+     */
+    class: string;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will add the group.
+     *
+     * @returns {array}
+     */
+    addGroup(): any[];
+}
+import { Component } from "@base-framework/base";

package/dist/types/components/pages/basic-page.d.ts

@@ -0,0 +1,19 @@
+/**
+ * BasicPage
+ *
+ * This will create a basic module to extend
+ * to all child modules.
+ *
+ * @class
+ * @extends Page
+ */
+export class BasicPage extends Page {
+    /**
+     * This will be called every time the route
+     * is activated.
+     *
+     * @param {object} params
+     */
+    update(params: object): void;
+}
+import { Page } from './page.js';

package/dist/types/components/pages/blank-page.d.ts

@@ -0,0 +1,17 @@
+/**
+ * BlankPage
+ *
+ * This will create a blank page.
+ *
+ * @class
+ * @extends BasicPage
+ */
+export class BlankPage extends BasicPage {
+    /**
+     * This will render the page.
+     *
+     * @returns {object}
+     */
+    render(): object;
+}
+import { BasicPage } from './basic-page.js';

package/dist/types/components/pages/center-page.d.ts

@@ -0,0 +1,17 @@
+/**
+ * CenterPage
+ *
+ * This will create a center page.
+ *
+ * @class
+ * @extends BasicPage
+ */
+export class CenterPage extends BasicPage {
+    /**
+     * This will render the page.
+     *
+     * @returns {object}
+     */
+    render(): object;
+}
+import { BasicPage } from './basic-page.js';

package/dist/types/components/pages/full-contain-page.d.ts

@@ -0,0 +1,17 @@
+/**
+ * FullContainPage
+ *
+ * This will create a full contained page.
+ *
+ * @class
+ * @extends BasicPage
+ */
+export class FullContainPage extends BasicPage {
+    /**
+     * This will render the page.
+     *
+     * @returns {object}
+     */
+    render(): object;
+}
+import { BasicPage } from './basic-page.js';