Skip to content

Commit

Permalink
docs:api
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasTy committed Dec 20, 2022
1 parent 467a916 commit 55a3c0b
Show file tree
Hide file tree
Showing 36 changed files with 653 additions and 24 deletions.
47 changes: 46 additions & 1 deletion docs/pages/x/api/date-pickers/date-field.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,48 @@
{
"props": {
"autoFocus": { "type": { "name": "bool" } },
"color": {
"type": {
"name": "enum",
"description": "'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'secondary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'primary'"
},
"components": { "type": { "name": "object" }, "default": "{}" },
"componentsProps": { "type": { "name": "object" }, "default": "{}" },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"focused": { "type": { "name": "bool" } },
"format": { "type": { "name": "string" } },
"FormHelperTextProps": { "type": { "name": "object" } },
"fullWidth": { "type": { "name": "bool" } },
"helperText": { "type": { "name": "node" } },
"hiddenLabel": { "type": { "name": "bool" } },
"id": { "type": { "name": "string" } },
"InputLabelProps": { "type": { "name": "object" } },
"inputProps": { "type": { "name": "object" } },
"InputProps": { "type": { "name": "object" } },
"inputRef": {
"type": { "name": "union", "description": "func<br>&#124;&nbsp;{ current: any }" }
},
"label": { "type": { "name": "node" } },
"margin": {
"type": {
"name": "enum",
"description": "'dense'<br>&#124;&nbsp;'none'<br>&#124;&nbsp;'normal'"
},
"default": "'none'"
},
"maxDate": { "type": { "name": "any" } },
"minDate": { "type": { "name": "any" } },
"name": { "type": { "name": "string" } },
"onChange": { "type": { "name": "func" } },
"onError": { "type": { "name": "func" } },
"onSelectedSectionsChange": { "type": { "name": "func" } },
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"selectedSections": {
"type": {
"name": "union",
Expand All @@ -21,7 +52,21 @@
"shouldDisableDate": { "type": { "name": "func" } },
"shouldDisableMonth": { "type": { "name": "func" } },
"shouldDisableYear": { "type": { "name": "func" } },
"value": { "type": { "name": "any" } }
"size": { "type": { "name": "enum", "description": "'medium'<br>&#124;&nbsp;'small'" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"value": { "type": { "name": "any" } },
"variant": {
"type": {
"name": "enum",
"description": "'filled'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'standard'"
},
"default": "'outlined'"
}
},
"slots": { "Input": { "default": "TextField", "type": { "name": "elementType" } } },
"name": "DateField",
Expand Down
27 changes: 26 additions & 1 deletion docs/pages/x/api/date-pickers/date-range-picker-day.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,39 @@
"isStartOfHighlighting": { "type": { "name": "bool" }, "required": true },
"isStartOfPreviewing": { "type": { "name": "bool" }, "required": true },
"outsideCurrentMonth": { "type": { "name": "bool" }, "required": true },
"action": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
}
},
"centerRipple": { "type": { "name": "bool" } },
"classes": { "type": { "name": "object" } },
"disabled": { "type": { "name": "bool" } },
"disableHighlightToday": { "type": { "name": "bool" } },
"disableMargin": { "type": { "name": "bool" } },
"disableRipple": { "type": { "name": "bool" } },
"disableTouchRipple": { "type": { "name": "bool" } },
"focusRipple": { "type": { "name": "bool" } },
"focusVisibleClassName": { "type": { "name": "string" } },
"isVisuallySelected": { "type": { "name": "bool" } },
"onFocusVisible": { "type": { "name": "func" } },
"selected": { "type": { "name": "bool" } },
"showDaysOutsideCurrentMonth": { "type": { "name": "bool" } },
"today": { "type": { "name": "bool" } }
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"today": { "type": { "name": "bool" } },
"TouchRippleProps": { "type": { "name": "object" } },
"touchRippleRef": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { pulsate: func, start: func, stop: func } }"
}
}
},
"slots": {},
"name": "DateRangePickerDay",
Expand Down
47 changes: 46 additions & 1 deletion docs/pages/x/api/date-pickers/date-time-field.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,55 @@
{
"props": {
"ampm": { "type": { "name": "bool" }, "default": "`utils.is12HourCycleInCurrentLocale()`" },
"autoFocus": { "type": { "name": "bool" } },
"color": {
"type": {
"name": "enum",
"description": "'error'<br>&#124;&nbsp;'info'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'secondary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'"
},
"default": "'primary'"
},
"components": { "type": { "name": "object" }, "default": "{}" },
"componentsProps": { "type": { "name": "object" }, "default": "{}" },
"defaultValue": { "type": { "name": "any" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
"disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"focused": { "type": { "name": "bool" } },
"format": { "type": { "name": "string" } },
"FormHelperTextProps": { "type": { "name": "object" } },
"fullWidth": { "type": { "name": "bool" } },
"helperText": { "type": { "name": "node" } },
"hiddenLabel": { "type": { "name": "bool" } },
"id": { "type": { "name": "string" } },
"InputLabelProps": { "type": { "name": "object" } },
"inputProps": { "type": { "name": "object" } },
"InputProps": { "type": { "name": "object" } },
"inputRef": {
"type": { "name": "union", "description": "func<br>&#124;&nbsp;{ current: any }" }
},
"label": { "type": { "name": "node" } },
"margin": {
"type": {
"name": "enum",
"description": "'dense'<br>&#124;&nbsp;'none'<br>&#124;&nbsp;'normal'"
},
"default": "'none'"
},
"maxDate": { "type": { "name": "any" } },
"maxDateTime": { "type": { "name": "any" } },
"maxTime": { "type": { "name": "any" } },
"minDate": { "type": { "name": "any" } },
"minDateTime": { "type": { "name": "any" } },
"minTime": { "type": { "name": "any" } },
"minutesStep": { "type": { "name": "number" }, "default": "1" },
"name": { "type": { "name": "string" } },
"onChange": { "type": { "name": "func" } },
"onError": { "type": { "name": "func" } },
"onSelectedSectionsChange": { "type": { "name": "func" } },
"readOnly": { "type": { "name": "bool" } },
"required": { "type": { "name": "bool" } },
"selectedSections": {
"type": {
"name": "union",
Expand All @@ -29,7 +60,21 @@
"shouldDisableMonth": { "type": { "name": "func" } },
"shouldDisableTime": { "type": { "name": "func" } },
"shouldDisableYear": { "type": { "name": "func" } },
"value": { "type": { "name": "any" } }
"size": { "type": { "name": "enum", "description": "'medium'<br>&#124;&nbsp;'small'" } },
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"value": { "type": { "name": "any" } },
"variant": {
"type": {
"name": "enum",
"description": "'filled'<br>&#124;&nbsp;'outlined'<br>&#124;&nbsp;'standard'"
},
"default": "'outlined'"
}
},
"slots": { "Input": { "default": "TextField", "type": { "name": "elementType" } } },
"name": "DateTimeField",
Expand Down
21 changes: 21 additions & 0 deletions docs/pages/x/api/date-pickers/multi-input-date-range-field.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@
"components": { "type": { "name": "object" }, "default": "{}" },
"componentsProps": { "type": { "name": "object" }, "default": "{}" },
"defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
"direction": {
"type": {
"name": "union",
"description": "'column-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'row'<br>&#124;&nbsp;Array&lt;'column-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'row'&gt;<br>&#124;&nbsp;object"
},
"default": "'column'"
},
"disableFuture": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"divider": { "type": { "name": "node" } },
"format": { "type": { "name": "string" } },
"maxDate": { "type": { "name": "any" } },
"minDate": { "type": { "name": "any" } },
Expand All @@ -19,6 +27,19 @@
}
},
"shouldDisableDate": { "type": { "name": "func" } },
"spacing": {
"type": {
"name": "union",
"description": "Array&lt;number<br>&#124;&nbsp;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;object<br>&#124;&nbsp;string"
},
"default": "0"
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"value": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } }
},
"slots": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@
"components": { "type": { "name": "object" }, "default": "{}" },
"componentsProps": { "type": { "name": "object" }, "default": "{}" },
"defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
"direction": {
"type": {
"name": "union",
"description": "'column-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'row'<br>&#124;&nbsp;Array&lt;'column-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'row'&gt;<br>&#124;&nbsp;object"
},
"default": "'column'"
},
"disableFuture": { "type": { "name": "bool" } },
"disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"divider": { "type": { "name": "node" } },
"format": { "type": { "name": "string" } },
"maxDate": { "type": { "name": "any" } },
"maxDateTime": { "type": { "name": "any" } },
Expand All @@ -27,6 +35,19 @@
},
"shouldDisableDate": { "type": { "name": "func" } },
"shouldDisableTime": { "type": { "name": "func" } },
"spacing": {
"type": {
"name": "union",
"description": "Array&lt;number<br>&#124;&nbsp;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;object<br>&#124;&nbsp;string"
},
"default": "0"
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"value": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } }
},
"slots": {
Expand Down
21 changes: 21 additions & 0 deletions docs/pages/x/api/date-pickers/multi-input-time-range-field.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@
"components": { "type": { "name": "object" }, "default": "{}" },
"componentsProps": { "type": { "name": "object" }, "default": "{}" },
"defaultValue": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } },
"direction": {
"type": {
"name": "union",
"description": "'column-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'row'<br>&#124;&nbsp;Array&lt;'column-reverse'<br>&#124;&nbsp;'column'<br>&#124;&nbsp;'row-reverse'<br>&#124;&nbsp;'row'&gt;<br>&#124;&nbsp;object"
},
"default": "'column'"
},
"disableFuture": { "type": { "name": "bool" } },
"disableIgnoringDatePartForTimeValidation": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"divider": { "type": { "name": "node" } },
"format": { "type": { "name": "string" } },
"maxTime": { "type": { "name": "any" } },
"minTime": { "type": { "name": "any" } },
Expand All @@ -22,6 +30,19 @@
}
},
"shouldDisableTime": { "type": { "name": "func" } },
"spacing": {
"type": {
"name": "union",
"description": "Array&lt;number<br>&#124;&nbsp;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;object<br>&#124;&nbsp;string"
},
"default": "0"
},
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"value": { "type": { "name": "arrayOf", "description": "Array&lt;any&gt;" } }
},
"slots": {
Expand Down
27 changes: 26 additions & 1 deletion docs/pages/x/api/date-pickers/pickers-day.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,38 @@
"props": {
"day": { "type": { "name": "any" }, "required": true },
"outsideCurrentMonth": { "type": { "name": "bool" }, "required": true },
"action": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { focusVisible: func } }"
}
},
"centerRipple": { "type": { "name": "bool" } },
"classes": { "type": { "name": "object" } },
"disabled": { "type": { "name": "bool" } },
"disableHighlightToday": { "type": { "name": "bool" } },
"disableMargin": { "type": { "name": "bool" } },
"disableRipple": { "type": { "name": "bool" } },
"disableTouchRipple": { "type": { "name": "bool" } },
"focusRipple": { "type": { "name": "bool" } },
"focusVisibleClassName": { "type": { "name": "string" } },
"onFocusVisible": { "type": { "name": "func" } },
"selected": { "type": { "name": "bool" } },
"showDaysOutsideCurrentMonth": { "type": { "name": "bool" } },
"today": { "type": { "name": "bool" } }
"sx": {
"type": {
"name": "union",
"description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
}
},
"today": { "type": { "name": "bool" } },
"TouchRippleProps": { "type": { "name": "object" } },
"touchRippleRef": {
"type": {
"name": "union",
"description": "func<br>&#124;&nbsp;{ current?: { pulsate: func, start: func, stop: func } }"
}
}
},
"slots": {},
"name": "PickersDay",
Expand Down
Loading

0 comments on commit 55a3c0b

Please sign in to comment.