Update API doc

pull/4295/head
GitHub Actions Bot 2023-08-18 00:43:49 +00:00
parent 37979a7d50
commit 38581a1380
1 changed files with 2 additions and 663 deletions

View File

@ -12740,8 +12740,7 @@
"default": "" "default": ""
} }
], ],
"methods": [], "methods": []
"extendedBy": "default"
}, },
"PrimeVueLocaleAriaOptions": { "PrimeVueLocaleAriaOptions": {
"relatedProp": "", "relatedProp": "",
@ -33107,667 +33106,7 @@
} }
} }
}, },
"passthrough/tailwind": { "passthrough/tailwind": {},
"interfaces": {
"description": "Defines the custom interfaces used by the module.",
"eventDescription": "Defines the custom events used by the component's emit.",
"methodDescription": "Defines methods that can be accessed by the component's reference.",
"typeDescription": "Defines the custom types used by the module.",
"values": {
"default": {
"relatedProp": "",
"props": [
{
"name": "accordion",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<AccordionPassThroughOptions>",
"default": ""
},
{
"name": "accordiontab",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<AccordionTabPassThroughOptions>",
"default": ""
},
{
"name": "autocomplete",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<AutoCompletePassThroughOptions>",
"default": ""
},
{
"name": "avatar",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<AvatarPassThroughOptions>",
"default": ""
},
{
"name": "avatargroup",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<AvatarGroupPassThroughOptions>",
"default": ""
},
{
"name": "badge",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<BadgePassThroughOptions>",
"default": ""
},
{
"name": "blockui",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<BlockUIPassThroughOptions>",
"default": ""
},
{
"name": "breadcrumb",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<BreadcrumbPassThroughOptions>",
"default": ""
},
{
"name": "button",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ButtonPassThroughOptions>",
"default": ""
},
{
"name": "calendar",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<CalendarPassThroughOptions>",
"default": ""
},
{
"name": "card",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<CardPassThroughOptions>",
"default": ""
},
{
"name": "carousel",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<CarouselPassThroughOptions>",
"default": ""
},
{
"name": "cascadeselect",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<CascadeSelectPassThroughOptions>",
"default": ""
},
{
"name": "chart",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ChartPassThroughOptions>",
"default": ""
},
{
"name": "checkbox",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<CheckboxPassThroughOptions>",
"default": ""
},
{
"name": "chip",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ChipPassThroughOptions>",
"default": ""
},
{
"name": "chips",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ChipsPassThroughOptions>",
"default": ""
},
{
"name": "colorpicker",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ColorPickerPassThroughOptions>",
"default": ""
},
{
"name": "column",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ColumnPassThroughOptions>",
"default": ""
},
{
"name": "columngroup",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ColumnGroupPassThroughOptions>",
"default": ""
},
{
"name": "confirmdialog",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ConfirmDialogPassThroughOptions>",
"default": ""
},
{
"name": "confirmpopup",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ConfirmPopupPassThroughOptions>",
"default": ""
},
{
"name": "contextmenu",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ContextMenuPassThroughOptions>",
"default": ""
},
{
"name": "datatable",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DataTablePassThroughOptions>",
"default": ""
},
{
"name": "dataview",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DataViewPassThroughOptions>",
"default": ""
},
{
"name": "dataviewlayoutoptions",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DataViewLayoutOptionsPassThroughOptions>",
"default": ""
},
{
"name": "deferredcontent",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DeferredContentPassThroughOptions>",
"default": ""
},
{
"name": "divider",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DividerPassThroughOptions>",
"default": ""
},
{
"name": "dialog",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DialogPassThroughOptions>",
"default": ""
},
{
"name": "dock",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DockPassThroughOptions>",
"default": ""
},
{
"name": "dropdown",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DropdownPassThroughOptions>",
"default": ""
},
{
"name": "dynamicdialog",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<DialogPassThroughOptions>",
"default": ""
},
{
"name": "editor",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<EditorPassThroughOptions>",
"default": ""
},
{
"name": "fieldset",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<FieldsetPassThroughOptions>",
"default": ""
},
{
"name": "fileupload",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<FileUploadPassThroughOptions>",
"default": ""
},
{
"name": "galleria",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<GalleriaPassThroughOptions>",
"default": ""
},
{
"name": "image",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ImagePassThroughOptions>",
"default": ""
},
{
"name": "inlinemessage",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<InlineMessagePassThroughOptions>",
"default": ""
},
{
"name": "inplace",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<InplacePassThroughOptions>",
"default": ""
},
{
"name": "inputmask",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<InputMaskPassThroughOptions>",
"default": ""
},
{
"name": "inputnumber",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<InputNumberPassThroughOptions>",
"default": ""
},
{
"name": "inputswitch",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<InputSwitchPassThroughOptions>",
"default": ""
},
{
"name": "inputtext",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<InputTextPassThroughOptions>",
"default": ""
},
{
"name": "knob",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<KnobPassThroughOptions>",
"default": ""
},
{
"name": "listbox",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ListboxPassThroughOptions>",
"default": ""
},
{
"name": "megamenu",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<MegaMenuPassThroughOptions>",
"default": ""
},
{
"name": "menu",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<MenuPassThroughOptions>",
"default": ""
},
{
"name": "menubar",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<MenubarPassThroughOptions>",
"default": ""
},
{
"name": "message",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<MessagePassThroughOptions>",
"default": ""
},
{
"name": "multiselect",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<MultiSelectPassThroughOptions>",
"default": ""
},
{
"name": "orderlist",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<OrderListPassThroughOptions>",
"default": ""
},
{
"name": "organizationchart",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<OrganizationChartPassThroughOptions>",
"default": ""
},
{
"name": "overlaypanel",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<OverlayPanelPassThroughOptions>",
"default": ""
},
{
"name": "paginator",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<PaginatorPassThroughOptions>",
"default": ""
},
{
"name": "panel",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<PanelPassThroughOptions>",
"default": ""
},
{
"name": "panelmenu",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<PanelMenuPassThroughOptions>",
"default": ""
},
{
"name": "password",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<PasswordPassThroughOptions>",
"default": ""
},
{
"name": "picklist",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<PickListPassThroughOptions>",
"default": ""
},
{
"name": "progressbar",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ProgressBarPassThroughOptions>",
"default": ""
},
{
"name": "progressspinner",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ProgressSpinnerPassThroughOptions>",
"default": ""
},
{
"name": "radiobutton",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<RadioButtonPassThroughOptions>",
"default": ""
},
{
"name": "rating",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<RatingPassThroughOptions>",
"default": ""
},
{
"name": "row",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<RowPassThroughOptions>",
"default": ""
},
{
"name": "scrollpanel",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ScrollPanelPassThroughOptions>",
"default": ""
},
{
"name": "scrolltop",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ScrollTopPassThroughOptions>",
"default": ""
},
{
"name": "sidebar",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SidebarPassThroughOptions>",
"default": ""
},
{
"name": "skeleton",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SkeletonPassThroughOptions>",
"default": ""
},
{
"name": "slider",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SliderPassThroughOptions>",
"default": ""
},
{
"name": "speeddial",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SpeedDialPassThroughOptions>",
"default": ""
},
{
"name": "selectbutton",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SelectButtonPassThroughOptions>",
"default": ""
},
{
"name": "splitbutton",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SplitButtonPassThroughOptions>",
"default": ""
},
{
"name": "splitter",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SplitterPassThroughOptions>",
"default": ""
},
{
"name": "splitterpanel",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<SplitterPanelPassThroughOptions>",
"default": ""
},
{
"name": "steps",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<StepsPassThroughOptions>",
"default": ""
},
{
"name": "tabmenu",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TabMenuPassThroughOptions>",
"default": ""
},
{
"name": "tabpanel",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TabPanelPassThroughOptions>",
"default": ""
},
{
"name": "tabview",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TabViewPassThroughOptions>",
"default": ""
},
{
"name": "tag",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TagPassThroughOptions>",
"default": ""
},
{
"name": "terminal",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TerminalPassThroughOptions>",
"default": ""
},
{
"name": "textarea",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TextareaPassThroughOptions>",
"default": ""
},
{
"name": "tieredmenu",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TieredMenuPassThroughOptions>",
"default": ""
},
{
"name": "timeline",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TimelinePassThroughOptions>",
"default": ""
},
{
"name": "toast",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ToastPassThroughOptions>",
"default": ""
},
{
"name": "togglebutton",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ToggleButtonPassThroughOptions>",
"default": ""
},
{
"name": "toolbar",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<ToolbarPassThroughOptions>",
"default": ""
},
{
"name": "tree",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TreePassThroughOptions>",
"default": ""
},
{
"name": "treeselect",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TreeSelectPassThroughOptions>",
"default": ""
},
{
"name": "tristatecheckbox",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TriStateCheckboxPassThroughOptions>",
"default": ""
},
{
"name": "treetable",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<TreeTablePassThroughOptions>",
"default": ""
},
{
"name": "virtualscroller",
"optional": true,
"readonly": false,
"type": "DefaultPTOptions<VirtualScrollerPassThroughOptions>",
"default": ""
},
{
"name": "directives",
"optional": true,
"readonly": false,
"type": "Object",
"default": ""
},
{
"name": "global",
"optional": true,
"readonly": false,
"type": "Object",
"default": ""
}
],
"methods": [],
"extendedTypes": "PrimeVuePTOptions"
}
}
}
},
"password": { "password": {
"description": "Password displays strength indicator for password fields.\n\n[Live Demo](https://www.primevue.org/password/)", "description": "Password displays strength indicator for password fields.\n\n[Live Demo](https://www.primevue.org/password/)",
"components": { "components": {