vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

parent updates for .d.ts files and apidoc

pull/4931/head
tugcekucukoglu 2023-12-05 10:06:55 +03:00
parent da84f55507
commit 8eea973282
30 changed files with 1171 additions and 393 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/doc/DocApiTable.vue
View File

@ -29,14 +29,14 @@
<template v-for="(value, i) in getType(v)" :key="value">
<span v-if="i !== 0" class="doc-option-type">{{ ' | ' }}</span>
<NuxtLink v-if="isLinkType(value)" :to="setLinkPath(value)" class="doc-option-type doc-option-link">{{ value }}</NuxtLink
><span v-else class="doc-option-type">{{ value }}</span>
><span v-else class="doc-option-type">{{ value ==='T'? 'any': value }}</span>
</template>
</template>
<template v-else-if="k === 'options'">
<template v-for="val in v" :key="val.name">
<div class="doc-option-type-options-container">
{{ val.name }}: <span class="doc-option-type-options doc-option-type">{{ val.type }}</span>
{{ val.name }}: <span class="doc-option-type-options doc-option-type">{{ (val.type === 'T' || val.type.includes('<T>')) ? 'any' : val.type }}</span>
</div>
</template>
</template>
@ -111,7 +111,7 @@ export default {
});
},
isLinkType(value) {
if (this.label === 'Slots') return false;
if (this.label === 'Slots' || value.includes('SharedPassThroughOption') || value.includes('PassThrough<')) return false;
const validValues = ['confirmationoptions', 'toastmessageoptions'];
return value.toLowerCase().includes(this.id.split('.')[1]) || validValues.includes(value.toLowerCase());

13
components/doc/helpers/PTHelper.js
View File

@ -7,10 +7,21 @@ export const getPTOption = (name) => {
for (const [i, prop] of props.entries()) {
if (options) {
let subCompName, subOptions;
let hasSubComp = prop.name !== 'hooks' && prop.type.indexOf('TransitionType') === -1 && prop.type.indexOf('<') > -1 && name.toLowerCase() !== prop.type.slice(0, prop.type.indexOf('<')).toLowerCase();
if (hasSubComp) {
subCompName = prop.type.slice(0, prop.type.indexOf('<')).replace('PassThroughOptions', '').replace('PassThroughOptionType', '');
subOptions = APIDocs[subCompName.toLowerCase()].interfaces.values[`${subCompName}PassThroughMethodOptions`];
const objToReplace = subOptions.props.find((opt) => opt.name === 'parent');
objToReplace.type = prop.type;
}
data.push({
value: i + 1,
label: prop.name,
options: options?.props,
options: hasSubComp ? subOptions?.props : options?.props,
description: prop.description
});
} else {

19
components/lib/autocomplete/AutoComplete.d.ts vendored
View File

@ -9,7 +9,7 @@
*/
import { HTMLAttributes, InputHTMLAttributes, TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptionType } from '../button';
import { ButtonPassThroughOptions } from '../button';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
import { VirtualScrollerItemOptions, VirtualScrollerPassThroughOptionType, VirtualScrollerProps } from '../virtualscroller';
@ -44,6 +44,20 @@ export interface AutoCompletePassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface AutoCompleteSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: AutoCompleteProps;
/**
* Defines current inline state.
*/
state: AutoCompleteState;
}
/**
* Custom change event.
* @see {@link AutoCompleteEmits.change}
@ -150,8 +164,9 @@ export interface AutoCompletePassThroughOptions {
loadingIcon?: AutoCompletePassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
dropdownButton?: ButtonPassThroughOptionType;
dropdownButton?: ButtonPassThroughOptions<AutoCompleteSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the panel's DOM element.
*/

12
components/lib/badge/Badge.d.ts vendored
View File

@ -12,12 +12,12 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type BadgePassThroughOptionType = BadgePassThroughAttributes | ((options: BadgePassThroughMethodOptions) => BadgePassThroughAttributes | string) | string | null | undefined;
export declare type BadgePassThroughOptionType<T = any> = BadgePassThroughAttributes | ((options: BadgePassThroughMethodOptions<T>) => BadgePassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface BadgePassThroughMethodOptions {
export interface BadgePassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -30,6 +30,10 @@ export interface BadgePassThroughMethodOptions {
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
/**
* Defines parent instance.
*/
parent: T;
}
/**
@ -43,11 +47,11 @@ export interface BadgePassThroughAttributes {
* Custom passthrough(pt) options.
* @see {@link BadgeProps.pt}
*/
export interface BadgePassThroughOptions {
export interface BadgePassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: BadgePassThroughOptionType;
root?: BadgePassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

20
components/lib/button/Button.d.ts vendored
View File

@ -12,12 +12,12 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type ButtonPassThroughOptionType = ButtonPassThroughAttributes | ((options: ButtonPassThroughMethodOptions) => ButtonPassThroughAttributes | string) | string | null | undefined;
export declare type ButtonPassThroughOptionType<T = any> = ButtonPassThroughAttributes | ((options: ButtonPassThroughMethodOptions<T>) => ButtonPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface ButtonPassThroughMethodOptions {
export interface ButtonPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -33,7 +33,7 @@ export interface ButtonPassThroughMethodOptions {
/**
* Defines parent instance.
*/
parent: any;
parent: T;
/**
* Defines passthrough(pt) options in global config.
*/
@ -44,27 +44,27 @@ export interface ButtonPassThroughMethodOptions {
* Custom passthrough(pt) options.
* @see {@link ButtonProps.pt}
*/
export interface ButtonPassThroughOptions {
export interface ButtonPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: ButtonPassThroughOptionType;
root?: ButtonPassThroughOptionType<T>;
/**
* Used to pass attributes to the loading icon's DOM element.
*/
loadingIcon?: ButtonPassThroughOptionType;
loadingIcon?: ButtonPassThroughOptionType<T>;
/**
* Used to pass attributes to the icon's DOM element.
*/
icon?: ButtonPassThroughOptionType;
icon?: ButtonPassThroughOptionType<T>;
/**
* Used to pass attributes to the label's DOM element.
*/
label?: ButtonPassThroughOptionType;
label?: ButtonPassThroughOptionType<T>;
/**
* Used to pass attributes to the badge's DOM element.
*/
badge?: ButtonPassThroughOptionType;
badge?: ButtonPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}
@ -171,7 +171,7 @@ export interface ButtonProps extends ButtonHTMLAttributes {
* Used to pass attributes to DOM elements inside the component.
* @type {ButtonPassThroughOptions}
*/
pt?: PassThrough<ButtonPassThroughOptions>;
pt?: PassThrough<ButtonPassThroughOptions<any>>;
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}

36
components/lib/calendar/Calendar.d.ts vendored
View File

@ -9,7 +9,7 @@
*/
import { HTMLAttributes, InputHTMLAttributes, TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptionType } from '../button';
import { ButtonPassThroughOptions } from '../button';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
@ -43,6 +43,20 @@ export interface CalendarPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface CalendarSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: CalendarProps;
/**
* Defines current inline state.
*/
state: CalendarState;
}
/**
* Custom Calendar responsive options metadata.
*/
@ -117,9 +131,9 @@ export interface CalendarPassThroughOptions {
input?: CalendarPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
dropdownButton?: ButtonPassThroughOptionType;
dropdownButton?: ButtonPassThroughOptions<CalendarSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the panel's DOM element.
*/
@ -138,9 +152,9 @@ export interface CalendarPassThroughOptions {
header?: CalendarPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
previousButton?: ButtonPassThroughOptionType;
previousButton?: ButtonPassThroughOptions<CalendarSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the title's DOM element.
*/
@ -159,9 +173,9 @@ export interface CalendarPassThroughOptions {
decadeTitle?: CalendarPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
nextButton?: ButtonPassThroughOptionType;
nextButton?: ButtonPassThroughOptions<CalendarSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the container's DOM element.
*/
@ -288,14 +302,14 @@ export interface CalendarPassThroughOptions {
buttonbar?: CalendarPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
todayButton?: ButtonPassThroughOptionType;
todayButton?: ButtonPassThroughOptions<CalendarSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
clearButton?: ButtonPassThroughOptionType;
clearButton?: ButtonPassThroughOptions<CalendarSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the aria selected day's DOM element.
*/

36
components/lib/column/Column.d.ts vendored
View File

@ -11,7 +11,7 @@
import { VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptionType } from '../button';
import { ButtonPassThroughOptions } from '../button';
import { DataTablePassThroughOptions } from '../datatable';
import { DropdownPassThroughOptionType } from '../dropdown';
import { PassThroughOptions } from '../passthrough';
@ -46,6 +46,20 @@ export interface ColumnPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface ColumnSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: ColumnProps;
/**
* Defines parent instance.
*/
parent: DataTablePassThroughOptions;
}
/**
* Filter model metadata.
*/
@ -194,7 +208,7 @@ export interface ColumnPassThroughOptions {
* Used to pass attributes to the Dropdown component.
* @see {@link DropdownPassThroughOptionType}
*/
filterOperatorDropdown?: DropdownPassThroughOptionType;
filterOperatorDropdown?: DropdownPassThroughOptionType<ColumnSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the filter constraints' DOM element.
*/
@ -207,39 +221,39 @@ export interface ColumnPassThroughOptions {
* Used to pass attributes to the Dropdown component.
* @see {@link DropdownPassThroughOptionType}
*/
filterMatchModeDropdown?: DropdownPassThroughOptionType;
filterMatchModeDropdown?: DropdownPassThroughOptionType<ColumnSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the filter remove button container's DOM element.
*/
filterRemove?: ColumnPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
filterRemoveButton?: ButtonPassThroughOptionType;
filterRemoveButton?: ButtonPassThroughOptions<ColumnSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the filter add rule's DOM element.
*/
filterAddRule?: ColumnPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
filterAddRuleButton?: ButtonPassThroughOptionType;
filterAddRuleButton?: ButtonPassThroughOptions<ColumnSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the filter buttonbar's DOM element.
*/
filterButtonbar?: ColumnPassThroughOptionType;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
filterClearButton?: ButtonPassThroughOptionType;
filterClearButton?: ButtonPassThroughOptions<ColumnSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptionType}
* @see {@link ButtonPassThroughOptions}
*/
filterApplyButton?: ButtonPassThroughOptionType;
filterApplyButton?: ButtonPassThroughOptions<ColumnSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the body cell's DOM element.
*/

18
components/lib/confirmdialog/ConfirmDialog.d.ts vendored
View File

@ -38,6 +38,20 @@ export interface ConfirmDialogPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface ConfirmDialogSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: ConfirmDialogProps;
/**
* Defines current inline state.
*/
state: ConfirmDialogState;
}
/**
* Custom passthrough(pt) options.
* @see {@link ConfirmDialogProps.pt}
@ -87,12 +101,12 @@ export interface ConfirmDialogPassThroughOptions {
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
rejectButton?: ButtonPassThroughOptions;
rejectButton?: ButtonPassThroughOptions<ConfirmDialogSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
acceptButton?: ButtonPassThroughOptions;
acceptButton?: ButtonPassThroughOptions<ConfirmDialogSharedPassThroughMethodOptions>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

18
components/lib/confirmpopup/ConfirmPopup.d.ts vendored
View File

@ -40,6 +40,20 @@ export interface ConfirmPopupPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface ConfirmPopupSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: ConfirmPopupProps;
/**
* Defines current inline state.
*/
state: ConfirmPopupState;
}
/**
* Custom passthrough(pt) options.
* @see {@link ConfirmPopupProps.pt}
@ -69,12 +83,12 @@ export interface ConfirmPopupPassThroughOptions {
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
rejectButton?: ButtonPassThroughOptions;
rejectButton?: ButtonPassThroughOptions<ConfirmPopupSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
acceptButton?: ButtonPassThroughOptions;
acceptButton?: ButtonPassThroughOptions<ConfirmPopupSharedPassThroughMethodOptions>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

16
components/lib/datatable/DataTable.d.ts vendored
View File

@ -47,6 +47,20 @@ export interface DataTablePassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface DataTableSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: DataTableProps;
/**
* Defines current inline state.
*/
state: DataTableState;
}
/**
* Custom datatable export metadata.
*/
@ -582,7 +596,7 @@ export interface DataTablePassThroughOptions {
* Used to pass attributes to the Paginator component.
* @see {@link PaginatorPassThroughOptionType}
*/
paginator?: PaginatorPassThroughOptionType;
paginator?: PaginatorPassThroughOptionType<DataTableSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the wrapper's DOM element.
*/

17
components/lib/dataview/DataView.d.ts vendored
View File

@ -36,6 +36,21 @@ export interface DataViewPassThroughMethodOptions {
*/
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface DataViewSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: DataViewProps;
/**
* Defines current inline state.
*/
state: DataViewState;
}
/**
* Custom page event.
* @see {@link DataViewEmits.page}
@ -76,7 +91,7 @@ export interface DataViewPassThroughOptions {
* Used to pass attributes to the Paginator component.
* @see {@link PaginatorPassThroughOptionType}
*/
paginator?: PaginatorPassThroughOptionType;
paginator?: PaginatorPassThroughOptionType<DataViewSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the content's DOM element.
*/

36
components/lib/dialog/Dialog.d.ts vendored
View File

@ -12,14 +12,14 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type DialogPassThroughOptionType = DialogPassThroughAttributes | ((options: DialogPassThroughMethodOptions) => DialogPassThroughAttributes | string) | string | null | undefined;
export declare type DialogPassThroughOptionType<T = any> = DialogPassThroughAttributes | ((options: DialogPassThroughMethodOptions<T>) => DialogPassThroughAttributes | string) | string | null | undefined;
export declare type DialogPassThroughTransitionType = TransitionProps | ((options: DialogPassThroughMethodOptions) => TransitionProps) | undefined;
export declare type DialogPassThroughTransitionType<T = any> = TransitionProps | ((options: DialogPassThroughMethodOptions<T>) => TransitionProps) | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface DialogPassThroughMethodOptions {
export interface DialogPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -32,6 +32,10 @@ export interface DialogPassThroughMethodOptions {
* Defines current inline state.
*/
state: DialogState;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines passthrough(pt) options in global config.
*/
@ -42,51 +46,51 @@ export interface DialogPassThroughMethodOptions {
* Custom passthrough(pt) options.
* @see {@link DialogProps.pt}
*/
export interface DialogPassThroughOptions {
export interface DialogPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: DialogPassThroughOptionType;
root?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the header's DOM element.
*/
header?: DialogPassThroughOptionType;
header?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the header title's DOM element.
*/
title?: DialogPassThroughOptionType;
title?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the header icons' DOM element.
*/
icons?: DialogPassThroughOptionType;
icons?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the maximizable button's DOM element.
*/
maximizableButton?: DialogPassThroughOptionType;
maximizableButton?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the maximizable icon's DOM element.
*/
maximizableIcon?: DialogPassThroughOptionType;
maximizableIcon?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the close button's component.
*/
closeButton?: DialogPassThroughOptionType;
closeButton?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the close button icon's component.
*/
closeButtonIcon?: DialogPassThroughOptionType;
closeButtonIcon?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the content's DOM element.
*/
content?: DialogPassThroughOptionType;
content?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the footer's DOM element.
*/
footer?: DialogPassThroughOptionType;
footer?: DialogPassThroughOptionType<T>;
/**
* Used to pass attributes to the mask's DOM element.
*/
mask?: DialogPassThroughOptionType;
mask?: DialogPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}
@ -95,7 +99,7 @@ export interface DialogPassThroughOptions {
/**
* Used to control Vue Transition API.
*/
transition?: DialogPassThroughTransitionType;
transition?: DialogPassThroughTransitionType<T>;
}
/**

52
components/lib/dropdown/Dropdown.d.ts vendored
View File

@ -13,14 +13,14 @@ import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
import { VirtualScrollerItemOptions, VirtualScrollerPassThroughOptionType, VirtualScrollerProps } from '../virtualscroller';
export declare type DropdownPassThroughOptionType = DropdownPassThroughAttributes | ((options: DropdownPassThroughMethodOptions) => DropdownPassThroughAttributes | string) | string | null | undefined;
export declare type DropdownPassThroughOptionType<T = any> = DropdownPassThroughAttributes | ((options: DropdownPassThroughMethodOptions<T>) => DropdownPassThroughAttributes | string) | string | null | undefined;
export declare type DropdownPassThroughTransitionType = TransitionProps | ((options: DropdownPassThroughMethodOptions) => TransitionProps) | undefined;
export declare type DropdownPassThroughTransitionType<T = any> = TransitionProps | ((options: DropdownPassThroughMethodOptions<T>) => TransitionProps) | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface DropdownPassThroughMethodOptions {
export interface DropdownPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -33,6 +33,10 @@ export interface DropdownPassThroughMethodOptions {
* Defines current inline state.
*/
state: DropdownState;
/**
* Defines parent instance.
*/
parent: T | any;
/**
* Defines current options.
*/
@ -77,51 +81,51 @@ export interface DropdownFilterEvent {
* Custom passthrough(pt) options.
* @see {@link DropdownProps.pt}
*/
export interface DropdownPassThroughOptions {
export interface DropdownPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: DropdownPassThroughOptionType;
root?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the input's DOM element.
*/
input?: DropdownPassThroughOptionType;
input?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the clear icon's DOM element.
*/
clearIcon?: DropdownPassThroughOptionType;
clearIcon?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the trigger' DOM element.
*/
trigger?: DropdownPassThroughOptionType;
trigger?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the loading icon's DOM element.
*/
loadingIcon?: DropdownPassThroughOptionType;
loadingIcon?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the panel's DOM element.
*/
panel?: DropdownPassThroughOptionType;
panel?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the header's DOM element.
*/
header?: DropdownPassThroughOptionType;
header?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the filter container's DOM element.
*/
filterContainer?: DropdownPassThroughOptionType;
filterContainer?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the filter input's DOM element.
*/
filterInput?: DropdownPassThroughOptionType;
filterInput?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the filter icon's DOM element.
*/
filterIcon?: DropdownPassThroughOptionType;
filterIcon?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the wrapper's DOM element.
*/
wrapper?: DropdownPassThroughOptionType;
wrapper?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the VirtualScroller component.
* @see {@link VirtualScrollerPassThroughOptionType}
@ -130,39 +134,39 @@ export interface DropdownPassThroughOptions {
/**
* Used to pass attributes to the list's DOM element.
*/
list?: DropdownPassThroughOptionType;
list?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the item group's DOM element.
*/
itemGroup?: DropdownPassThroughOptionType;
itemGroup?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the item's DOM element.
*/
item?: DropdownPassThroughOptionType;
item?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the empty message's DOM element.
*/
emptyMessage?: DropdownPassThroughOptionType;
emptyMessage?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the hidden first focusable element's DOM element.
*/
hiddenFirstFocusableEl?: DropdownPassThroughOptionType;
hiddenFirstFocusableEl?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the hidden filter result's DOM element.
*/
hiddenFilterResult?: DropdownPassThroughOptionType;
hiddenFilterResult?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the hidden empty message's DOM element.
*/
hiddenEmptyMessage?: DropdownPassThroughOptionType;
hiddenEmptyMessage?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the hidden selected message's DOM element.
*/
hiddenSelectedMessage?: DropdownPassThroughOptionType;
hiddenSelectedMessage?: DropdownPassThroughOptionType<T>;
/**
* Used to pass attributes to the hidden last focusable element's DOM element.
*/
hiddenLastFocusableEl?: DropdownPassThroughOptionType;
hiddenLastFocusableEl?: DropdownPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

28
components/lib/fileupload/FileUpload.d.ts vendored
View File

@ -8,6 +8,7 @@
*
*/
import { VNode } from 'vue';
import { BadgePassThroughOptions } from '../badge';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptions } from '../button';
import { MessagePassThroughOptions } from '../message';
@ -38,6 +39,20 @@ export interface FileUploadPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface FileUploadPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: FileUploadProps;
/**
* Defines current inline state.
*/
state: FileUploadState;
}
/**
* Custom select event.
* @see {@link FileUploadEmits.select}
@ -199,12 +214,12 @@ export interface FileUploadPassThroughOptions {
* Used to pass attributes to the upload button's DOM element.
* @see {@link ButtonPassThroughOptions}
*/
uploadButton?: ButtonPassThroughOptions;
uploadButton?: ButtonPassThroughOptions<FileUploadPassThroughMethodOptions>;
/**
* Used to pass attributes to the cancel button's DOM element.
* @see {@link ButtonPassThroughOptions}
*/
cancelButton?: ButtonPassThroughOptions;
cancelButton?: ButtonPassThroughOptions<FileUploadPassThroughMethodOptions>;
/**
* Used to pass attributes to the content's DOM element.
*/
@ -217,7 +232,7 @@ export interface FileUploadPassThroughOptions {
* Used to pass attributes to the messages' DOM element.
* @see {@link MessagePassThroughOptions}
*/
message?: MessagePassThroughOptions;
message?: MessagePassThroughOptions<FileUploadPassThroughMethodOptions>;
/**
* Used to pass attributes to the file's DOM element.
*/
@ -239,9 +254,10 @@ export interface FileUploadPassThroughOptions {
*/
fileSize?: FileUploadPassThroughOptionType;
/**
* Used to pass attributes to the badge's DOM element.
* Used to pass attributes to the Badge component.
* @see {@link BadgePassThroughOptions}
*/
badge?: FileUploadPassThroughOptionType;
badge?: BadgePassThroughOptions<FileUploadPassThroughMethodOptions>;
/**
* Used to pass attributes to the actions's DOM element.
*/
@ -250,7 +266,7 @@ export interface FileUploadPassThroughOptions {
* Used to pass attributes to the remove button's DOM element.
* @see {@link ButtonPassThroughOptions}
*/
removeButton?: ButtonPassThroughOptions;
removeButton?: ButtonPassThroughOptions<FileUploadPassThroughMethodOptions>;
/**
* Used to pass attributes to the empty's DOM element.
*/

16
components/lib/inplace/Inplace.d.ts vendored
View File

@ -38,6 +38,20 @@ export interface InplacePassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface InplaceSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: InplaceProps;
/**
* Defines current inline state.
*/
state: InplaceState;
}
/**
* Custom passthrough(pt) options.
* @see {@link InplaceProps.pt}
@ -59,7 +73,7 @@ export interface InplacePassThroughOptions {
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
closeButton?: ButtonPassThroughOptions;
closeButton?: ButtonPassThroughOptions<InplaceSharedPassThroughMethodOptions>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

42
components/lib/inputnumber/InputNumber.d.ts vendored
View File

@ -9,17 +9,17 @@
*/
import { ButtonHTMLAttributes, InputHTMLAttributes, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptionType } from '../button';
import { InputTextPassThroughOptionType } from '../inputtext';
import { ButtonPassThroughOptions } from '../button';
import { InputTextPassThroughOptions } from '../inputtext';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, Nullable, PassThrough } from '../ts-helpers';
export declare type InputNumberPassThroughOptionType = InputNumberPassThroughAttributes | ((options: InputNumberPassThroughMethodOptions) => InputNumberPassThroughAttributes | string) | string | null | undefined;
export declare type InputNumberPassThroughOptionType<T = any> = InputNumberPassThroughAttributes | ((options: InputNumberPassThroughMethodOptions<T>) => InputNumberPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface InputNumberPassThroughMethodOptions {
export interface InputNumberPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -32,12 +32,30 @@ export interface InputNumberPassThroughMethodOptions {
* Defines current inline state.
*/
state: InputNumberState;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface InputNumberSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: InputNumberProps;
/**
* Defines current inline state.
*/
state: InputNumberState;
}
/**
* Custom input event.
* @see {@link InputNumberEmits.input}
@ -72,30 +90,30 @@ export interface InputNumberBlurEvent {
* Custom passthrough(pt) options.
* @see {@link InputNumberProps.pt}
*/
export interface InputNumberPassThroughOptions {
export interface InputNumberPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: InputNumberPassThroughOptionType;
root?: InputNumberPassThroughOptionType<T>;
/**
* Used to pass attributes to the Input component.
* @see {@link InputTextPassThroughOptionType}
* Used to pass attributes to the InputText component.
* @see {@link InputTextPassThroughOptions}
*/
input?: InputTextPassThroughOptionType;
input?: InputTextPassThroughOptions<InputNumberSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the button group's DOM element.
*/
buttonGroup?: InputNumberPassThroughOptionType;
buttonGroup?: InputNumberPassThroughOptionType<T>;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
incrementButton?: ButtonPassThroughOptionType;
incrementButton?: ButtonPassThroughOptions<InputNumberSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
decrementButton?: ButtonPassThroughOptionType;
decrementButton?: ButtonPassThroughOptions<InputNumberSharedPassThroughMethodOptions>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

12
components/lib/inputtext/InputText.d.ts vendored
View File

@ -12,12 +12,12 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, Nullable, PassThrough } from '../ts-helpers';
export declare type InputTextPassThroughOptionType = InputTextPassThroughAttributes | ((options: InputTextPassThroughMethodOptions) => InputTextPassThroughAttributes | string) | string | null | undefined;
export declare type InputTextPassThroughOptionType<T = any> = InputTextPassThroughAttributes | ((options: InputTextPassThroughMethodOptions<T>) => InputTextPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface InputTextPassThroughMethodOptions {
export interface InputTextPassThroughMethodOptions<T = any> {
/**
* Defines instance.
*/
@ -30,6 +30,10 @@ export interface InputTextPassThroughMethodOptions {
* Defines current options.
*/
context: InputTextContext;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines passthrough(pt) options in global config.
*/
@ -40,11 +44,11 @@ export interface InputTextPassThroughMethodOptions {
* Custom passthrough(pt) options.
* @see {@link InputTextProps.pt}
*/
export interface InputTextPassThroughOptions {
export interface InputTextPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: InputTextPassThroughOptionType;
root?: InputTextPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

30
components/lib/message/Message.d.ts vendored
View File

@ -12,14 +12,14 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type MessagePassThroughOptionType = MessagePassThroughAttributes | ((options: MessagePassThroughMethodOptions) => MessagePassThroughAttributes | string) | string | null | undefined;
export declare type MessagePassThroughOptionType<T = any> = MessagePassThroughAttributes | ((options: MessagePassThroughMethodOptions<T>) => MessagePassThroughAttributes | string) | string | null | undefined;
export declare type MessagePassThroughTransitionType = TransitionProps | ((options: MessagePassThroughMethodOptions) => TransitionProps) | undefined;
export declare type MessagePassThroughTransitionType<T = any> = TransitionProps | ((options: MessagePassThroughMethodOptions<T>) => TransitionProps) | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface MessagePassThroughMethodOptions {
export interface MessagePassThroughMethodOptions<T = any> {
/**
* Defines instance.
*/
@ -32,6 +32,10 @@ export interface MessagePassThroughMethodOptions {
* Defines current inline state.
*/
state: MessageState;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines passthrough(pt) options in global config.
*/
@ -42,41 +46,41 @@ export interface MessagePassThroughMethodOptions {
* Custom passthrough(pt) options.
* @see {@link MessageProps.pt}
*/
export interface MessagePassThroughOptions {
export interface MessagePassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: MessagePassThroughOptionType;
root?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the wrapper's DOM element.
*/
wrapper?: MessagePassThroughOptionType;
wrapper?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the icon's DOM element.
*/
icon?: MessagePassThroughOptionType;
icon?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the text's DOM element.
*/
text?: MessagePassThroughOptionType;
text?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the button's DOM element.
* @deprecated since v3.30.2. Use 'closeButton' option.
*/
button?: MessagePassThroughOptionType;
button?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the button's DOM element.
*/
closeButton?: MessagePassThroughOptionType;
closeButton?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the button icon's DOM element.
* @deprecated since v3.30.2. Use 'closeIcon' option.
*/
buttonIcon?: MessagePassThroughOptionType;
buttonIcon?: MessagePassThroughOptionType<T>;
/**
* Used to pass attributes to the button icon's DOM element.
*/
closeIcon?: MessagePassThroughOptionType;
closeIcon?: MessagePassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}
@ -85,7 +89,7 @@ export interface MessagePassThroughOptions {
/**
* Used to control Vue Transition API.
*/
transition?: MessagePassThroughTransitionType;
transition?: MessagePassThroughTransitionType<T>;
}
/**

24
components/lib/orderlist/OrderList.d.ts vendored
View File

@ -9,7 +9,7 @@
*/
import { ButtonHTMLAttributes, HTMLAttributes, TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptionType } from '../button';
import { ButtonPassThroughOptions } from '../button';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
@ -43,6 +43,20 @@ export interface OrderListPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface OrderListSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: OrderListProps;
/**
* Defines current inline state.
*/
state: OrderListState;
}
/**
* Custom reorder event
* @see {@link OrderListEmits.reorder}
@ -93,19 +107,19 @@ export interface OrderListPassThroughOptions {
/**
* Used to pass attributes to the Button component.
*/
moveUpButton?: ButtonPassThroughOptionType;
moveUpButton?: ButtonPassThroughOptions<OrderListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
moveTopButton?: ButtonPassThroughOptionType;
moveTopButton?: ButtonPassThroughOptions<OrderListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
moveDownButton?: ButtonPassThroughOptionType;
moveDownButton?: ButtonPassThroughOptions<OrderListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
moveBottomButton?: ButtonPassThroughOptionType;
moveBottomButton?: ButtonPassThroughOptions<OrderListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the container's DOM element.
*/

70
components/lib/paginator/Paginator.d.ts vendored
View File

@ -9,17 +9,17 @@
*/
import { VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { DropdownPassThroughOptionType } from '../dropdown';
import { InputNumberPassThroughOptionType } from '../inputnumber';
import { DropdownPassThroughOptions } from '../dropdown';
import { InputNumberPassThroughOptions } from '../inputnumber';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type PaginatorPassThroughOptionType = PaginatorPassThroughAttributes | ((options: PaginatorPassThroughMethodOptions) => PaginatorPassThroughAttributes | string) | string | null | undefined;
export declare type PaginatorPassThroughOptionType<T = any> = PaginatorPassThroughAttributes | ((options: PaginatorPassThroughMethodOptions<T>) => PaginatorPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface PaginatorPassThroughMethodOptions {
export interface PaginatorPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -32,6 +32,10 @@ export interface PaginatorPassThroughMethodOptions {
* Defines current inline state.
*/
state: PaginatorState;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines current options.
*/
@ -42,86 +46,100 @@ export interface PaginatorPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface PaginatorSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: PaginatorProps;
/**
* Defines current inline state.
*/
state: PaginatorState;
}
/**
* Custom passthrough(pt) options.
* @see {@link PaginatorProps.pt}
*/
export interface PaginatorPassThroughOptions {
export interface PaginatorPassThroughOptions<T = any> {
/**
* Used to pass attributes to the paginator wrapper's DOM element.
*/
paginatorWrapper?: PaginatorPassThroughOptionType;
paginatorWrapper?: PaginatorPassThroughOptionType<T> | any;
/**
* Used to pass attributes to the root's DOM element.
*/
root?: PaginatorPassThroughOptionType;
root?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the start's DOM element.
*/
start?: PaginatorPassThroughOptionType;
start?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the first page button's DOM element.
*/
firstPageButton?: PaginatorPassThroughOptionType;
firstPageButton?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the first page icon's DOM element.
*/
firstPageIcon?: PaginatorPassThroughOptionType;
firstPageIcon?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the prev page button's DOM element.
*/
previousPageButton?: PaginatorPassThroughOptionType;
previousPageButton?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the prev page icon's DOM element.
*/
previousPageIcon?: PaginatorPassThroughOptionType;
previousPageIcon?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the next page button's DOM element.
*/
nextPageButton?: PaginatorPassThroughOptionType;
nextPageButton?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the next page icon's DOM element.
*/
nextPageIcon?: PaginatorPassThroughOptionType;
nextPageIcon?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the last page button's DOM element.
*/
lastPageButton?: PaginatorPassThroughOptionType;
lastPageButton?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the last page icon's DOM element.
*/
lastPageIcon?: PaginatorPassThroughOptionType;
lastPageIcon?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the pages's DOM element.
*/
pages?: PaginatorPassThroughOptionType;
pages?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the page button's DOM element.
*/
pageButton?: PaginatorPassThroughOptionType;
pageButton?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the current's DOM element.
*/
current?: PaginatorPassThroughOptionType;
current?: PaginatorPassThroughOptionType<T>;
/**
* Used to pass attributes to the Dropdown component.
* @see {@link DropdownPassThroughOptionType}
* @see {@link DropdownPassThroughOptions}
*/
rowPerPageDropdown?: DropdownPassThroughOptionType;
rowPerPageDropdown?: DropdownPassThroughOptions<PaginatorSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Dropdown component.
* @see {@link DropdownPassThroughOptionType}
* @see {@link DropdownPassThroughOptions}
*/
jumpToPageDropdown?: DropdownPassThroughOptionType;
jumpToPageDropdown?: DropdownPassThroughOptions<PaginatorSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Dropdown component.
* @see {@link InputNumberPassThroughOptionType}
* @see {@link InputNumberPassThroughOptions}
*/
jumpToPageInput?: InputNumberPassThroughOptionType;
jumpToPageInput?: InputNumberPassThroughOptions<PaginatorSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the end's DOM element.
*/
end?: PaginatorPassThroughOptionType;
end?: PaginatorPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

20
components/lib/password/Password.d.ts vendored
View File

@ -9,7 +9,7 @@
*/
import { HTMLAttributes, InputHTMLAttributes, TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { InputTextPassThroughOptionType } from '../inputtext';
import { InputTextPassThroughOptions } from '../inputtext';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, Nullable, PassThrough } from '../ts-helpers';
@ -39,6 +39,20 @@ export interface PasswordPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface PasswordSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: PasswordProps;
/**
* Defines current inline state.
*/
state: PasswordState;
}
/**
* Custom passthrough(pt) options.
* @see {@link PasswordProps.pt}
@ -50,9 +64,9 @@ export interface PasswordPassThroughOptions {
root?: PasswordPassThroughOptionType;
/**
* Used to pass attributes to the InputText component.
* @see {@link InputTextPassThroughOptionType}
* @see {@link InputTextPassThroughOptions}
*/
input?: PasswordPassThroughOptionType;
input?: InputTextPassThroughOptions<PasswordSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the hide icon's DOM element.
*/

40
components/lib/picklist/PickList.d.ts vendored
View File

@ -9,7 +9,7 @@
*/
import { ButtonHTMLAttributes, HTMLAttributes, TransitionProps, VNode } from 'vue';
import { ComponentHooks } from '../basecomponent';
import { ButtonPassThroughOptionType } from '../button';
import { ButtonPassThroughOptions } from '../button';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
@ -43,6 +43,20 @@ export interface PickListPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface PickListSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: PickListProps;
/**
* Defines current inline state.
*/
state: PickListState;
}
/**
* Custom reorder event.
* @see {@link PickListEmits.reorder}
@ -133,19 +147,19 @@ export interface PickListPassThroughOptions {
/**
* Used to pass attributes to the Button component.
*/
sourceMoveUpButton?: ButtonPassThroughOptionType;
sourceMoveUpButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
sourceMoveTopButton?: ButtonPassThroughOptionType;
sourceMoveTopButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
sourceMoveDownButton?: ButtonPassThroughOptionType;
sourceMoveDownButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
sourceMoveBottomButton?: ButtonPassThroughOptionType;
sourceMoveBottomButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the source wrapper's DOM element.
*/
@ -165,19 +179,19 @@ export interface PickListPassThroughOptions {
/**
* Used to pass attributes to the Button component.
*/
moveToTargetButton?: ButtonPassThroughOptionType;
moveToTargetButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
moveAllToTargetButton?: ButtonPassThroughOptionType;
moveAllToTargetButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
moveToSourceButton?: ButtonPassThroughOptionType;
moveToSourceButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
moveAllToSourceButton?: ButtonPassThroughOptionType;
moveAllToSourceButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the target wrapper's DOM element.
*/
@ -201,19 +215,19 @@ export interface PickListPassThroughOptions {
/**
* Used to pass attributes to the Button component.
*/
targetMoveUpButton?: ButtonPassThroughOptionType;
targetMoveUpButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
targetMoveTopButton?: ButtonPassThroughOptionType;
targetMoveTopButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
targetMoveDownButton?: ButtonPassThroughOptionType;
targetMoveDownButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the Button component.
*/
targetMoveBottomButton?: ButtonPassThroughOptionType;
targetMoveBottomButton?: ButtonPassThroughOptions<PickListSharedPassThroughMethodOptions>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

16
components/lib/progressbar/ProgressBar.d.ts vendored
View File

@ -12,12 +12,12 @@ import { ComponentHooks } from '../basecomponent';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type ProgressBarPassThroughOptionType = ProgressBarPassThroughAttributes | ((options: ProgressBarPassThroughMethodOptions) => ProgressBarPassThroughAttributes | string) | string | null | undefined;
export declare type ProgressBarPassThroughOptionType<T = any> = ProgressBarPassThroughAttributes | ((options: ProgressBarPassThroughMethodOptions<T>) => ProgressBarPassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface ProgressBarPassThroughMethodOptions {
export interface ProgressBarPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -30,25 +30,29 @@ export interface ProgressBarPassThroughMethodOptions {
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
/**
* Defines parent instance.
*/
parent: T;
}
/**
* Custom passthrough(pt) options.
* @see {@link ProgressBarProps.pt}
*/
export interface ProgressBarPassThroughOptions {
export interface ProgressBarPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: ProgressBarPassThroughOptionType;
root?: ProgressBarPassThroughOptionType<T>;
/**
* Used to pass attributes to the value's DOM element.
*/
value?: ProgressBarPassThroughOptionType;
value?: ProgressBarPassThroughOptionType<T>;
/**
* Used to pass attributes to the label's DOM element.
*/
label?: ProgressBarPassThroughOptionType;
label?: ProgressBarPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

16
components/lib/speeddial/SpeedDial.d.ts vendored
View File

@ -42,6 +42,20 @@ export interface SpeedDialPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface SpeedDialSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: SpeedDialProps;
/**
* Defines current inline state.
*/
state: SpeedDialState;
}
/**
* Custom passthrough(pt) options.
* @see {@link SpeedDialProps.pt}
@ -55,7 +69,7 @@ export interface SpeedDialPassThroughOptions {
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
button?: ButtonPassThroughOptions;
button?: ButtonPassThroughOptions<SpeedDialSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the menu's DOM element.
*/

18
components/lib/splitbutton/SplitButton.d.ts vendored
View File

@ -39,6 +39,20 @@ export interface SplitButtonPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface SplitButtonSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: SplitButtonProps;
/**
* Defines current inline state.
*/
state: SplitButtonState;
}
/**
* Custom passthrough(pt) options.
* @see {@link SplitButtonProps.pt}
@ -56,12 +70,12 @@ export interface SplitButtonPassThroughOptions {
* Used to pass attributes to the Button component.
* @see {@link ButtonPassThroughOptions}
*/
menuButton?: ButtonPassThroughOptions;
menuButton?: ButtonPassThroughOptions<SplitButtonSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the TieredMenu component.
* @see {@link TieredMenuPassThroughOptions}
*/
menu?: TieredMenuPassThroughOptions;
menu?: TieredMenuPassThroughOptions<SplitButtonSharedPassThroughMethodOptions>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

32
components/lib/tieredmenu/TieredMenu.d.ts vendored
View File

@ -13,14 +13,14 @@ import { MenuItem } from '../menuitem';
import { PassThroughOptions } from '../passthrough';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type TieredMenuPassThroughOptionType = TieredMenuPassThroughAttributes | ((options: TieredMenuPassThroughMethodOptions) => TieredMenuPassThroughAttributes | string) | string | null | undefined;
export declare type TieredMenuPassThroughOptionType<T = any> = TieredMenuPassThroughAttributes | ((options: TieredMenuPassThroughMethodOptions<T>) => TieredMenuPassThroughAttributes | string) | string | null | undefined;
export declare type TieredMenuPassThroughTransitionType = TransitionProps | ((options: TieredMenuPassThroughMethodOptions) => TransitionProps) | undefined;
export declare type TieredMenuPassThroughTransitionType<T = any> = TransitionProps | ((options: TieredMenuPassThroughMethodOptions<T>) => TransitionProps) | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface TieredMenuPassThroughMethodOptions {
export interface TieredMenuPassThroughMethodOptions<T> {
/**
* Defines instance.
*/
@ -33,6 +33,10 @@ export interface TieredMenuPassThroughMethodOptions {
* Defines current inline state.
*/
state: TieredMenuState;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines current options.
*/
@ -47,47 +51,47 @@ export interface TieredMenuPassThroughMethodOptions {
* Custom passthrough(pt) options.
* @see {@link TieredMenuProps.pt}
*/
export interface TieredMenuPassThroughOptions {
export interface TieredMenuPassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: TieredMenuPassThroughOptionType;
root?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the list's DOM element.
*/
menu?: TieredMenuPassThroughOptionType;
menu?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the list item's DOM element.
*/
menuitem?: TieredMenuPassThroughOptionType;
menuitem?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the content's DOM element.
*/
content?: TieredMenuPassThroughOptionType;
content?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the action's DOM element.
*/
action?: TieredMenuPassThroughOptionType;
action?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the icon's DOM element.
*/
icon?: TieredMenuPassThroughOptionType;
icon?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the label's DOM element.
*/
label?: TieredMenuPassThroughOptionType;
label?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the submenu icon's DOM element.
*/
submenuIcon?: TieredMenuPassThroughOptionType;
submenuIcon?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the separator's DOM element.
*/
separator?: TieredMenuPassThroughOptionType;
separator?: TieredMenuPassThroughOptionType<T>;
/**
* Used to pass attributes to the submenu's DOM element.
*/
submenu?: TieredMenuPassThroughOptionType;
submenu?: TieredMenuPassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

46
components/lib/tree/Tree.d.ts vendored
View File

@ -13,12 +13,12 @@ import { PassThroughOptions } from '../passthrough';
import { TreeNode } from '../treenode';
import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
export declare type TreePassThroughOptionType = TreePassThroughAttributes | ((options: TreePassThroughMethodOptions) => TreePassThroughAttributes | string) | string | null | undefined;
export declare type TreePassThroughOptionType<T = any> = TreePassThroughAttributes | ((options: TreePassThroughMethodOptions<T>) => TreePassThroughAttributes | string) | string | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface TreePassThroughMethodOptions {
export interface TreePassThroughMethodOptions<T = any> {
/**
* Defines instance.
*/
@ -31,6 +31,10 @@ export interface TreePassThroughMethodOptions {
* Defines current inline state.
*/
state: TreeState;
/**
* Defines parent instance.
*/
parent: T;
/**
* Defines current options.
*/
@ -80,79 +84,79 @@ export interface TreeFilterEvent {
* Custom passthrough(pt) options.
* @see {@link TreeProps.pt}
*/
export interface TreePassThroughOptions {
export interface TreePassThroughOptions<T = any> {
/**
* Used to pass attributes to the root's DOM element.
*/
root?: TreePassThroughOptionType;
root?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the filter container's DOM element.
*/
filterContainer?: TreePassThroughOptionType;
filterContainer?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the input's DOM element.
*/
input?: TreePassThroughOptionType;
input?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the search icon's DOM element.
*/
searchIcon?: TreePassThroughOptionType;
searchIcon?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the wrapper's DOM element.
*/
wrapper?: TreePassThroughOptionType;
wrapper?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the container's DOM element.
*/
container?: TreePassThroughOptionType;
container?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the node's DOM element.
*/
node?: TreePassThroughOptionType;
node?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the content's DOM element.
*/
content?: TreePassThroughOptionType;
content?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the toggler's DOM element.
*/
toggler?: TreePassThroughOptionType;
toggler?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the toggler icon's DOM element.
*/
togglerIcon?: TreePassThroughOptionType;
togglerIcon?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the checkbox container's DOM element.
*/
checkboxContainer?: TreePassThroughOptionType;
checkboxContainer?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the checkbox's DOM element.
*/
checkbox?: TreePassThroughOptionType;
checkbox?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the checkbox icon's DOM element.
*/
checkboxIcon?: TreePassThroughOptionType;
checkboxIcon?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the node icon's DOM element.
*/
nodeIcon?: TreePassThroughOptionType;
nodeIcon?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the label's DOM element.
*/
label?: TreePassThroughOptionType;
label?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the subgroup's DOM element.
*/
subgroup?: TreePassThroughOptionType;
subgroup?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the loading overlay's DOM element.
*/
loadingOverlay?: TreePassThroughOptionType;
loadingOverlay?: TreePassThroughOptionType<T>;
/**
* Used to pass attributes to the loading icon's DOM element.
*/
loadingIcon?: TreePassThroughOptionType;
loadingIcon?: TreePassThroughOptionType<T>;
/**
* Used to manage all lifecycle hooks.
* @see {@link BaseComponent.ComponentHooks}

16
components/lib/treeselect/TreeSelect.d.ts vendored
View File

@ -40,6 +40,20 @@ export interface TreeSelectPassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface TreeSelectSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: TreeSelectProps;
/**
* Defines current inline state.
*/
state: TreeSelectState;
}
/**
* Custom passthrough(pt) options.
* @see {@link TreeSelectProps.pt}
@ -85,7 +99,7 @@ export interface TreeSelectPassThroughOptions {
* Used to pass attributes to Tree component.
* @see {@link TreePassThroughOptionType}
*/
tree?: TreePassThroughOptionType;
tree?: TreePassThroughOptionType<TreeSelectSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the empty message's DOM element.
*/

16
components/lib/treetable/TreeTable.d.ts vendored
View File

@ -43,6 +43,20 @@ export interface TreeTablePassThroughMethodOptions {
global: object | undefined;
}
/**
* Custom shared passthrough(pt) option method.
*/
export interface TreeTableSharedPassThroughMethodOptions {
/**
* Defines valid properties.
*/
props: TreeTableProps;
/**
* Defines current inline state.
*/
state: TreeTableState;
}
/**
* Custom treetable filter metadata.
*/
@ -214,7 +228,7 @@ export interface TreeTablePassThroughOptions {
* Used to pass attributes to the Paginator component.
* @see {@link PaginatorPassThroughOptionType}
*/
paginator?: PaginatorPassThroughOptionType;
paginator?: PaginatorPassThroughOptionType<TreeTableSharedPassThroughMethodOptions>;
/**
* Used to pass attributes to the wrapper's DOM element.
*/

823
doc/common/apidoc/index.json
View File

File diff suppressed because it is too large Load Diff