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 Aug 16, 2023
1 parent c2a9570 commit 2afa48c
Showing 1 changed file with 234 additions and 0 deletions.
234 changes: 234 additions & 0 deletions components/doc/common/apidoc/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6490,6 +6490,12 @@
"optional": false,
"readonly": false,
"type": "CalendarState"
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "CalendarContext"
}
],
"callbacks": []
Expand Down Expand Up @@ -6907,6 +6913,118 @@
],
"callbacks": []
},
"CalendarContext": {
"description": "Defines current options in Calendar component.",
"relatedProp": "",
"props": [
{
"name": "date",
"optional": false,
"readonly": false,
"type": "undefined | null | string | string[] | Date | Date[]",
"description": "Current date."
},
{
"name": "today",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current today state of the calendar's day."
},
{
"name": "otherMonth",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current other month state of the calendar's day."
},
{
"name": "selected",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current selected state of the calendar's day or month or year."
},
{
"name": "disabled",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current disabled state of the calendar's day or month or year."
},
{
"name": "month",
"optional": false,
"readonly": false,
"type": "CalendarMonthOptions",
"description": "Current month state."
},
{
"name": "monthIndex",
"optional": false,
"readonly": false,
"type": "number",
"description": "Current month index state."
},
{
"name": "year",
"optional": false,
"readonly": false,
"type": "CalendarYearOptions",
"description": "Current year state."
},
{
"name": "yearIndex",
"optional": false,
"readonly": false,
"type": "number",
"description": "Current year index state."
}
],
"callbacks": []
},
"CalendarMonthOptions": {
"description": "Defines cuurent month options.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "string",
"description": "Month value."
},
{
"name": "selectable",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Selectable state of the month."
}
],
"callbacks": []
},
"CalendarYearOptions": {
"description": "Defines current year options.",
"relatedProp": "",
"props": [
{
"name": "value",
"optional": false,
"readonly": false,
"type": "number",
"description": "Year value."
},
{
"name": "selectable",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Selectable state of the month."
}
],
"callbacks": []
},
"CalendarSelectEvent": {
"description": "Custom Select event",
"relatedProp": "onSelect",
Expand Down Expand Up @@ -7368,6 +7486,12 @@
"optional": false,
"readonly": false,
"type": "CarouselState"
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "CarouselContext"
}
],
"callbacks": []
Expand Down Expand Up @@ -7526,6 +7650,20 @@
],
"callbacks": []
},
"CarouselContext": {
"description": "Defines current inline options in Carousel component.",
"relatedProp": "",
"props": [
{
"name": "active",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current active state of the indicator as a boolean."
}
],
"callbacks": []
},
"CarouselResponsiveOption": {
"description": "Custom responsive option",
"relatedProp": "responsiveOptions",
Expand Down Expand Up @@ -18549,6 +18687,12 @@
"optional": false,
"readonly": false,
"type": "DockState"
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "DockContext"
}
],
"callbacks": []
Expand Down Expand Up @@ -18630,6 +18774,27 @@
],
"callbacks": []
},
"DockContext": {
"description": "Defines current options in Dock component.",
"relatedProp": "",
"props": [
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"description": "Current index of the menuitem."
},
{
"name": "item",
"optional": false,
"readonly": false,
"type": "any",
"description": "Current menuitem"
}
],
"callbacks": []
},
"DockHeaderTemplateOptions": {
"description": "Custom header template",
"relatedProp": "header",
Expand Down Expand Up @@ -48344,6 +48509,12 @@
"optional": false,
"readonly": false,
"type": "TreeTableState"
},
{
"name": "context",
"optional": false,
"readonly": false,
"type": "TreeTableContext"
}
],
"callbacks": []
Expand Down Expand Up @@ -48719,6 +48890,69 @@
],
"callbacks": []
},
"TreeTableContext": {
"description": "Defines current options in TreeTable component.",
"relatedProp": "",
"props": [
{
"name": "index",
"optional": false,
"readonly": false,
"type": "number",
"description": "Current index state of the item."
},
{
"name": "frozen",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current frozen state of the row as a boolean."
},
{
"name": "checked",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current checked state of the column checkbox as a boolean."
},
{
"name": "partialChecked",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current partial checked state of the column checkbox as a boolean."
},
{
"name": "selectable",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current selectable state of the row as a boolean."
},
{
"name": "scrollable",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current scrollable state of the row as a boolean."
},
{
"name": "showGridlines",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "Current showGridlines state of the row as a boolean."
},
{
"name": "selected",
"optional": false,
"readonly": false,
"type": "boolean",
"description": "x\nCurrent selected state of the row as a boolean."
}
],
"callbacks": []
},
"TreeTableTogglerTemplateOptions": {
"description": "Custom treetable toggler template options",
"relatedProp": "",
Expand Down

0 comments on commit 2afa48c

Please sign in to comment.