Skip to content

Commit

Permalink
[docs] Fix typo in API docs (#36388)
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanHotsiy authored Mar 21, 2023
1 parent 1a14b54 commit 225d6e7
Show file tree
Hide file tree
Showing 14 changed files with 99 additions and 99 deletions.
88 changes: 44 additions & 44 deletions docs/pages/base/api/use-autocomplete.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"parameters": {
"options": {
"type": { "name": "ReadonlyArray<T&gt", "description": "ReadonlyArray<T&gt" },
"type": { "name": "ReadonlyArray<T>", "description": "ReadonlyArray<T>" },
"required": true
},
"autoComplete": { "type": { "name": "boolean", "description": "boolean" }, "default": "false" },
Expand All @@ -28,8 +28,8 @@
"componentName": { "type": { "name": "string", "description": "string" } },
"defaultValue": {
"type": {
"name": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt",
"description": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt"
"name": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>",
"description": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>"
},
"default": "props.multiple ? [] : null"
},
Expand All @@ -52,8 +52,8 @@
},
"filterOptions": {
"type": {
"name": "(options: T[], state: FilterOptionsState<T&gt) =&gt T[]",
"description": "(options: T[], state: FilterOptionsState<T&gt) =&gt T[]"
"name": "(options: T[], state: FilterOptionsState<T>) => T[]",
"description": "(options: T[], state: FilterOptionsState<T>) => T[]"
}
},
"filterSelectedOptions": {
Expand All @@ -62,17 +62,17 @@
},
"freeSolo": { "type": { "name": "FreeSolo", "description": "FreeSolo" }, "default": "false" },
"getOptionDisabled": {
"type": { "name": "(option: T) =&gt boolean", "description": "(option: T) =&gt boolean" }
"type": { "name": "(option: T) => boolean", "description": "(option: T) => boolean" }
},
"getOptionLabel": {
"type": {
"name": "(option: T | AutocompleteFreeSoloValueMapping<FreeSolo&gt) =&gt string",
"description": "(option: T | AutocompleteFreeSoloValueMapping<FreeSolo&gt) =&gt string"
"name": "(option: T | AutocompleteFreeSoloValueMapping<FreeSolo>) => string",
"description": "(option: T | AutocompleteFreeSoloValueMapping<FreeSolo>) => string"
},
"default": "(option) => option.label ?? option"
},
"groupBy": {
"type": { "name": "(option: T) =&gt string", "description": "(option: T) =&gt string" }
"type": { "name": "(option: T) => string", "description": "(option: T) => string" }
},
"handleHomeEndKeys": {
"type": { "name": "boolean", "description": "boolean" },
Expand All @@ -86,39 +86,39 @@
"inputValue": { "type": { "name": "string", "description": "string" } },
"isOptionEqualToValue": {
"type": {
"name": "(option: T, value: T) =&gt boolean",
"description": "(option: T, value: T) =&gt boolean"
"name": "(option: T, value: T) => boolean",
"description": "(option: T, value: T) => boolean"
}
},
"multiple": { "type": { "name": "Multiple", "description": "Multiple" }, "default": "false" },
"onChange": {
"type": {
"name": "(event: React.SyntheticEvent, value: AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<T&gt) =&gt void",
"description": "(event: React.SyntheticEvent, value: AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<T&gt) =&gt void"
"name": "(event: React.SyntheticEvent, value: AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<T>) => void",
"description": "(event: React.SyntheticEvent, value: AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>, reason: AutocompleteChangeReason, details?: AutocompleteChangeDetails<T>) => void"
}
},
"onClose": {
"type": {
"name": "(event: React.SyntheticEvent, reason: AutocompleteCloseReason) =&gt void",
"description": "(event: React.SyntheticEvent, reason: AutocompleteCloseReason) =&gt void"
"name": "(event: React.SyntheticEvent, reason: AutocompleteCloseReason) => void",
"description": "(event: React.SyntheticEvent, reason: AutocompleteCloseReason) => void"
}
},
"onHighlightChange": {
"type": {
"name": "(event: React.SyntheticEvent, option: T | null, reason: AutocompleteHighlightChangeReason) =&gt void",
"description": "(event: React.SyntheticEvent, option: T | null, reason: AutocompleteHighlightChangeReason) =&gt void"
"name": "(event: React.SyntheticEvent, option: T | null, reason: AutocompleteHighlightChangeReason) => void",
"description": "(event: React.SyntheticEvent, option: T | null, reason: AutocompleteHighlightChangeReason) => void"
}
},
"onInputChange": {
"type": {
"name": "(event: React.SyntheticEvent, value: string, reason: AutocompleteInputChangeReason) =&gt void",
"description": "(event: React.SyntheticEvent, value: string, reason: AutocompleteInputChangeReason) =&gt void"
"name": "(event: React.SyntheticEvent, value: string, reason: AutocompleteInputChangeReason) => void",
"description": "(event: React.SyntheticEvent, value: string, reason: AutocompleteInputChangeReason) => void"
}
},
"onOpen": {
"type": {
"name": "(event: React.SyntheticEvent) =&gt void",
"description": "(event: React.SyntheticEvent) =&gt void"
"name": "(event: React.SyntheticEvent) => void",
"description": "(event: React.SyntheticEvent) => void"
}
},
"open": { "type": { "name": "boolean", "description": "boolean" } },
Expand All @@ -134,14 +134,14 @@
},
"unstable_isActiveElementInListbox": {
"type": {
"name": "(listbox: React.RefObject<HTMLElement&gt) =&gt boolean",
"description": "(listbox: React.RefObject<HTMLElement&gt) =&gt boolean"
"name": "(listbox: React.RefObject<HTMLElement>) => boolean",
"description": "(listbox: React.RefObject<HTMLElement>) => boolean"
}
},
"value": {
"type": {
"name": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt",
"description": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt"
"name": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>",
"description": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>"
}
}
},
Expand Down Expand Up @@ -172,50 +172,50 @@
},
"getClearProps": {
"type": {
"name": "() =&gt React.HTMLAttributes<HTMLButtonElement&gt",
"description": "() =&gt React.HTMLAttributes<HTMLButtonElement&gt"
"name": "() => React.HTMLAttributes<HTMLButtonElement>",
"description": "() => React.HTMLAttributes<HTMLButtonElement>"
},
"required": true
},
"getInputLabelProps": {
"type": {
"name": "() =&gt Omit<React.HTMLAttributes<HTMLLabelElement&gt, 'color'&gt",
"description": "() =&gt Omit<React.HTMLAttributes<HTMLLabelElement&gt, 'color'&gt"
"name": "() => Omit<React.HTMLAttributes<HTMLLabelElement>, 'color'>",
"description": "() => Omit<React.HTMLAttributes<HTMLLabelElement>, 'color'>"
},
"required": true
},
"getInputProps": {
"type": {
"name": "() =&gt React.InputHTMLAttributes<HTMLInputElement&gt",
"description": "() =&gt React.InputHTMLAttributes<HTMLInputElement&gt"
"name": "() => React.InputHTMLAttributes<HTMLInputElement>",
"description": "() => React.InputHTMLAttributes<HTMLInputElement>"
},
"required": true
},
"getListboxProps": {
"type": {
"name": "() =&gt React.HTMLAttributes<HTMLUListElement&gt",
"description": "() =&gt React.HTMLAttributes<HTMLUListElement&gt"
"name": "() => React.HTMLAttributes<HTMLUListElement>",
"description": "() => React.HTMLAttributes<HTMLUListElement>"
},
"required": true
},
"getOptionProps": {
"type": {
"name": "(renderedOption: UseAutocompleteRenderedOption<T&gt) =&gt React.HTMLAttributes<HTMLLIElement&gt",
"description": "(renderedOption: UseAutocompleteRenderedOption<T&gt) =&gt React.HTMLAttributes<HTMLLIElement&gt"
"name": "(renderedOption: UseAutocompleteRenderedOption<T>) => React.HTMLAttributes<HTMLLIElement>",
"description": "(renderedOption: UseAutocompleteRenderedOption<T>) => React.HTMLAttributes<HTMLLIElement>"
},
"required": true
},
"getPopupIndicatorProps": {
"type": {
"name": "() =&gt React.HTMLAttributes<HTMLButtonElement&gt",
"description": "() =&gt React.HTMLAttributes<HTMLButtonElement&gt"
"name": "() => React.HTMLAttributes<HTMLButtonElement>",
"description": "() => React.HTMLAttributes<HTMLButtonElement>"
},
"required": true
},
"getRootProps": {
"type": {
"name": "(externalProps?: any) =&gt React.HTMLAttributes<HTMLDivElement&gt",
"description": "(externalProps?: any) =&gt React.HTMLAttributes<HTMLDivElement&gt"
"name": "(externalProps?: any) => React.HTMLAttributes<HTMLDivElement>",
"description": "(externalProps?: any) => React.HTMLAttributes<HTMLDivElement>"
},
"required": true
},
Expand All @@ -225,8 +225,8 @@
},
"groupedOptions": {
"type": {
"name": "T[] | Array<AutocompleteGroupedOption<T&gt&gt",
"description": "T[] | Array<AutocompleteGroupedOption<T&gt&gt"
"name": "T[] | Array<AutocompleteGroupedOption<T>>",
"description": "T[] | Array<AutocompleteGroupedOption<T>>"
},
"required": true
},
Expand All @@ -238,13 +238,13 @@
"required": true
},
"setAnchorEl": {
"type": { "name": "() =&gt void", "description": "() =&gt void" },
"type": { "name": "() => void", "description": "() => void" },
"required": true
},
"value": {
"type": {
"name": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt",
"description": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo&gt"
"name": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>",
"description": "AutocompleteValue<T, Multiple, DisableClearable, FreeSolo>"
},
"required": true
}
Expand Down
18 changes: 9 additions & 9 deletions docs/pages/base/api/use-button.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
"onFocusVisible": {
"type": { "name": "React.FocusEventHandler", "description": "React.FocusEventHandler" }
},
"ref": { "type": { "name": "React.Ref<any&gt", "description": "React.Ref<any&gt" } },
"ref": { "type": { "name": "React.Ref<any>", "description": "React.Ref<any>" } },
"tabIndex": {
"type": {
"name": "NonNullable<React.HTMLAttributes<any&gt['tabIndex']&gt",
"description": "NonNullable<React.HTMLAttributes<any&gt['tabIndex']&gt"
"name": "NonNullable<React.HTMLAttributes<any>['tabIndex']>",
"description": "NonNullable<React.HTMLAttributes<any>['tabIndex']>"
}
},
"to": { "type": { "name": "string", "description": "string" } },
"type": {
"type": {
"name": "React.ButtonHTMLAttributes<HTMLButtonElement&gt['type']",
"description": "React.ButtonHTMLAttributes<HTMLButtonElement&gt['type']"
"name": "React.ButtonHTMLAttributes<HTMLButtonElement>['type']",
"description": "React.ButtonHTMLAttributes<HTMLButtonElement>['type']"
},
"default": "'button'"
}
Expand All @@ -43,15 +43,15 @@
},
"getRootProps": {
"type": {
"name": "<TOther extends EventHandlers = {}&gt(otherHandlers?: TOther) =&gt UseButtonRootSlotProps<TOther&gt",
"description": "<TOther extends EventHandlers = {}&gt(otherHandlers?: TOther) =&gt UseButtonRootSlotProps<TOther&gt"
"name": "<TOther extends EventHandlers = {}>(otherHandlers?: TOther) => UseButtonRootSlotProps<TOther>",
"description": "<TOther extends EventHandlers = {}>(otherHandlers?: TOther) => UseButtonRootSlotProps<TOther>"
},
"required": true
},
"setFocusVisible": {
"type": {
"name": "React.Dispatch<React.SetStateAction<boolean&gt&gt",
"description": "React.Dispatch<React.SetStateAction<boolean&gt&gt"
"name": "React.Dispatch<React.SetStateAction<boolean>>",
"description": "React.Dispatch<React.SetStateAction<boolean>>"
},
"required": true
}
Expand Down
16 changes: 8 additions & 8 deletions docs/pages/base/api/use-input.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
"error": { "type": { "name": "boolean", "description": "boolean" } },
"inputRef": {
"type": {
"name": "React.Ref<HTMLInputElement&gt",
"description": "React.Ref<HTMLInputElement&gt"
"name": "React.Ref<HTMLInputElement>",
"description": "React.Ref<HTMLInputElement>"
}
},
"onBlur": {
"type": { "name": "React.FocusEventHandler", "description": "React.FocusEventHandler" }
},
"onChange": {
"type": {
"name": "React.ChangeEventHandler<HTMLInputElement&gt",
"description": "React.ChangeEventHandler<HTMLInputElement&gt"
"name": "React.ChangeEventHandler<HTMLInputElement>",
"description": "React.ChangeEventHandler<HTMLInputElement>"
}
},
"onClick": {
Expand Down Expand Up @@ -52,15 +52,15 @@
},
"getInputProps": {
"type": {
"name": "<TOther extends Record<string, any&gt = {}&gt(externalProps?: TOther) =&gt UseInputInputSlotProps<TOther&gt",
"description": "<TOther extends Record<string, any&gt = {}&gt(externalProps?: TOther) =&gt UseInputInputSlotProps<TOther&gt"
"name": "<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseInputInputSlotProps<TOther>",
"description": "<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseInputInputSlotProps<TOther>"
},
"required": true
},
"getRootProps": {
"type": {
"name": "<TOther extends Record<string, any&gt = {}&gt(externalProps?: TOther) =&gt UseInputRootSlotProps<TOther&gt",
"description": "<TOther extends Record<string, any&gt = {}&gt(externalProps?: TOther) =&gt UseInputRootSlotProps<TOther&gt"
"name": "<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseInputRootSlotProps<TOther>",
"description": "<TOther extends Record<string, any> = {}>(externalProps?: TOther) => UseInputRootSlotProps<TOther>"
},
"required": true
},
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/base/api/use-menu-item.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"parameters": {
"ref": {
"type": { "name": "React.Ref<any&gt", "description": "React.Ref<any&gt" },
"type": { "name": "React.Ref<any>", "description": "React.Ref<any>" },
"required": true
},
"disabled": { "type": { "name": "boolean", "description": "boolean" } },
"label": { "type": { "name": "string", "description": "string" } },
"onClick": {
"type": {
"name": "React.MouseEventHandler<any&gt",
"description": "React.MouseEventHandler<any&gt"
"name": "React.MouseEventHandler<any>",
"description": "React.MouseEventHandler<any>"
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/base/api/use-menu.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"parameters": {
"listboxId": { "type": { "name": "string", "description": "string" } },
"listboxRef": {
"type": { "name": "React.Ref<any&gt", "description": "React.Ref<any&gt" }
"type": { "name": "React.Ref<any>", "description": "React.Ref<any>" }
},
"onClose": { "type": { "name": "() =&gt void", "description": "() =&gt void" } },
"onClose": { "type": { "name": "() => void", "description": "() => void" } },
"open": { "type": { "name": "boolean", "description": "boolean" } }
},
"returnValue": {
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/base/api/use-option.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
"value": { "type": { "name": "Value", "description": "Value" }, "required": true },
"optionRef": {
"type": {
"name": "React.Ref<HTMLElement&gt",
"description": "React.Ref<HTMLElement&gt"
"name": "React.Ref<HTMLElement>",
"description": "React.Ref<HTMLElement>"
}
}
},
"returnValue": {
"getRootProps": {
"type": {
"name": "<Other extends EventHandlers&gt(otherHandlers?: Other) =&gt UseOptionRootSlotProps<Other&gt",
"description": "<Other extends EventHandlers&gt(otherHandlers?: Other) =&gt UseOptionRootSlotProps<Other&gt"
"name": "<Other extends EventHandlers>(otherHandlers?: Other) => UseOptionRootSlotProps<Other>",
"description": "<Other extends EventHandlers>(otherHandlers?: Other) => UseOptionRootSlotProps<Other>"
},
"required": true
},
Expand Down
14 changes: 7 additions & 7 deletions docs/pages/base/api/use-slider.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"parameters": {
"ref": {
"type": { "name": "React.Ref<any&gt", "description": "React.Ref<any&gt" },
"type": { "name": "React.Ref<any>", "description": "React.Ref<any>" },
"required": true
},
"aria-labelledby": { "type": { "name": "string", "description": "string" } },
Expand All @@ -15,14 +15,14 @@
"name": { "type": { "name": "string", "description": "string" } },
"onChange": {
"type": {
"name": "(event: Event, value: number | number[], activeThumb: number) =&gt void",
"description": "(event: Event, value: number | number[], activeThumb: number) =&gt void"
"name": "(event: Event, value: number | number[], activeThumb: number) => void",
"description": "(event: Event, value: number | number[], activeThumb: number) => void"
}
},
"onChangeCommitted": {
"type": {
"name": "(event: React.SyntheticEvent | Event, value: number | number[]) =&gt void",
"description": "(event: React.SyntheticEvent | Event, value: number | number[]) =&gt void"
"name": "(event: React.SyntheticEvent | Event, value: number | number[]) => void",
"description": "(event: React.SyntheticEvent | Event, value: number | number[]) => void"
}
},
"orientation": {
Expand All @@ -33,8 +33,8 @@
},
"scale": {
"type": {
"name": "(value: number) =&gt number",
"description": "(value: number) =&gt number"
"name": "(value: number) => number",
"description": "(value: number) => number"
}
},
"step": { "type": { "name": "number | null", "description": "number | null" } },
Expand Down
Loading

0 comments on commit 225d6e7

Please sign in to comment.