digivue
Version:
PrimeVue is an open source UI library for Vue featuring a rich set of 80+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBloc
315 lines (311 loc) • 19 kB
TypeScript
import type { DefaultPassThrough, PassThrough } from '@digivue/core';
import type { PrimeVueCSPOptions, PrimeVueLocaleOptions, PrimeVueZIndexOptions } from '@digivue/core/config';
import type { AccordionPassThroughOptions } from 'digivue/accordion';
import type { AccordionContentPassThroughOptions } from 'digivue/accordioncontent';
import type { AccordionHeaderPassThroughOptions } from 'digivue/accordionheader';
import type { AccordionPanelPassThroughOptions } from 'digivue/accordionpanel';
import type { AccordionTabPassThroughOptions } from 'digivue/accordiontab';
import type { AnimateOnScrollDirectivePassThroughOptions } from 'digivue/animateonscroll';
import type { AutoCompletePassThroughOptions } from 'digivue/autocomplete';
import type { AvatarPassThroughOptions } from 'digivue/avatar';
import type { AvatarGroupPassThroughOptions } from 'digivue/avatargroup';
import type { BadgePassThroughOptions } from 'digivue/badge';
import type { BadgeDirectivePassThroughOptions } from 'digivue/badgedirective';
import type { BlockUIPassThroughOptions } from 'digivue/blockui';
import type { BreadcrumbPassThroughOptions } from 'digivue/breadcrumb';
import type { ButtonPassThroughOptions } from 'digivue/button';
import type { ButtonGroupPassThroughOptions } from 'digivue/buttongroup';
import type { CalendarPassThroughOptions } from 'digivue/calendar';
import type { CardPassThroughOptions } from 'digivue/card';
import type { CarouselPassThroughOptions } from 'digivue/carousel';
import type { CascadeSelectPassThroughOptions } from 'digivue/cascadeselect';
import type { ChartPassThroughOptions } from 'digivue/chart';
import type { CheckboxPassThroughOptions } from 'digivue/checkbox';
import type { CheckboxGroupPassThroughOptions } from 'digivue/checkboxgroup';
import type { ChipPassThroughOptions } from 'digivue/chip';
import type { ChipsPassThroughOptions } from 'digivue/chips';
import type { ColorPickerPassThroughOptions } from 'digivue/colorpicker';
import type { ColumnPassThroughOptions } from 'digivue/column';
import type { ColumnGroupPassThroughOptions } from 'digivue/columngroup';
import type { ConfirmDialogPassThroughOptions } from 'digivue/confirmdialog';
import type { ConfirmPopupPassThroughOptions } from 'digivue/confirmpopup';
import type { ContextMenuPassThroughOptions } from 'digivue/contextmenu';
import type { DataTablePassThroughOptions } from 'digivue/datatable';
import type { DataViewPassThroughOptions } from 'digivue/dataview';
import type { DatePickerPassThroughOptions } from 'digivue/datepicker';
import type { DeferredContentPassThroughOptions } from 'digivue/deferredcontent';
import type { DialogPassThroughOptions } from 'digivue/dialog';
import type { DividerPassThroughOptions } from 'digivue/divider';
import type { DockPassThroughOptions } from 'digivue/dock';
import type { DrawerPassThroughOptions } from 'digivue/drawer';
import type { DropdownPassThroughOptions } from 'digivue/dropdown';
import type { EditorPassThroughOptions } from 'digivue/editor';
import type { FieldsetPassThroughOptions } from 'digivue/fieldset';
import type { FileUploadPassThroughOptions } from 'digivue/fileupload';
import type { FloatLabelPassThroughOptions } from 'digivue/floatlabel';
import type { FluidPassThroughOptions } from 'digivue/fluid';
import type { FocusTrapDirectivePassThroughOptions } from 'digivue/focustrap';
import type { GalleriaPassThroughOptions } from 'digivue/galleria';
import type { IconPassThroughOptions } from 'digivue/icon';
import type { IconFieldPassThroughOptions } from 'digivue/iconfield';
import type { IftaLabelPassThroughOptions } from 'digivue/iftalabel';
import type { ImagePassThroughOptions } from 'digivue/image';
import type { ImageComparePassThroughOptions } from 'digivue/imagecompare';
import type { InlineMessagePassThroughOptions } from 'digivue/inlinemessage';
import type { InplacePassThroughOptions } from 'digivue/inplace';
import type { InputChipsPassThroughOptions } from 'digivue/inputchips';
import type { InputGroupPassThroughOptions } from 'digivue/inputgroup';
import type { InputGroupAddonPassThroughOptions } from 'digivue/inputgroupaddon';
import type { InputIconPassThroughOptions } from 'digivue/inputicon';
import type { InputMaskPassThroughOptions } from 'digivue/inputmask';
import type { InputNumberPassThroughOptions } from 'digivue/inputnumber';
import type { InputOtpPassThroughOptions } from 'digivue/inputotp';
import type { InputSwitchPassThroughOptions } from 'digivue/inputswitch';
import type { InputTextPassThroughOptions } from 'digivue/inputtext';
import type { KeyFilterDirectivePassThroughOptions } from 'digivue/keyfilter';
import type { KnobPassThroughOptions } from 'digivue/knob';
import type { ListboxPassThroughOptions } from 'digivue/listbox';
import type { LoadingPassThroughOptions } from 'digivue/loading';
import type { MegaMenuPassThroughOptions } from 'digivue/megamenu';
import type { MenuPassThroughOptions } from 'digivue/menu';
import type { MenubarPassThroughOptions } from 'digivue/menubar';
import type { MessagePassThroughOptions } from 'digivue/message';
import type { MeterGroupPassThroughOptions } from 'digivue/metergroup';
import type { MultiSelectPassThroughOptions } from 'digivue/multiselect';
import type { OrderListPassThroughOptions } from 'digivue/orderlist';
import type { OrganizationChartPassThroughOptions } from 'digivue/organizationchart';
import type { OverlayBadgePassThroughOptions } from 'digivue/overlaybadge';
import type { OverlayPanelPassThroughOptions } from 'digivue/overlaypanel';
import type { PaginatorPassThroughOptions } from 'digivue/paginator';
import type { PanelPassThroughOptions } from 'digivue/panel';
import type { PanelMenuPassThroughOptions } from 'digivue/panelmenu';
import type { PassThroughOptions } from 'digivue/passthrough';
import type { PasswordPassThroughOptions } from 'digivue/password';
import type { PickListPassThroughOptions } from 'digivue/picklist';
import type { PopoverPassThroughOptions } from 'digivue/popover';
import type { ProgressBarPassThroughOptions } from 'digivue/progressbar';
import type { ProgressSpinnerPassThroughOptions } from 'digivue/progressspinner';
import type { RadioButtonPassThroughOptions } from 'digivue/radiobutton';
import type { RadioButtonGroupPassThroughOptions } from 'digivue/radiobuttongroup';
import type { RatingPassThroughOptions } from 'digivue/rating';
import type { RippleDirectivePassThroughOptions } from 'digivue/ripple';
import type { RowPassThroughOptions } from 'digivue/row';
import type { ScrollPanelPassThroughOptions } from 'digivue/scrollpanel';
import type { ScrollTopPassThroughOptions } from 'digivue/scrolltop';
import type { SelectPassThroughOptions } from 'digivue/select';
import type { SelectButtonPassThroughOptions } from 'digivue/selectbutton';
import type { SidebarPassThroughOptions } from 'digivue/sidebar';
import type { SkeletonPassThroughOptions } from 'digivue/skeleton';
import type { SliderPassThroughOptions } from 'digivue/slider';
import type { SpeedDialPassThroughOptions } from 'digivue/speeddial';
import type { SplitButtonPassThroughOptions } from 'digivue/splitbutton';
import type { SplitterPassThroughOptions } from 'digivue/splitter';
import type { SplitterPanelPassThroughOptions } from 'digivue/splitterpanel';
import type { StepPassThroughOptions } from 'digivue/step';
import type { StepItemPassThroughOptions } from 'digivue/stepitem';
import type { StepListPassThroughOptions } from 'digivue/steplist';
import type { StepPanelPassThroughOptions } from 'digivue/steppanel';
import type { StepPanelsPassThroughOptions } from 'digivue/steppanels';
import type { StepperPassThroughOptions } from 'digivue/stepper';
import type { StepsPassThroughOptions } from 'digivue/steps';
import type { StyleClassDirectivePassThroughOptions } from 'digivue/styleclass';
import type { TabPassThroughOptions } from 'digivue/tab';
import type { TabListPassThroughOptions } from 'digivue/tablist';
import type { TabMenuPassThroughOptions } from 'digivue/tabmenu';
import type { TabPanelPassThroughOptions } from 'digivue/tabpanel';
import type { TabPanelsPassThroughOptions } from 'digivue/tabpanels';
import type { TabsPassThroughOptions } from 'digivue/tabs';
import type { TabViewPassThroughOptions } from 'digivue/tabview';
import type { TagPassThroughOptions } from 'digivue/tag';
import type { TerminalPassThroughOptions } from 'digivue/terminal';
import type { TextareaPassThroughOptions } from 'digivue/textarea';
import type { TieredMenuPassThroughOptions } from 'digivue/tieredmenu';
import type { TimelinePassThroughOptions } from 'digivue/timeline';
import type { ToastPassThroughOptions } from 'digivue/toast';
import type { ToggleButtonPassThroughOptions } from 'digivue/togglebutton';
import type { ToggleSwitchPassThroughOptions } from 'digivue/toggleswitch';
import type { ToolbarPassThroughOptions } from 'digivue/toolbar';
import type { TooltipDirectivePassThroughOptions } from 'digivue/tooltip';
import type { TreePassThroughOptions } from 'digivue/tree';
import type { TreeSelectPassThroughOptions } from 'digivue/treeselect';
import type { TreeTablePassThroughOptions } from 'digivue/treetable';
import type { VirtualScrollerPassThroughOptions } from 'digivue/virtualscroller';
export * from '@digivue/core/config';
export { default } from '@digivue/core/config';
export interface PrimeVueConfiguration {
ripple?: boolean;
/**
* @deprecated since v4.0. Use 'inputVariant' instead.
*/
inputStyle?: 'filled' | 'outlined' | undefined;
inputVariant?: 'filled' | 'outlined' | undefined;
locale?: PrimeVueLocaleOptions;
filterMatchModeOptions?: any;
zIndex?: PrimeVueZIndexOptions;
theme?: any;
unstyled?: boolean;
pt?: PassThrough<PrimeVuePTOptions>;
ptOptions?: PassThroughOptions;
csp?: PrimeVueCSPOptions;
}
export interface PrimeVuePTOptions {
accordion?: DefaultPassThrough<AccordionPassThroughOptions>;
accordionpanel?: DefaultPassThrough<AccordionPanelPassThroughOptions>;
accordionheader?: DefaultPassThrough<AccordionHeaderPassThroughOptions>;
accordioncontent?: DefaultPassThrough<AccordionContentPassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of Accordion instead.
*/
accordiontab?: DefaultPassThrough<AccordionTabPassThroughOptions>;
autocomplete?: DefaultPassThrough<AutoCompletePassThroughOptions>;
avatar?: DefaultPassThrough<AvatarPassThroughOptions>;
avatargroup?: DefaultPassThrough<AvatarGroupPassThroughOptions>;
badge?: DefaultPassThrough<BadgePassThroughOptions>;
blockui?: DefaultPassThrough<BlockUIPassThroughOptions>;
breadcrumb?: DefaultPassThrough<BreadcrumbPassThroughOptions>;
button?: DefaultPassThrough<ButtonPassThroughOptions>;
buttongroup?: DefaultPassThrough<ButtonGroupPassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of DatePicker instead.
*/
calendar?: DefaultPassThrough<CalendarPassThroughOptions>;
card?: DefaultPassThrough<CardPassThroughOptions>;
carousel?: DefaultPassThrough<CarouselPassThroughOptions>;
cascadeselect?: DefaultPassThrough<CascadeSelectPassThroughOptions>;
chart?: DefaultPassThrough<ChartPassThroughOptions>;
checkbox?: DefaultPassThrough<CheckboxPassThroughOptions>;
checkboxgroup?: DefaultPassThrough<CheckboxGroupPassThroughOptions>;
chip?: DefaultPassThrough<ChipPassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of InputChips instead.
*/
chips?: DefaultPassThrough<ChipsPassThroughOptions>;
colorpicker?: DefaultPassThrough<ColorPickerPassThroughOptions>;
column?: DefaultPassThrough<ColumnPassThroughOptions>;
columngroup?: DefaultPassThrough<ColumnGroupPassThroughOptions>;
confirmdialog?: DefaultPassThrough<ConfirmDialogPassThroughOptions>;
confirmpopup?: DefaultPassThrough<ConfirmPopupPassThroughOptions>;
contextmenu?: DefaultPassThrough<ContextMenuPassThroughOptions>;
datatable?: DefaultPassThrough<DataTablePassThroughOptions>;
dataview?: DefaultPassThrough<DataViewPassThroughOptions>;
datepicker?: DefaultPassThrough<DatePickerPassThroughOptions>;
deferredcontent?: DefaultPassThrough<DeferredContentPassThroughOptions>;
divider?: DefaultPassThrough<DividerPassThroughOptions>;
dialog?: DefaultPassThrough<DialogPassThroughOptions>;
dock?: DefaultPassThrough<DockPassThroughOptions>;
drawer?: DefaultPassThrough<DrawerPassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of Select instead.
*/
dropdown?: DefaultPassThrough<DropdownPassThroughOptions>;
dynamicdialog?: DefaultPassThrough<DialogPassThroughOptions>;
editor?: DefaultPassThrough<EditorPassThroughOptions>;
fieldset?: DefaultPassThrough<FieldsetPassThroughOptions>;
fileupload?: DefaultPassThrough<FileUploadPassThroughOptions>;
floatlabel?: DefaultPassThrough<FloatLabelPassThroughOptions>;
fluid?: DefaultPassThrough<FluidPassThroughOptions>;
galleria?: DefaultPassThrough<GalleriaPassThroughOptions>;
icon?: DefaultPassThrough<IconPassThroughOptions>;
iconfield?: DefaultPassThrough<IconFieldPassThroughOptions>;
iftalabel?: DefaultPassThrough<IftaLabelPassThroughOptions>;
image?: DefaultPassThrough<ImagePassThroughOptions>;
imagecompare?: DefaultPassThrough<ImageComparePassThroughOptions>;
inlinemessage?: DefaultPassThrough<InlineMessagePassThroughOptions>;
inplace?: DefaultPassThrough<InplacePassThroughOptions>;
inputchips?: DefaultPassThrough<InputChipsPassThroughOptions>;
inputgroup?: DefaultPassThrough<InputGroupPassThroughOptions>;
inputgroupaddon?: DefaultPassThrough<InputGroupAddonPassThroughOptions>;
inputicon?: DefaultPassThrough<InputIconPassThroughOptions>;
inputmask?: DefaultPassThrough<InputMaskPassThroughOptions>;
inputnumber?: DefaultPassThrough<InputNumberPassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of ToggleSwitch instead.
*/
inputotp?: DefaultPassThrough<InputOtpPassThroughOptions>;
inputswitch?: DefaultPassThrough<InputSwitchPassThroughOptions>;
inputtext?: DefaultPassThrough<InputTextPassThroughOptions>;
knob?: DefaultPassThrough<KnobPassThroughOptions>;
listbox?: DefaultPassThrough<ListboxPassThroughOptions>;
loading?: DefaultPassThrough<LoadingPassThroughOptions>;
megamenu?: DefaultPassThrough<MegaMenuPassThroughOptions>;
menu?: DefaultPassThrough<MenuPassThroughOptions>;
menubar?: DefaultPassThrough<MenubarPassThroughOptions>;
message?: DefaultPassThrough<MessagePassThroughOptions>;
metergroup?: DefaultPassThrough<MeterGroupPassThroughOptions>;
multiselect?: DefaultPassThrough<MultiSelectPassThroughOptions>;
orderlist?: DefaultPassThrough<OrderListPassThroughOptions>;
organizationchart?: DefaultPassThrough<OrganizationChartPassThroughOptions>;
overlaybadge?: DefaultPassThrough<OverlayBadgePassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of Popover instead.
*/
overlaypanel?: DefaultPassThrough<OverlayPanelPassThroughOptions>;
paginator?: DefaultPassThrough<PaginatorPassThroughOptions>;
panel?: DefaultPassThrough<PanelPassThroughOptions>;
panelmenu?: DefaultPassThrough<PanelMenuPassThroughOptions>;
password?: DefaultPassThrough<PasswordPassThroughOptions>;
picklist?: DefaultPassThrough<PickListPassThroughOptions>;
popover?: DefaultPassThrough<PopoverPassThroughOptions>;
progressbar?: DefaultPassThrough<ProgressBarPassThroughOptions>;
progressspinner?: DefaultPassThrough<ProgressSpinnerPassThroughOptions>;
radiobutton?: DefaultPassThrough<RadioButtonPassThroughOptions>;
radiobuttongroup?: DefaultPassThrough<RadioButtonGroupPassThroughOptions>;
rating?: DefaultPassThrough<RatingPassThroughOptions>;
row?: DefaultPassThrough<RowPassThroughOptions>;
scrollpanel?: DefaultPassThrough<ScrollPanelPassThroughOptions>;
scrolltop?: DefaultPassThrough<ScrollTopPassThroughOptions>;
/**
* @deprecated since v4. Use the new structure of Drawer instead.
*/
sidebar?: DefaultPassThrough<SidebarPassThroughOptions>;
skeleton?: DefaultPassThrough<SkeletonPassThroughOptions>;
slider?: DefaultPassThrough<SliderPassThroughOptions>;
speeddial?: DefaultPassThrough<SpeedDialPassThroughOptions>;
selectbutton?: DefaultPassThrough<SelectButtonPassThroughOptions>;
select?: DefaultPassThrough<SelectPassThroughOptions>;
splitbutton?: DefaultPassThrough<SplitButtonPassThroughOptions>;
splitter?: DefaultPassThrough<SplitterPassThroughOptions>;
splitterpanel?: DefaultPassThrough<SplitterPanelPassThroughOptions>;
step?: DefaultPassThrough<StepPassThroughOptions>;
stepitem?: DefaultPassThrough<StepItemPassThroughOptions>;
steplist?: DefaultPassThrough<StepListPassThroughOptions>;
steppanel?: DefaultPassThrough<StepPanelPassThroughOptions>;
steppanels?: DefaultPassThrough<StepPanelsPassThroughOptions>;
stepper?: DefaultPassThrough<StepperPassThroughOptions>;
steps?: DefaultPassThrough<StepsPassThroughOptions>;
tabmenu?: DefaultPassThrough<TabMenuPassThroughOptions>;
tabs?: DefaultPassThrough<TabsPassThroughOptions>;
tablist?: DefaultPassThrough<TabListPassThroughOptions>;
tab?: DefaultPassThrough<TabPassThroughOptions>;
tabpanels?: DefaultPassThrough<TabPanelsPassThroughOptions>;
tabpanel?: DefaultPassThrough<TabPanelPassThroughOptions>;
/**
* @deprecated since v4. Use tabs instead.
*/
tabview?: DefaultPassThrough<TabViewPassThroughOptions>;
tag?: DefaultPassThrough<TagPassThroughOptions>;
terminal?: DefaultPassThrough<TerminalPassThroughOptions>;
textarea?: DefaultPassThrough<TextareaPassThroughOptions>;
tieredmenu?: DefaultPassThrough<TieredMenuPassThroughOptions>;
timeline?: DefaultPassThrough<TimelinePassThroughOptions>;
toast?: DefaultPassThrough<ToastPassThroughOptions>;
togglebutton?: DefaultPassThrough<ToggleButtonPassThroughOptions>;
toggleswitch?: DefaultPassThrough<ToggleSwitchPassThroughOptions>;
toolbar?: DefaultPassThrough<ToolbarPassThroughOptions>;
tree?: DefaultPassThrough<TreePassThroughOptions>;
treeselect?: DefaultPassThrough<TreeSelectPassThroughOptions>;
treetable?: DefaultPassThrough<TreeTablePassThroughOptions>;
virtualscroller?: DefaultPassThrough<VirtualScrollerPassThroughOptions>;
directives?: {
animate?: AnimateOnScrollDirectivePassThroughOptions;
badge?: BadgeDirectivePassThroughOptions;
focustrap?: FocusTrapDirectivePassThroughOptions;
keyfilter?: KeyFilterDirectivePassThroughOptions;
ripple?: RippleDirectivePassThroughOptions;
styleclass?: StyleClassDirectivePassThroughOptions;
tooltip?: TooltipDirectivePassThroughOptions;
};
global?: {
css?: ((options: any) => string | undefined) | string | undefined;
};
}