primenglab 22.0.0-beta.1

package/types/primenglab-types-menubar.d.ts

@@ -0,0 +1,171 @@
+import { TemplateRef } from '@angular/core';
+import { MenuItem, PassThrough, PassThroughOption } from 'primenglab/api';
+import { BadgePassThrough } from 'primenglab/types/badge';
+import { CSSProperties } from 'primenglab/types/shared';
+
+/**
+ * Processed menu item structure used internally.
+ */
+interface ProcessedMenuItem {
+    item: MenuItem;
+    index: number;
+    level: number;
+    key: string;
+    parent: ProcessedMenuItem | Record<string, never>;
+    parentKey: string;
+    items?: ProcessedMenuItem[];
+}
+/**
+ * Focused item info structure.
+ */
+interface FocusedItemInfo {
+    index: number;
+    level: number;
+    parentKey: string;
+    item: MenuItem | null;
+}
+/**
+ * Item click event.
+ * @group Events
+ */
+interface MenubarItemClickEvent {
+    originalEvent: Event;
+    processedItem: ProcessedMenuItem;
+    isFocus?: boolean;
+}
+/**
+ * Item mouse enter event.
+ * @group Events
+ */
+interface MenubarItemMouseEnterEvent {
+    originalEvent: Event;
+    processedItem: ProcessedMenuItem;
+}
+/**
+ * Menubar inline styles.
+ * @group Interface
+ */
+interface MenubarInlineStyles {
+    root?: CSSProperties;
+    submenu?: CSSProperties;
+}
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Menubar.pt}
+ * @group Interface
+ */
+interface MenubarPassThroughOptions<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 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 attributes to the separator's DOM element.
+     */
+    separator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the mobile menu button's DOM element.
+     */
+    button?: PassThroughOption<HTMLAnchorElement, I>;
+    /**
+     * Used to pass attributes to the mobile menu button icon's DOM element.
+     */
+    buttonIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the submenu's DOM element.
+     */
+    submenu?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the start of the component.
+     */
+    start?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the end of the component.
+     */
+    end?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to Badge component.
+     * @see {@link BadgePassThrough}
+     */
+    pcBadge?: BadgePassThrough;
+}
+/**
+ * Defines valid pass-through options in Menubar.
+ * @see {@link MenubarPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MenubarPassThrough<I = unknown> = PassThrough<I, MenubarPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface MenubarItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+    /**
+     * Whether the item is at the root level.
+     */
+    root: boolean;
+}
+/**
+ * Defines valid templates in Menubar.
+ * @group Templates
+ */
+interface MenubarTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item context.
+     */
+    item(context: MenubarItemTemplateContext): TemplateRef<MenubarItemTemplateContext>;
+    /**
+     * Custom template of start.
+     */
+    start(): TemplateRef<void>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<void>;
+    /**
+     * Custom template of menu icon.
+     */
+    menuicon(): TemplateRef<void>;
+    /**
+     * Custom template of submenu icon.
+     */
+    submenuicon(): TemplateRef<void>;
+}
+
+export type { FocusedItemInfo, MenubarInlineStyles, MenubarItemClickEvent, MenubarItemMouseEnterEvent, MenubarItemTemplateContext, MenubarPassThrough, MenubarPassThroughOptions, MenubarTemplates, ProcessedMenuItem };

package/types/primenglab-types-message.d.ts

