@anguless/angulux 22.0.0-rc.0

package/types/anguless-angulux-types-tabs.d.ts

@@ -0,0 +1,119 @@
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Defines valid pass-through options in Tabs component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabsPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tabs component.
+ * @see {@link TabsPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabsPassThrough<I = unknown> = PassThrough<I, TabsPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in TabList component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabListPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the previous button's DOM element.
+     */
+    prevButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the tab list's DOM element.
+     */
+    tabList?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the active bar's DOM element.
+     */
+    activeBar?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the next button's DOM element.
+     */
+    nextButton?: PassThroughOption<HTMLButtonElement, I>;
+}
+/**
+ * Defines valid pass-through options in TabList component.
+ * @see {@link TabListPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabListPassThrough<I = unknown> = PassThrough<I, TabListPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in Tab component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tab component.
+ * @see {@link TabPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabPassThrough<I = unknown> = PassThrough<I, TabPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in TabPanel component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabPanelPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in TabPanel component.
+ * @see {@link TabPanelPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabPanelPassThrough<I = unknown> = PassThrough<I, TabPanelPassThroughOptions<I>>;
+/**
+ * Defines valid pass-through options in TabPanels component.
+ * @template I Type of instance.
+ *
+ * @group Interface
+ */
+interface TabPanelsPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in TabPanels component.
+ * @see {@link TabPanelsPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TabPanelsPassThrough<I = unknown> = PassThrough<I, TabPanelsPassThroughOptions<I>>;
+
+export type { TabListPassThrough, TabListPassThroughOptions, TabPanelPassThrough, TabPanelPassThroughOptions, TabPanelsPassThrough, TabPanelsPassThroughOptions, TabPassThrough, TabPassThroughOptions, TabsPassThrough, TabsPassThroughOptions };

package/types/anguless-angulux-types-tag.d.ts

@@ -0,0 +1,47 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Tag.pt}
+ * @group Interface
+ */
+interface TagPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in Tag.
+ * @see {@link TagPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TagPassThrough<I = unknown> = PassThrough<I, TagPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Tag.
+ * @group Templates
+ */
+interface TagTemplates {
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+}
+
+export type { TagPassThrough, TagPassThroughOptions, TagTemplates };

package/types/anguless-angulux-types-terminal.d.ts

@@ -0,0 +1,60 @@
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Terminal.pt}
+ * @group Interface
+ */
+interface TerminalPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the welcome message's DOM element.
+     */
+    welcomeMessage?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the command list's DOM element.
+     */
+    commandList?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the command's DOM element.
+     */
+    command?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the prompt label's DOM element.
+     */
+    promptLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the command value's DOM element.
+     */
+    commandValue?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the command response's DOM element.
+     */
+    commandResponse?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the prompt's DOM element.
+     */
+    prompt?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the prompt value's DOM element.
+     */
+    promptValue?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in Terminal.
+ * @see {@link TerminalPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TerminalPassThrough<I = unknown> = PassThrough<I, TerminalPassThroughOptions<I>>;
+
+export type { TerminalPassThrough, TerminalPassThroughOptions };

package/types/anguless-angulux-types-textarea.d.ts

@@ -0,0 +1,28 @@
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Textarea.pt}
+ * @group Interface
+ */
+interface TextareaPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLTextAreaElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLTextAreaElement, I>;
+}
+/**
+ * Defines valid pass-through options in Textarea.
+ * @see {@link TextareaPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TextareaPassThrough<I = unknown> = PassThrough<I, TextareaPassThroughOptions<I>>;
+
+export type { TextareaPassThrough, TextareaPassThroughOptions };

package/types/anguless-angulux-types-tieredmenu.d.ts

@@ -0,0 +1,95 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@anguless/angulux-motion';
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link TieredMenu.pt}
+ * @group Interface
+ */
+interface TieredMenuPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root list's DOM element.
+     */
+    rootList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the submenu's DOM element.
+     */
+    submenu?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the item content's DOM element.
+     */
+    itemContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the item link's DOM element.
+     */
+    itemLink?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the item icon's DOM element.
+     */
+    itemIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the item label's DOM element.
+     */
+    itemLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the submenu icon's DOM element.
+     */
+    submenuIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in TieredMenu.
+ * @see {@link TieredMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TieredMenuPassThrough<I = unknown> = PassThrough<I, TieredMenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface TieredMenuItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: any;
+    /**
+     * Whether the item has a submenu.
+     */
+    hasSubmenu: boolean;
+}
+/**
+ * Defines valid templates in TieredMenu.
+ * @group Templates
+ */
+interface TieredMenuTemplates {
+    /**
+     * Custom item template.
+     * @param {TieredMenuItemTemplateContext} context - item context.
+     */
+    item(context: TieredMenuItemTemplateContext): TemplateRef<TieredMenuItemTemplateContext>;
+    /**
+     * Custom submenu icon template.
+     */
+    submenuicon(): TemplateRef<void>;
+}
+
+export type { TieredMenuItemTemplateContext, TieredMenuPassThrough, TieredMenuPassThroughOptions, TieredMenuTemplates };

package/types/anguless-angulux-types-timeline.d.ts

