@anguless/angulux 22.0.0-rc.0

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

@@ -0,0 +1,71 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Chip.pt}
+ * @group Interface
+ */
+interface ChipPassThroughOptions<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 image's DOM element.
+     */
+    image?: PassThroughOption<HTMLImageElement, 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<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the remove icon's DOM element.
+     */
+    removeIcon?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Chip component.
+ * @see {@link ChipPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ChipPassThrough<I = unknown> = PassThrough<I, ChipPassThroughOptions<I>>;
+/**
+ * Defines valid templates in Chip.
+ * @group Templates
+ */
+interface ChipTemplates {
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<void>;
+    /**
+     * Custom remove icon template.
+     */
+    removeicon(): TemplateRef<void>;
+}
+interface ChipProps {
+    label?: string;
+    icon?: string | undefined;
+    image?: string | undefined;
+    alt?: string | undefined;
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    styleClass?: string | undefined;
+    removable?: boolean | undefined;
+    removeIcon?: string | undefined;
+}
+
+export type { ChipPassThrough, ChipPassThroughOptions, ChipProps, ChipTemplates };

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

@@ -0,0 +1,78 @@
+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 ColorPicker.pt}
+ * @group Interface
+ */
+interface ColorPickerPassThroughOptions<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 preview input's DOM element.
+     */
+    preview?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the panel's DOM element.
+     */
+    panel?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the color selector's DOM element.
+     */
+    colorSelector?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the color background's DOM element.
+     */
+    colorBackground?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the color handle's DOM element.
+     */
+    colorHandle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hue's DOM element.
+     */
+    hue?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the hue handle's DOM element.
+     */
+    hueHandle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type ColorPickerPassThrough<I = unknown> = PassThrough<I, ColorPickerPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link ColorPicker.onChange}
+ * @group Events
+ */
+interface ColorPickerChangeEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Selected color value.
+     */
+    value: string | object;
+}
+
+export type { ColorPickerChangeEvent, ColorPickerPassThrough, ColorPickerPassThroughOptions };

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

@@ -0,0 +1,147 @@
+import { TemplateRef } from '@angular/core';
+import { Confirmation, PassThrough, PassThroughOption } from '@anguless/angulux/api';
+import { DialogPassThrough } from '@anguless/angulux/types/dialog';
+import { ButtonPassThrough } from '@anguless/angulux/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ConfirmDialog.pt}
+ * @group Interface
+ */
+interface ConfirmDialogPassThroughOptions<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.
+     * @see {@link DialogPassThrough}
+     */
+    root?: DialogPassThrough;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the resize handle's DOM element.
+     */
+    resizeHandle?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the title's DOM element.
+     */
+    title?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the header actions' DOM element.
+     */
+    headerActions?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the close Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcCloseButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the accept Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAcceptButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the reject Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcRejectButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in ConfirmDialog.
+ * @see {@link ConfirmDialogPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ConfirmDialogPassThrough<I = unknown> = PassThrough<I, ConfirmDialogPassThroughOptions<I>>;
+/**
+ * Custom headless template context.
+ * @group Interface
+ */
+interface ConfirmDialogHeadlessTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+    /**
+     * Callback to accept the confirmation.
+     */
+    onAccept: () => void;
+    /**
+     * Callback to reject the confirmation.
+     */
+    onReject: () => void;
+}
+/**
+ * Custom message template context.
+ * @group Interface
+ */
+interface ConfirmDialogMessageTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+}
+/**
+ * Defines valid templates in ConfirmDialog.
+ * @group Templates
+ */
+interface ConfirmDialogTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom message template.
+     * @param {Object} context - message context.
+     */
+    message(context: ConfirmDialogMessageTemplateContext): TemplateRef<ConfirmDialogMessageTemplateContext>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+    /**
+     * Custom reject icon template.
+     */
+    rejecticon(): TemplateRef<void>;
+    /**
+     * Custom accept icon template.
+     */
+    accepticon(): TemplateRef<void>;
+    /**
+     * Custom headless template.
+     * @param {Object} context - headless context.
+     */
+    headless(context: ConfirmDialogHeadlessTemplateContext): TemplateRef<ConfirmDialogHeadlessTemplateContext>;
+}
+
+export type { ConfirmDialogHeadlessTemplateContext, ConfirmDialogMessageTemplateContext, ConfirmDialogPassThrough, ConfirmDialogPassThroughOptions, ConfirmDialogTemplates };

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