@@ -0,0 +1,112 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Message severity type.
+ * @group Types
+ */
+type MessageSeverity = 'success' | 'info' | 'warn' | 'error' | 'secondary' | 'contrast';
+/**
+ * Message variant type.
+ * @group Types
+ */
+type MessageVariant = 'outlined' | 'text' | 'simple';
+/**
+ * Message size type.
+ * @group Types
+ */
+type MessageSize = 'large' | 'small';
+/**
+ * Message close event.
+ * @group Interface
+ */
+interface MessageCloseEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+}
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Message.pt}
+ * @group Interface
+ */
+interface MessagePassThroughOptions<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 content's DOM element.
+     */
+    contentWrapper?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the icon's DOM element.
+     */
+    icon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the text's DOM element.
+     */
+    text?: PassThroughOption<HTMLSpanElement, 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 Message.
+ * @see {@link MessagePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MessagePassThrough<I = unknown> = PassThrough<I, MessagePassThroughOptions<I>>;
+/**
+ * Custom container template context.
+ * @group Interface
+ */
+interface MessageContainerTemplateContext {
+    /**
+     * Callback to close the message.
+     */
+    closeCallback: (event: Event) => void;
+}
+/**
+ * Defines valid templates in Message.
+ * @group Templates
+ */
+interface MessageTemplates {
+    /**
+     * Custom container template.
+     * @param {Object} context - container context.
+     */
+    container(context: MessageContainerTemplateContext): TemplateRef<MessageContainerTemplateContext>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<void>;
+}
+
+export type { MessageCloseEvent, MessageContainerTemplateContext, MessagePassThrough, MessagePassThroughOptions, MessageSeverity, MessageSize, MessageTemplates, MessageVariant };

package/types/primenglab-types-metergroup.d.ts

@@ -0,0 +1,178 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+type MeterGroupOrientation = 'horizontal' | 'vertical';
+type MeterGroupLabelPosition = 'start' | 'end';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link MeterGroup.pt}
+ * @group Interface
+ */
+interface MeterGroupPassThroughOptions<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 meters' DOM element.
+     */
+    meters?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the meter's DOM element.
+     */
+    meter?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label list's DOM element.
+     */
+    labelList?: PassThroughOption<HTMLOListElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the label icon's DOM element.
+     */
+    labelIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the label marker's DOM element.
+     */
+    labelMarker?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label text's DOM element.
+     */
+    labelText?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in MeterGroup.
+ * @see {@link MeterGroupPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MeterGroupPassThrough<I = unknown> = PassThrough<I, MeterGroupPassThroughOptions<I>>;
+/**
+ * Custom label template context.
+ * @group Interface
+ */
+interface MeterGroupLabelTemplateContext {
+    /**
+     * Array of meter items.
+     */
+    $implicit: MeterItem[];
+    /**
+     * Total percent of the metergroup items.
+     */
+    totalPercent: number;
+    /**
+     * Array of sequential sum of values of metergroup items.
+     */
+    percentages: number[];
+}
+/**
+ * Custom meter template context.
+ * @group Interface
+ */
+interface MeterGroupMeterTemplateContext {
+    /**
+     * Current meter item.
+     */
+    $implicit: MeterItem;
+    /**
+     * Current index of the meter item.
+     */
+    index: number;
+    /**
+     * Current orientation of the component.
+     */
+    orientation: MeterGroupOrientation;
+    /**
+     * Style class of the meter item.
+     */
+    class: string;
+    /**
+     * Size (width/height percentage) of the meter item.
+     */
+    size: string;
+    /**
+     * Total percent of all metergroup items.
+     */
+    totalPercent: number;
+    /**
+     * DataP attributes.
+     */
+    dataP: string;
+}
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface MeterGroupIconTemplateContext {
+    /**
+     * Current meter item.
+     */
+    $implicit: MeterItem;
+    /**
+     * Icon class of the meter item.
+     */
+    icon: string | undefined;
+}
+/**
+ * Defines valid templates in MeterGroup.
+ * @group Templates
+ */
+interface MeterGroupTemplates {
+    /**
+     * Custom label template.
+     * @param {Object} context - label context.
+     */
+    label(context: MeterGroupLabelTemplateContext): TemplateRef<MeterGroupLabelTemplateContext>;
+    /**
+     * Custom meter item template.
+     * @param {Object} context - meter context.
+     */
+    meter(context: MeterGroupMeterTemplateContext): TemplateRef<MeterGroupMeterTemplateContext>;
+    /**
+     * Custom start template.
+     * @param {Object} context - start context.
+     */
+    start(context: MeterGroupLabelTemplateContext): TemplateRef<MeterGroupLabelTemplateContext>;
+    /**
+     * Custom end template.
+     * @param {Object} context - end context.
+     */
+    end(context: MeterGroupLabelTemplateContext): TemplateRef<MeterGroupLabelTemplateContext>;
+    /**
+     * Custom icon template.
+     * @param {Object} context - icon context.
+     */
+    icon(context: MeterGroupIconTemplateContext): TemplateRef<MeterGroupIconTemplateContext>;
+}
+/**
+ * Represents a meter item configuration.
+ * @group Interface
+ */
+interface MeterItem {
+    /**
+     * Label of the meter item.
+     */
+    label?: string;
+    /**
+     * Value of the meter item.
+     */
+    value?: number;
+    /**
+     * Color of the meter item.
+     */
+    color?: string;
+    /**
+     * Icon of the meter item.
+     */
+    icon?: string;
+}
+
+export type { MeterGroupIconTemplateContext, MeterGroupLabelPosition, MeterGroupLabelTemplateContext, MeterGroupMeterTemplateContext, MeterGroupOrientation, MeterGroupPassThrough, MeterGroupPassThroughOptions, MeterGroupTemplates, MeterItem };

package/types/primenglab-types-motion.d.ts

@@ -0,0 +1,26 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link Motion.pt}
+ * @group Interface
+ */
+interface MotionPassThroughOptions<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<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in Motion component.
+ * @see {@link MotionPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type MotionPassThrough<I = unknown> = PassThrough<I, MotionPassThroughOptions<I>>;
+
+export type { MotionPassThrough, MotionPassThroughOptions };