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 Jan 3, 2025
1 parent 4fad1ca commit 7dd20db
Showing 1 changed file with 24 additions and 21 deletions.
45 changes: 24 additions & 21 deletions components/doc/common/apidoc/index.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5948,7 +5948,7 @@
{
"name": "getCurrentDateTime",
"parameters": [],
"returnType": "Date | Date[]",
"returnType": "TValue",
"description": "Used to get the current date."
},
{
Expand All @@ -5972,7 +5972,7 @@
{
"name": "getViewDate",
"parameters": [],
"returnType": "Date | Date[]",
"returnType": "TValue",
"description": "Used to get the view date."
},
{
Expand All @@ -5997,7 +5997,7 @@
},
{
"name": "value",
"type": "Nullable<Date | Date[]>",
"type": "Nullable<TValue>",
"description": "New date."
}
],
Expand All @@ -6007,7 +6007,7 @@
]
},
"props": {
"description": "Defines valid properties in single Calendar component.",
"description": "Defines valid properties in Calendar component.",
"values": [
{
"name": "appendTo",
Expand Down Expand Up @@ -6093,7 +6093,7 @@
"name": "decrementIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"default": "",
"description": "Icon to show in each of the decrement buttons."
},
Expand Down Expand Up @@ -6157,7 +6157,7 @@
"name": "icon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"default": "",
"description": "Icon of the calendar button."
},
Expand All @@ -6181,7 +6181,7 @@
"name": "incrementIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"default": "",
"description": "Icon to show in each of the increment buttons."
},
Expand Down Expand Up @@ -6309,7 +6309,7 @@
"name": "nextIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"default": "",
"description": "Icon to show in the next button."
},
Expand Down Expand Up @@ -6349,7 +6349,7 @@
"name": "prevIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"default": "",
"description": "Icon to show in the previous button."
},
Expand Down Expand Up @@ -6389,7 +6389,7 @@
"name": "selectionMode",
"optional": true,
"readonly": false,
"type": "\"single\"",
"type": "TMode",
"default": "single",
"description": "Specifies the selection mode either \"single\", \"range\", or \"multiple\";"
},
Expand Down Expand Up @@ -6589,7 +6589,7 @@
"name": "value",
"optional": true,
"readonly": false,
"type": "Nullable<Date>",
"type": "Nullable<TValue>",
"default": "null",
"description": "Value of the component."
},
Expand Down Expand Up @@ -6729,7 +6729,7 @@
{
"name": "event",
"optional": false,
"type": "FormEvent<Date, SyntheticEvent<Element, Event>>",
"type": "FormEvent<TValue, SyntheticEvent<Element, Event>>",
"description": "Custom change event"
}
],
Expand Down Expand Up @@ -7036,7 +7036,7 @@
"name": "props",
"optional": false,
"readonly": false,
"type": "CalendarProps",
"type": "CalendarProps<\"single\", Date>",
"description": "The props of Calendar component"
}
]
Expand Down Expand Up @@ -7084,7 +7084,7 @@
"name": "props",
"optional": false,
"readonly": false,
"type": "CalendarProps",
"type": "CalendarProps<\"single\", Date>",
"description": "The props of Calendar component"
}
]
Expand All @@ -7102,7 +7102,7 @@
"name": "props",
"optional": false,
"readonly": false,
"type": "CalendarProps"
"type": "CalendarProps<\"single\", Date>"
},
{
"name": "state",
Expand Down Expand Up @@ -7757,7 +7757,7 @@
"name": "decrementIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"description": "Icon to show in each of the decrement buttons."
},
{
Expand Down Expand Up @@ -7827,7 +7827,7 @@
"name": "icon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"description": "Icon of the calendar button."
},
{
Expand All @@ -7841,7 +7841,7 @@
"name": "incrementIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"description": "Icon to show in each of the increment buttons."
},
{
Expand Down Expand Up @@ -7946,7 +7946,7 @@
"name": "nextIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"description": "Icon to show in the next button."
},
{
Expand Down Expand Up @@ -7981,7 +7981,7 @@
"name": "prevIcon",
"optional": true,
"readonly": false,
"type": "IconType<CalendarProps>",
"type": "IconType<CalendarProps<\"single\", Date>>",
"description": "Icon to show in the previous button."
},
{
Expand Down Expand Up @@ -8444,7 +8444,7 @@
"description": "Function that gets a navigator information and returns the navigator in header."
}
],
"extendedBy": "CalendarPropsSingle,CalendarPropsRange,CalendarPropsMultiple"
"extendedBy": "CalendarProps"
}
}
},
Expand All @@ -8456,6 +8456,9 @@
},
"CalendarPassThroughTransitionType": {
"values": "ReactCSSTransitionProps | Function | undefined"
},
"CalendarSelectionMode": {
"values": "\"single\" | \"range\" | \"multiple\""
}
}
}
Expand Down

0 comments on commit 7dd20db

Please sign in to comment.