@@ -0,0 +1,105 @@
+import { Confirmation, PassThrough, PassThroughOption } from '@anguless/angulux/api';
+import { ButtonPassThrough } from '@anguless/angulux/types/button';
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@anguless/angulux-motion';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ConfirmPopup.pt}
+ * @group Interface
+ */
+interface ConfirmPopupPassThroughOptions<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 content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the message's DOM element.
+     */
+    message?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the reject Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcRejectButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the accept Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAcceptButton?: ButtonPassThrough;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in ConfirmPopup.
+ * @see {@link ConfirmPopupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ConfirmPopupPassThrough<I = unknown> = PassThrough<I, ConfirmPopupPassThroughOptions<I>>;
+/**
+ * Custom headless template context.
+ * @group Interface
+ */
+interface ConfirmPopupHeadlessTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ConfirmPopupContentTemplateContext {
+    /**
+     * Confirmation instance.
+     */
+    $implicit: Confirmation | null | undefined;
+}
+/**
+ * Defines valid templates in ConfirmPopup.
+ * @group Templates
+ */
+interface ConfirmPopupTemplates {
+    /**
+     * Custom content template.
+     * @param {Object} context - content context.
+     */
+    content(context: ConfirmPopupContentTemplateContext): TemplateRef<ConfirmPopupContentTemplateContext>;
+    /**
+     * Custom reject icon template.
+     */
+    rejecticon(): TemplateRef<void>;
+    /**
+     * Custom accept icon template.
+     */
+    accepticon(): TemplateRef<void>;
+    /**
+     * Custom headless template.
+     * @param {Object} context - headless context.
+     */
+    headless(context: ConfirmPopupHeadlessTemplateContext): TemplateRef<ConfirmPopupHeadlessTemplateContext>;
+}
+
+export type { ConfirmPopupContentTemplateContext, ConfirmPopupHeadlessTemplateContext, ConfirmPopupPassThrough, ConfirmPopupPassThroughOptions, ConfirmPopupTemplates };

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

@@ -0,0 +1,102 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@anguless/angulux-motion';
+import { MenuItem, PassThrough, PassThroughOption } from '@anguless/angulux/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ContextMenu.pt}
+ * @group Interface
+ */
+interface ContextMenuPassThroughOptions<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 separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, 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<SVGElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in ContextMenu.
+ * @see {@link ContextMenuPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ContextMenuPassThrough<I = unknown> = PassThrough<I, ContextMenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface ContextMenuItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+}
+/**
+ * Custom submenu icon template context.
+ * @group Interface
+ */
+interface ContextMenuSubmenuIconTemplateContext {
+    /**
+     * Style class of the submenu icon.
+     */
+    class: string;
+}
+/**
+ * Defines valid templates in ContextMenu.
+ * @group Templates
+ */
+interface ContextMenuTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item context.
+     */
+    item(context: ContextMenuItemTemplateContext): TemplateRef<ContextMenuItemTemplateContext>;
+    /**
+     * Custom submenu icon template.
+     * @param {Object} context - icon context.
+     */
+    submenuicon(context: ContextMenuSubmenuIconTemplateContext): TemplateRef<ContextMenuSubmenuIconTemplateContext>;
+}
+
+export type { ContextMenuItemTemplateContext, ContextMenuPassThrough, ContextMenuPassThroughOptions, ContextMenuSubmenuIconTemplateContext, ContextMenuTemplates };