@gravionlabs/helix-core 22.0.0

package/types/gravionlabs-helix-core-types-select.d.ts

@@ -0,0 +1,319 @@
+import { TemplateRef } from '@angular/core';
+import { ScrollerOptions, PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
+import { IconFieldPassThrough } from '@gravionlabs/helix-core/types/iconfield';
+import { InputIconPassThrough } from '@gravionlabs/helix-core/types/inputicon';
+import { InputTextPassThrough } from '@gravionlabs/helix-core/types/inputtext';
+import { OverlayPassThrough } from '@gravionlabs/helix-core/types/overlay';
+import { VirtualScrollerPassThrough } from '@gravionlabs/helix-core/types/scroller';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Select.pt}
+ * @group Interface
+ */
+interface SelectPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the label's DOM element.
+     */
+    label?: PassThroughOption<HTMLSpanElement | HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the clear icon's DOM element.
+     */
+    clearIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the dropdown's DOM element.
+     */
+    dropdown?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the loading icon's DOM element.
+     */
+    loadingIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the dropdown icon's DOM element.
+     */
+    dropdownIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Overlay component.
+     * @see {@link OverlayPassThrough}
+     */
+    pcOverlay?: OverlayPassThrough;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the filter container's DOM element.
+     */
+    pcFilterContainer?: IconFieldPassThrough;
+    /**
+     * Used to pass attributes to the filter input's DOM element.
+     */
+    pcFilter?: InputTextPassThrough;
+    /**
+     * Used to pass attributes to the filter icon container's DOM element.
+     */
+    pcFilterIconContainer?: InputIconPassThrough;
+    /**
+     * Used to pass attributes to the filter icon's DOM element.
+     */
+    filterIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the list container's DOM element.
+     */
+    listContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the VirtualScroller component.
+     * @see {@link ScrollerOptions}
+     */
+    virtualScroller?: VirtualScrollerPassThrough;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the option group's DOM element.
+     */
+    optionGroup?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option group label's DOM element.
+     */
+    optionGroupLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the option's DOM element.
+     */
+    option?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the option check icon's DOM element.
+     */
+    optionCheckIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the option blank icon's DOM element.
+     */
+    optionBlankIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the option label's DOM element.
+     */
+    optionLabel?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the empty message's DOM element.
+     */
+    emptyMessage?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the hidden first focusable element's DOM element.
+     */
+    hiddenFirstFocusableEl?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden filter result's DOM element.
+     */
+    hiddenFilterResult?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden empty message's DOM element.
+     */
+    hiddenEmptyMessage?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden selected message's DOM element.
+     */
+    hiddenSelectedMessage?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the hidden last focusable element's DOM element.
+     */
+    hiddenLastFocusableEl?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in Select component.
+ * @see {@link SelectPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SelectPassThrough<I = unknown> = PassThrough<I, SelectPassThroughOptions<I>>;
+/**
+ * Filter callbacks of the select.
+ * @group Interface
+ */
+interface SelectFilterOptions {
+    /**
+     * Filter function.
+     */
+    filter?: (value?: any) => void;
+    /**
+     * Reset function.
+     */
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link Select.onChange}
+ * @group Events
+ */
+interface SelectChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option value
+     */
+    value: any;
+}
+/**
+ * Custom filter event.
+ * @see {@link Select.onFilter}
+ * @group Events
+ */
+interface SelectFilterEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Filter value.
+     */
+    filter: any;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Select.onLazyLoad}
+ * @group Events
+ */
+interface SelectLazyLoadEvent {
+    /**
+     * Index of the first element in viewport.
+     */
+    first: number;
+    /**
+     * Index of the last element in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface SelectItemTemplateContext<T = any> {
+    /**
+     * Data of the option.
+     */
+    $implicit: T;
+}
+/**
+ * Custom selected item template context.
+ * @group Interface
+ */
+interface SelectSelectedItemTemplateContext<T = any> {
+    /**
+     * Selected option value.
+     */
+    $implicit: T;
+}
+/**
+ * Custom group template context.
+ * @group Interface
+ */
+interface SelectGroupTemplateContext<T = any> {
+    /**
+     * Group option.
+     */
+    $implicit: T;
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface SelectFilterTemplateContext {
+    /**
+     * Filter options.
+     */
+    options: SelectFilterOptions;
+}
+/**
+ * Custom loader template context.
+ * @group Interface
+ */
+interface SelectLoaderTemplateContext {
+    /**
+     * Virtual scroller options.
+     */
+    options: ScrollerOptions;
+}
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface SelectIconTemplateContext {
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
+/**
+ * Defines valid templates in Select.
+ * @group Templates
+ */
+interface SelectTemplates<T = any> {
+    /**
+     * Custom item template.
+     * @param {Object} context - item data.
+     */
+    item(context: SelectItemTemplateContext<T>): TemplateRef<SelectItemTemplateContext<T>>;
+    /**
+     * Custom selected item template.
+     * @param {Object} context - selected item data.
+     */
+    selectedItem(context: SelectSelectedItemTemplateContext<T>): TemplateRef<SelectSelectedItemTemplateContext<T>>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom filter template.
+     * @param {SelectFilterOptions} options - filter options.
+     */
+    filter(context: SelectFilterTemplateContext): TemplateRef<SelectFilterTemplateContext>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<void>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<void>;
+    /**
+     * Custom group template.
+     */
+    group(context: SelectGroupTemplateContext<T>): TemplateRef<SelectGroupTemplateContext<T>>;
+    /**
+     * Custom loader template. This template can be used with virtualScroll.
+     * @param {ScrollerOptions} options - virtual scroller options.
+     */
+    loader(context: SelectLoaderTemplateContext): TemplateRef<SelectLoaderTemplateContext>;
+    /**
+     * Custom select icon template.
+     * @param {Object} context - icon context.
+     */
+    dropdownicon(context: SelectIconTemplateContext): TemplateRef<SelectIconTemplateContext>;
+    /**
+     * Custom clear icon template.
+     * @param {Object} context - icon context.
+     */
+    clearicon(context: SelectIconTemplateContext): TemplateRef<SelectIconTemplateContext>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<void>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<void>;
+}
+
+export type { SelectChangeEvent, SelectFilterEvent, SelectFilterOptions, SelectFilterTemplateContext, SelectGroupTemplateContext, SelectIconTemplateContext, SelectItemTemplateContext, SelectLazyLoadEvent, SelectLoaderTemplateContext, SelectPassThrough, SelectPassThroughOptions, SelectSelectedItemTemplateContext, SelectTemplates };

package/types/gravionlabs-helix-core-types-selectbutton.d.ts

@@ -0,0 +1,92 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
+import { ToggleButtonPassThrough } from '@gravionlabs/helix-core/types/togglebutton';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link SelectButton.pt}
+ * @group Interface
+ */
+interface SelectButtonPassThroughOptions<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 ToggleButton component.
+     * @see {@link ToggleButtonPassThrough}
+     */
+    pcToggleButton?: ToggleButtonPassThrough;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type SelectButtonPassThrough<I = unknown> = PassThrough<I, SelectButtonPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link SelectButton.onChange}
+ * @group Events
+ */
+interface SelectButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option.
+     */
+    value?: any;
+}
+/**
+ * Custom option click event.
+ * @see {@link SelectButton.onOptionClick}
+ * @group Events
+ */
+interface SelectButtonOptionClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option.
+     */
+    option?: any;
+    /**
+     * Index of the selected option.
+     */
+    index?: number;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface SelectButtonItemTemplateContext {
+    /**
+     * Option instance.
+     */
+    $implicit: any;
+    /**
+     * Index of the option.
+     */
+    index: number;
+}
+/**
+ * Defines valid templates in SelectButton.
+ * @group Templates
+ */
+interface SelectButtonTemplates {
+    /**
+     * Custom item template.
+     * @param {SelectButtonItemTemplateContext} context - item context.
+     */
+    item(context: SelectButtonItemTemplateContext): TemplateRef<SelectButtonItemTemplateContext>;
+}
+
+export type { SelectButtonChangeEvent, SelectButtonItemTemplateContext, SelectButtonOptionClickEvent, SelectButtonPassThrough, SelectButtonPassThroughOptions, SelectButtonTemplates };

