Skip to content

Commit

Permalink
Update API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions Bot committed Apr 4, 2023
1 parent fd0ef09 commit d3c5ef8
Showing 1 changed file with 161 additions and 23 deletions.
184 changes: 161 additions & 23 deletions doc/common/apidoc/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2922,7 +2922,7 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-chevron-down",
"default": "",
"description": "Icon to display in the dropdown."
},
{
Expand All @@ -2938,15 +2938,15 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-spinner pi-spin",
"default": "",
"description": "Icon to display in loading state."
},
{
"name": "removeTokenIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-times-circle",
"default": "",
"description": "Icon to display in chip remove action."
},
{
Expand Down Expand Up @@ -3155,6 +3155,24 @@
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom empty template when there is no data to display."
},
{
"name": "dropdownicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom dropdown icon template."
},
{
"name": "removetokenicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom remove token icon template in multiple mode."
},
{
"name": "loadingicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom loading icon template."
}
]
},
Expand Down Expand Up @@ -5346,23 +5364,23 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-chevron-down",
"default": "",
"description": "Icon to display in the dropdown."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-spinner pi-spin",
"default": "",
"description": "Icon to display in loading state."
},
{
"name": "optionGroupIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-angle-right",
"default": "",
"description": "Icon to display in the option group."
},
{
Expand Down Expand Up @@ -5492,6 +5510,12 @@
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom indicator template."
},
{
"name": "optiongroupicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom option group icon template."
}
]
},
Expand Down Expand Up @@ -5939,7 +5963,21 @@
"CheckboxSlots": {
"relatedProp": "",
"props": [],
"methods": []
"methods": [
{
"name": "icon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t <b>checked</b>: boolean, // State of the checkbox.\n }",
"description": "icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom icon template."
}
]
},
"CheckboxEmits": {
"description": "Defines valid emits in Checkbox component.",
Expand Down Expand Up @@ -6249,7 +6287,7 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-times-circle",
"default": "",
"description": "Icon to display in chip remove action."
},
{
Expand Down Expand Up @@ -6304,6 +6342,12 @@
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom chip template."
},
{
"name": "removetokenicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom remove token icon template."
}
]
},
Expand Down Expand Up @@ -14390,15 +14434,15 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-angle-up",
"default": "",
"description": "Style class of the increment button."
},
{
"name": "decrementButtonIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-angle-down",
"default": "",
"description": "Style class of the decrement button."
},
{
Expand Down Expand Up @@ -14616,7 +14660,20 @@
"description": "Defines valid slots in InputNumber component.",
"relatedProp": "",
"props": [],
"methods": []
"methods": [
{
"name": "incrementbuttonicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom increment button icon template."
},
{
"name": "decrementbuttonicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom decrement button icon template."
}
]
},
"InputNumberEmits": {
"description": "Defines valid emits in InputNumber component.",
Expand Down Expand Up @@ -15492,6 +15549,12 @@
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom loader template."
},
{
"name": "filtericon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom filter icon template."
}
]
},
Expand Down Expand Up @@ -16655,47 +16718,47 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-check",
"default": "",
"description": "Icon to display in the checkboxes."
},
{
"name": "closeIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-times",
"default": "",
"description": "Icon to display in the dropdown close button."
},
{
"name": "dropdownIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-chevron-down",
"default": "",
"description": "Icon to display in the dropdown."
},
{
"name": "filterIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-search",
"default": "",
"description": "Icon to display in filter input."
},
{
"name": "loadingIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-spinner pi-spin",
"default": "",
"description": "Icon to display in loading state."
},
{
"name": "removeTokenIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-times-circle",
"default": "",
"description": "Icon to display in chip remove action."
},
{
Expand Down Expand Up @@ -16931,6 +16994,50 @@
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom loader template."
},
{
"name": "removetokenicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom remove token icon template."
},
{
"name": "headercheckboxicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t <b>allSelected</b>: boolean, // Options of the loader items for virtualscroller\n }",
"description": "header checkbox icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom header checkbox icon template."
},
{
"name": "filtericon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom filter icon template."
},
{
"name": "closeicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom close icon template."
},
{
"name": "itemcheckboxicon",
"parameters": [
{
"name": "scope",
"optional": false,
"type": "{\n \t <b>selected</b>: boolean, // Options of the loader items for virtualscroller\n }",
"description": "header checkbox icon slot's params."
}
],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom item checkbox icon template."
}
]
},
Expand Down Expand Up @@ -18589,15 +18696,15 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-eye-slash",
"default": "",
"description": "Icon to hide displaying the password as plain text."
},
{
"name": "showIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-eye",
"default": "",
"description": "Icon to show displaying the password as plain text."
},
{
Expand Down Expand Up @@ -18730,6 +18837,18 @@
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom content template."
},
{
"name": "hideicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom hide icon template."
},
{
"name": "showicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom show icon template."
}
]
},
Expand Down Expand Up @@ -19735,23 +19854,23 @@
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-star",
"default": "",
"description": "Icon for the on state."
},
{
"name": "offIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-star-fill",
"default": "",
"description": "Icon for the off state."
},
{
"name": "cancelIcon",
"optional": true,
"readonly": false,
"type": "string",
"default": "pi pi-ban",
"default": "",
"description": "Icon for the cancelable state."
}
],
Expand Down Expand Up @@ -25691,7 +25810,26 @@
"description": "Defines valid slots in TriStateCheckbox component.",
"relatedProp": "",
"props": [],
"methods": []
"methods": [
{
"name": "checkicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom check icon template."
},
{
"name": "uncheckicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom uncheck icon template."
},
{
"name": "nullableicon",
"parameters": [],
"returnType": "VNode<RendererNode, RendererElement, Object>[]",
"description": "Custom nullable icon template."
}
]
},
"TriStateCheckboxEmits": {
"description": "Defines valid emits in TriStateCheckbox component.",
Expand Down

0 comments on commit d3c5ef8

Please sign in to comment.