Update API doc
GitHub Actions Bot
parent
6ce17e84be
commit
1b19837e16
|
|
@ -5340,7 +5340,7 @@
|
|||
}
|
||||
],
|
||||
"methods": [],
|
||||
"extendedBy": "AccordionStyle,AccordionTabStyle,AnimateOnScrollStyle,AutoCompleteStyle,AvatarStyle,AvatarGroupStyle,BadgeStyle,BadgeDirectiveStyle,BaseComponentStyle,BaseIconStyle,BlockUIStyle,BreadcrumbStyle,ButtonStyle,CalendarStyle,CardStyle,CarouselStyle,CascadeSelectStyle,ChartStyle,CheckboxStyle,ChipStyle,ChipsStyle,ColorPickerStyle,ColumnStyle,ColumnGroupStyle,ConfirmDialogStyle,ConfirmPopupStyle,ContextMenuStyle,DataTableStyle,DataViewStyle,DataViewLayoutOptionsStyle,DeferredContentStyle,DialogStyle,DividerStyle,DockStyle,DropdownStyle,DynamicDialogStyle,EditorStyle,FieldsetStyle,AccordionStyle,FocusTrapStyle,GalleriaStyle,ImageStyle,InlineMessageStyle,InplaceStyle,InputGroupStyle,InputGroupAddonStyle,InputMaskStyle,InputNumberStyle,InputSwitchStyle,InputTextStyle,KnobStyle,ListboxStyle,MegaMenuStyle,MenuStyle,MenubarStyle,MessageStyle,MultiSelectStyle,OrderListStyle,OrganizationChartStyle,OverlayPanelStyle,PaginatorStyle,PanelStyle,PanelMenuStyle,PasswordStyle,PickListStyle,PortalStyle,ProgressBarStyle,ProgressSpinnerStyle,RadioButtonStyle,RatingStyle,AccordionStyle,RowStyle,ScrollPanelStyle,ScrollTopStyle,SelectButtonStyle,SidebarStyle,SkeletonStyle,SliderStyle,SpeedDialStyle,SplitButtonStyle,SplitterStyle,SplitterPanelStyle,StepsStyle,StyleClassStyle,TabMenuStyle,TabPanelStyle,TabViewStyle,TagStyle,TerminalStyle,TextareaStyle,TieredMenuStyle,TimelineStyle,ToastStyle,ToggleButtonStyle,ToolbarStyle,TooltipStyle,TreeStyle,TreeSelectStyle,TreeTableStyle,TriStateCheckboxStyle,VirtualScrollerStyle"
|
||||
"extendedBy": "AccordionStyle,AccordionTabStyle,AnimateOnScrollStyle,AutoCompleteStyle,AvatarStyle,AvatarGroupStyle,BadgeStyle,BadgeDirectiveStyle,BaseComponentStyle,BaseIconStyle,BlockUIStyle,BreadcrumbStyle,ButtonStyle,CalendarStyle,CardStyle,CarouselStyle,CascadeSelectStyle,ChartStyle,CheckboxStyle,ChipStyle,ChipsStyle,ColorPickerStyle,ColumnStyle,ColumnGroupStyle,ConfirmDialogStyle,ConfirmPopupStyle,ContextMenuStyle,DataTableStyle,DataViewStyle,DataViewLayoutOptionsStyle,DeferredContentStyle,DialogStyle,DividerStyle,DockStyle,DropdownStyle,DynamicDialogStyle,EditorStyle,FieldsetStyle,AccordionStyle,FocusTrapStyle,GalleriaStyle,ImageStyle,InlineMessageStyle,InplaceStyle,InputGroupStyle,InputGroupAddonStyle,InputMaskStyle,InputNumberStyle,InputSwitchStyle,InputTextStyle,KnobStyle,ListboxStyle,MegaMenuStyle,MenuStyle,MenubarStyle,MessageStyle,MeterGroupStyle,MultiSelectStyle,OrderListStyle,OrganizationChartStyle,OverlayPanelStyle,PaginatorStyle,PanelStyle,PanelMenuStyle,PasswordStyle,PickListStyle,PortalStyle,ProgressBarStyle,ProgressSpinnerStyle,RadioButtonStyle,RatingStyle,AccordionStyle,RowStyle,ScrollPanelStyle,ScrollTopStyle,SelectButtonStyle,SidebarStyle,SkeletonStyle,SliderStyle,SpeedDialStyle,SplitButtonStyle,SplitterStyle,SplitterPanelStyle,StepsStyle,StyleClassStyle,TabMenuStyle,TabPanelStyle,TabViewStyle,TagStyle,TerminalStyle,TextareaStyle,TieredMenuStyle,TimelineStyle,ToastStyle,ToggleButtonStyle,ToolbarStyle,TooltipStyle,TreeStyle,TreeSelectStyle,TreeTableStyle,TriStateCheckboxStyle,VirtualScrollerStyle"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -35282,6 +35282,424 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"metergroup": {
|
||||
"description": "MeterGroup is a group of process status indicators.\n\n[Live Demo](https://primevue.org/metergroup)",
|
||||
"components": {
|
||||
"default": {
|
||||
"description": "MeterGroup is a group of process status indicators.",
|
||||
"methods": {
|
||||
"description": "Defines methods that can be accessed by the component's reference.",
|
||||
"values": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
"MeterGroupPassThroughMethodOptions": {
|
||||
"description": "Custom passthrough(pt) option method.",
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "instance",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "any",
|
||||
"default": "",
|
||||
"description": "Defines instance."
|
||||
},
|
||||
{
|
||||
"name": "props",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupProps",
|
||||
"default": "",
|
||||
"description": "Defines valid properties."
|
||||
},
|
||||
{
|
||||
"name": "context",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupContext",
|
||||
"default": "",
|
||||
"description": "Defines current inline state."
|
||||
},
|
||||
{
|
||||
"name": "attrs",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "any",
|
||||
"default": "",
|
||||
"description": "Defines valid attributes."
|
||||
},
|
||||
{
|
||||
"name": "parent",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "any",
|
||||
"default": "",
|
||||
"description": "Defines parent options."
|
||||
},
|
||||
{
|
||||
"name": "global",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "undefined | object",
|
||||
"default": "",
|
||||
"description": "Defines passthrough(pt) options in global config."
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"MeterGroupPassThroughOptions": {
|
||||
"description": "Custom passthrough(pt) options.",
|
||||
"relatedProp": "MeterGroupProps.pt",
|
||||
"props": [
|
||||
{
|
||||
"name": "root",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the root's DOM element."
|
||||
},
|
||||
{
|
||||
"name": "labellist",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the label list's DOM element."
|
||||
},
|
||||
{
|
||||
"name": "labellistitem",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the label list item's DOM element."
|
||||
},
|
||||
{
|
||||
"name": "labellisttype",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the label list type's DOM element."
|
||||
},
|
||||
{
|
||||
"name": "label",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the label's DOM element."
|
||||
},
|
||||
{
|
||||
"name": "metercontainer",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the meter container's DOM element."
|
||||
},
|
||||
{
|
||||
"name": "meter",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterGroupPassThroughOptionType",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to the meter's DOM element."
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"MeterGroupPassThroughAttributes": {
|
||||
"description": "Custom passthrough attributes for each DOM elements",
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "[key: string]",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "any"
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"MeterGroupContext": {
|
||||
"description": "Defines current options in MeterGroup component.",
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "value",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "MeterItemOptions",
|
||||
"default": "",
|
||||
"description": "Current value of the meter item"
|
||||
},
|
||||
{
|
||||
"name": "index",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "number",
|
||||
"default": "",
|
||||
"description": "Current index of the meter item"
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"MeterItemOptions": {
|
||||
"description": "Defines valid properties of a meter item.",
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "label",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "Current label of the meter item."
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "number",
|
||||
"default": "",
|
||||
"description": "Current value of the meter item."
|
||||
},
|
||||
{
|
||||
"name": "color",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "Current color of the meter item."
|
||||
},
|
||||
{
|
||||
"name": "[key: string]",
|
||||
"optional": false,
|
||||
"readonly": false,
|
||||
"type": "any"
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"MeterGroupProps": {
|
||||
"description": "Defines valid properties in MeterGroup component.",
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "value",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "MeterItemOptions[]",
|
||||
"default": "",
|
||||
"description": "Current value of the metergroup."
|
||||
},
|
||||
{
|
||||
"name": "min",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "number",
|
||||
"default": "0",
|
||||
"description": "Mininum boundary value."
|
||||
},
|
||||
{
|
||||
"name": "max",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "number",
|
||||
"default": "100",
|
||||
"description": "Maximum boundary value."
|
||||
},
|
||||
{
|
||||
"name": "orientation",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "\"horizontal\" | \"vertical\"",
|
||||
"default": "horizontal",
|
||||
"description": "Specifies the layout of the component, valid values are 'horizontal' and 'vertical'."
|
||||
},
|
||||
{
|
||||
"name": "labelPosition",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "\"end\" | \"start\"",
|
||||
"default": "end",
|
||||
"description": "Specifies the label position of the component, valid values are 'start' and 'end'."
|
||||
},
|
||||
{
|
||||
"name": "labelOrientation",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "\"horizontal\" | \"vertical\"",
|
||||
"default": "horizontal",
|
||||
"description": "Specifies the label orientation of the component, valid values are 'horizontal' and 'vertical'."
|
||||
},
|
||||
{
|
||||
"name": "pt",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "PassThrough<MeterGroupPassThroughOptions>",
|
||||
"default": "",
|
||||
"description": "Used to pass attributes to DOM elements inside the component."
|
||||
},
|
||||
{
|
||||
"name": "ptOptions",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "PassThroughOptions",
|
||||
"default": "",
|
||||
"description": "Used to configure passthrough(pt) options of the component."
|
||||
},
|
||||
{
|
||||
"name": "unstyled",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "boolean",
|
||||
"default": "false",
|
||||
"description": "When enabled, it removes component related styles in the core."
|
||||
}
|
||||
],
|
||||
"methods": []
|
||||
},
|
||||
"MeterGroupSlots": {
|
||||
"description": "Defines valid slots in MeterGroup component.",
|
||||
"relatedProp": "",
|
||||
"props": [],
|
||||
"methods": [
|
||||
{
|
||||
"name": "label",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "scope",
|
||||
"optional": false,
|
||||
"type": "{\n \t <span class=\"ml-3 doc-option-parameter-name\">value</span>: <span class=\"doc-option-parameter-type\">MeterItemOptions</span>, <span class=\"doc-option-parameter-type\">// Current value of the component</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">totalPercent</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Total percent of the metergroup items</span>\n }"
|
||||
}
|
||||
],
|
||||
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
|
||||
"description": "Custom label template."
|
||||
},
|
||||
{
|
||||
"name": "meter",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "scope",
|
||||
"optional": false,
|
||||
"type": "{\n \t <span class=\"ml-3 doc-option-parameter-name\">value</span>: <span class=\"doc-option-parameter-type\">MeterItemOptions</span>, <span class=\"doc-option-parameter-type\">// Current value of the meter item</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">index</span>: <span class=\"doc-option-parameter-type\">number</span>, <span class=\"doc-option-parameter-type\">// Current index of the meter item</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">class</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Style class of the meter item</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">orientation</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Current orientation of the component</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">width</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Current width of the meter item</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">height</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Current height of the meter item</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">totalPercent</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Total percent of the metergroup items</span>\n }"
|
||||
}
|
||||
],
|
||||
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
|
||||
"description": "Custom meter template."
|
||||
},
|
||||
{
|
||||
"name": "start",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "scope",
|
||||
"optional": false,
|
||||
"type": "{\n \t <span class=\"ml-3 doc-option-parameter-name\">value</span>: <span class=\"doc-option-parameter-type\">MeterItemOptions</span>, <span class=\"doc-option-parameter-type\">// Current value of the component</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">totalPercent</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Total percent of the metergroup items</span>\n }"
|
||||
}
|
||||
],
|
||||
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
|
||||
"description": "Custom start template."
|
||||
},
|
||||
{
|
||||
"name": "end",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "scope",
|
||||
"optional": false,
|
||||
"type": "{\n \t <span class=\"ml-3 doc-option-parameter-name\">value</span>: <span class=\"doc-option-parameter-type\">MeterItemOptions</span>, <span class=\"doc-option-parameter-type\">// Current value of the component</span>\n \t <span class=\"ml-3 doc-option-parameter-name\">totalPercent</span>: <span class=\"doc-option-parameter-type\">string</span>, <span class=\"doc-option-parameter-type\">// Total percent of the metergroup items</span>\n }"
|
||||
}
|
||||
],
|
||||
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
|
||||
"description": "Custom end template."
|
||||
}
|
||||
]
|
||||
},
|
||||
"MeterGroupEmits": {
|
||||
"description": "Defines valid emits in MeterGroup component.",
|
||||
"relatedProp": "",
|
||||
"props": [],
|
||||
"methods": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"types": {
|
||||
"description": "Defines the custom types used by the module.",
|
||||
"values": {
|
||||
"MeterGroupPassThroughOptionType": {
|
||||
"values": "MeterGroupPassThroughAttributes | (options: MeterGroupPassThroughMethodOptions) => undefined | string | null | undefined"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"metergroup/style/MeterGroupStyle": {
|
||||
"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": {
|
||||
"MeterGroupStyle": {
|
||||
"relatedProp": "",
|
||||
"props": [
|
||||
{
|
||||
"name": "name",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "css",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "classes",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "object",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "inlineStyles",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "object",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "loadStyle",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "Function",
|
||||
"default": ""
|
||||
},
|
||||
{
|
||||
"name": "getStyleSheet",
|
||||
"optional": true,
|
||||
"readonly": false,
|
||||
"type": "Function",
|
||||
"default": ""
|
||||
}
|
||||
],
|
||||
"methods": [],
|
||||
"extendedTypes": "BaseStyle"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"multiselect": {
|
||||
"description": "MultiSelect is used to select multiple items from a collection.\n\n[Live Demo](https://www.primevue.org/multiselect/)",
|
||||
"components": {
|
||||
|
|
|
|||
Loading…
Reference in New Issue