@@ -0,0 +1,85 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Timeline.pt}
+ * @group Interface
+ */
+interface TimelinePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event's DOM element.
+     */
+    event?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event opposite's DOM element.
+     */
+    eventOpposite?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event separator's DOM element.
+     */
+    eventSeparator?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event marker's DOM element.
+     */
+    eventMarker?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event connector's DOM element.
+     */
+    eventConnector?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the event content's DOM element.
+     */
+    eventContent?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Timeline.
+ * @see {@link TimelinePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type TimelinePassThrough<I = unknown> = PassThrough<I, TimelinePassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @template T Type of item.
+ * @group Interface
+ */
+interface TimelineItemTemplateContext<T = any> {
+    /**
+     * Item instance.
+     */
+    $implicit: T;
+}
+/**
+ * Defines valid templates in Timeline.
+ * @group Templates
+ */
+interface TimelineTemplates<T = any> {
+    /**
+     * Custom content template.
+     * @param {TimelineItemTemplateContext} context - item data.
+     */
+    content(context: TimelineItemTemplateContext<T>): TemplateRef<TimelineItemTemplateContext<T>>;
+    /**
+     * Custom opposite item template.
+     * @param {TimelineItemTemplateContext} context - item data.
+     */
+    opposite(context: TimelineItemTemplateContext<T>): TemplateRef<TimelineItemTemplateContext<T>>;
+    /**
+     * Custom marker template.
+     * @param {TimelineItemTemplateContext} context - item data.
+     */
+    marker(context: TimelineItemTemplateContext<T>): TemplateRef<TimelineItemTemplateContext<T>>;
+}
+
+export type { TimelineItemTemplateContext, TimelinePassThrough, TimelinePassThroughOptions, TimelineTemplates };

package/types/anguless-angulux-types-toast.d.ts

@@ -0,0 +1,131 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@anguless/angulux-motion';
+import { ToastMessageOptions, PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options for Toast.
+ * @template I Type of instance.
+ *
+ * @see {@link Toast.pt}
+ * @group Interface
+ */
+interface ToastPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the message content's DOM element.
+     */
+    messageContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the message icon's DOM element.
+     */
+    messageIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message text's DOM element.
+     */
+    messageText?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the summary's DOM element.
+     */
+    summary?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the detail's DOM element.
+     */
+    detail?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the close button's DOM element.
+     */
+    closeButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the close icon's DOM element.
+     */
+    closeIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in Toast.
+ * @see {@link ToastPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ToastPassThrough<I = unknown> = PassThrough<I, ToastPassThroughOptions<I>>;
+/**
+ * Custom message template context.
+ * @group Interface
+ */
+interface ToastMessageTemplateContext {
+    /**
+     * Message instance.
+     */
+    $implicit: ToastMessageOptions | null | undefined;
+}
+/**
+ * Custom headless template context.
+ * @group Interface
+ */
+interface ToastHeadlessTemplateContext {
+    /**
+     * Message instance.
+     */
+    $implicit: ToastMessageOptions | null | undefined;
+    /**
+     * Callback to close the toast.
+     */
+    closeFn: (event: Event) => void;
+}
+/**
+ * Defines valid templates in Toast.
+ * @group Templates
+ */
+interface ToastTemplates {
+    /**
+     * Custom message template.
+     * @param {ToastMessageTemplateContext} context - message context.
+     */
+    message(context: ToastMessageTemplateContext): TemplateRef<ToastMessageTemplateContext>;
+    /**
+     * Custom headless template.
+     * @param {ToastHeadlessTemplateContext} context - headless context.
+     */
+    headless(context: ToastHeadlessTemplateContext): TemplateRef<ToastHeadlessTemplateContext>;
+}
+/**
+ * Defines the position type for Toast.
+ */
+type ToastPositionType = 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'center';
+/**
+ * Custom close event.
+ * @see {@link Toast.onClose}
+ * @group Events
+ */
+interface ToastCloseEvent {
+    /**
+     * Message of the closed element.
+     */
+    message: ToastMessageOptions;
+}
+/**
+ * Custom close event.
+ * @see {@link ToastItem.onClose}
+ */
+interface ToastItemCloseEvent extends ToastCloseEvent {
+    /**
+     * Index of the closed element.
+     */
+    index: number;
+}
+
+export type { ToastCloseEvent, ToastHeadlessTemplateContext, ToastItemCloseEvent, ToastMessageTemplateContext, ToastPassThrough, ToastPassThroughOptions, ToastPositionType, ToastTemplates };

package/types/anguless-angulux-types-togglebutton.d.ts

@@ -0,0 +1,86 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ToggleButtonProps.pt}
+ * @group Interface
+ */
+interface ToggleButtonPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type ToggleButtonPassThrough<I = unknown> = PassThrough<I, ToggleButtonPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ToggleButton.onChange}
+ * @group Events
+ */
+interface ToggleButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Checked state as a boolean.
+     */
+    checked: boolean;
+}
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface ToggleButtonIconTemplateContext {
+    /**
+     * Checked state.
+     */
+    $implicit: boolean;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ToggleButtonContentTemplateContext {
+    /**
+     * Checked state.
+     */
+    $implicit: boolean;
+}
+/**
+ * Defines valid templates in ToggleButton.
+ * @group Templates
+ */
+interface ToggleButtonTemplates {
+    /**
+     * Custom icon template.
+     * @param {ToggleButtonIconTemplateContext} context - icon context.
+     */
+    icon(context: ToggleButtonIconTemplateContext): TemplateRef<ToggleButtonIconTemplateContext>;
+    /**
+     * Custom content template.
+     * @param {ToggleButtonContentTemplateContext} context - content context.
+     */
+    content(context: ToggleButtonContentTemplateContext): TemplateRef<ToggleButtonContentTemplateContext>;
+}
+
+export type { ToggleButtonChangeEvent, ToggleButtonContentTemplateContext, ToggleButtonIconTemplateContext, ToggleButtonPassThrough, ToggleButtonPassThroughOptions, ToggleButtonTemplates };