package/types/gravionlabs-helix-core-types-skeleton.d.ts

@@ -0,0 +1,28 @@
+import { PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Skeleton.pt}
+ * @group Interface
+ */
+interface SkeletonPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in Skeleton.
+ * @see {@link SkeletonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SkeletonPassThrough<I = unknown> = PassThrough<I, SkeletonPassThroughOptions<I>>;
+
+export type { SkeletonPassThrough, SkeletonPassThroughOptions };

package/types/gravionlabs-helix-core-types-slider.d.ts

@@ -0,0 +1,78 @@
+import { PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
+
+/**
+ * Custom passthrough(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Slider.pt}
+ * @group Interface
+ */
+interface SliderPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the range's DOM element.
+     */
+    range?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the handle's DOM element.
+     */
+    handle?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the start handler's DOM element.
+     */
+    startHandler?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the end handler's DOM element.
+     */
+    endHandler?: PassThroughOption<HTMLSpanElement, I>;
+}
+/**
+ * Defines valid pass-through options in Slider component.
+ * @see {@link SliderPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SliderPassThrough<I = unknown> = PassThrough<I, SliderPassThroughOptions<I>>;
+/**
+ * Custom change event.
+ * @see {@link Slider.onChange}
+ * @group Events
+ */
+interface SliderChangeEvent {
+    /**
+     * Browser event.
+     */
+    event: Event;
+    /**
+     * New values.
+     */
+    values?: number[];
+    /**
+     * New value.
+     */
+    value?: number;
+}
+/**
+ * Custom slide end event.
+ * @see {@link Slider.onSlideEnd}
+ * @group Events
+ */
+interface SliderSlideEndEvent {
+    /**
+     * Original event
+     */
+    originalEvent: Event;
+    /**
+     * New value.
+     */
+    value?: number;
+    /**
+     * New values.
+     */
+    values?: number[];
+}
+
+export type { SliderChangeEvent, SliderPassThrough, SliderPassThroughOptions, SliderSlideEndEvent };

package/types/gravionlabs-helix-core-types-speeddial.d.ts

@@ -0,0 +1,100 @@
+import { TemplateRef } from '@angular/core';
+import { MenuItem, PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
+import { ButtonPassThrough } from '@gravionlabs/helix-core/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link SpeedDial.pt}
+ * @group Interface
+ */
+interface SpeedDialPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the list's DOM element.
+     */
+    list?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the action's Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcAction?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the action icon's DOM element.
+     */
+    actionIcon?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in SpeedDial component.
+ * @see {@link SpeedDialPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SpeedDialPassThrough<I = unknown> = PassThrough<I, SpeedDialPassThroughOptions<I>>;
+/**
+ * Custom button template context.
+ * @group Interface
+ */
+interface SpeedDialButtonTemplateContext {
+    /**
+     * Callback to toggle the speed dial visibility.
+     */
+    toggleCallback: (event: MouseEvent) => void;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface SpeedDialItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+    /**
+     * Index of the item.
+     */
+    index: number;
+    /**
+     * Callback to handle item click.
+     */
+    toggleCallback: (event: Event, item: MenuItem) => void;
+}
+/**
+ * Defines valid templates in SpeedDial.
+ * @group Templates
+ */
+interface SpeedDialTemplates {
+    /**
+     * Custom button template.
+     * @param {SpeedDialButtonTemplateContext} context - button context.
+     */
+    button(context: SpeedDialButtonTemplateContext): TemplateRef<SpeedDialButtonTemplateContext>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+    /**
+     * Custom item template.
+     * @param {SpeedDialItemTemplateContext} context - item context.
+     */
+    item(context: SpeedDialItemTemplateContext): TemplateRef<SpeedDialItemTemplateContext>;
+}
+
+export type { SpeedDialButtonTemplateContext, SpeedDialItemTemplateContext, SpeedDialPassThrough, SpeedDialPassThroughOptions, SpeedDialTemplates };

package/types/gravionlabs-helix-core-types-splitbutton.d.ts

@@ -0,0 +1,70 @@
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from '@gravionlabs/helix-core/api';
+import { ButtonPassThrough } from '@gravionlabs/helix-core/types/button';
+import { MenuPassThrough } from '@gravionlabs/helix-core/types/menu';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link SplitButton.pt}
+ * @group Interface
+ */
+interface SplitButtonPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the dropdown Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcDropdown?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the TieredMenu component.
+     */
+    pcMenu?: MenuPassThrough;
+}
+/**
+ * Defines valid pass-through options in SplitButton component.
+ * @see {@link SplitButtonPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type SplitButtonPassThrough<I = unknown> = PassThrough<I, SplitButtonPassThroughOptions<I>>;
+/**
+ * Defines valid templates in SplitButton.
+ * @group Templates
+ */
+interface SplitButtonTemplates {
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<void>;
+    /**
+     * Custom dropdown icon template.
+     */
+    dropdownicon(): TemplateRef<void>;
+}
+/**
+ * Defines ButtonProps interface.
+ */
+interface ButtonProps {
+    ariaLabel?: string;
+}
+/**
+ * Defines MenuButtonProps interface.
+ */
+interface MenuButtonProps {
+    ariaLabel?: string;
+    ariaHasPopup?: boolean;
+    ariaExpanded?: boolean;
+    ariaControls?: string;
+}
+
+export type { ButtonProps, MenuButtonProps, SplitButtonPassThrough, SplitButtonPassThroughOptions, SplitButtonTemplates };