|
60 | 60 | "filterOptions": { |
61 | 61 | "description": "A function that determines the filtered options to be rendered on search.", |
62 | 62 | "typeDescriptions": { |
63 | | - "options": "The options to render.", |
64 | | - "state": "The state of the component." |
| 63 | + "options": { "name": "options", "description": "The options to render." }, |
| 64 | + "state": { "name": "state", "description": "The state of the component." } |
65 | 65 | } |
66 | 66 | }, |
67 | 67 | "filterSelectedOptions": { |
|
73 | 73 | }, |
74 | 74 | "getLimitTagsText": { |
75 | 75 | "description": "The label to display when the tags are truncated (<code>limitTags</code>).", |
76 | | - "typeDescriptions": { "more": "The number of truncated tags." } |
| 76 | + "typeDescriptions": { |
| 77 | + "more": { "name": "more", "description": "The number of truncated tags." } |
| 78 | + } |
77 | 79 | }, |
78 | 80 | "getOptionDisabled": { |
79 | 81 | "description": "Used to determine the disabled state for a given option.", |
80 | | - "typeDescriptions": { "option": "The option to test." } |
| 82 | + "typeDescriptions": { "option": { "name": "option", "description": "The option to test." } } |
81 | 83 | }, |
82 | 84 | "getOptionKey": { |
83 | 85 | "description": "Used to determine the key for a given option. This can be useful when the labels of options are not unique (since labels are used as keys by default).", |
84 | | - "typeDescriptions": { "option": "The option to get the key for." } |
| 86 | + "typeDescriptions": { |
| 87 | + "option": { "name": "option", "description": "The option to get the key for." } |
| 88 | + } |
85 | 89 | }, |
86 | 90 | "getOptionLabel": { |
87 | 91 | "description": "Used to determine the string value for a given option. It's used to fill the input (and the list box options if <code>renderOption</code> is not provided).<br>If used in free solo mode, it must accept both the type of the options and a string." |
88 | 92 | }, |
89 | 93 | "groupBy": { |
90 | 94 | "description": "If provided, the options will be grouped under the returned string. The groupBy value is also used as the text for group headings when <code>renderGroup</code> is not provided.", |
91 | | - "typeDescriptions": { "options": "The options to group." } |
| 95 | + "typeDescriptions": { |
| 96 | + "options": { "name": "options", "description": "The options to group." } |
| 97 | + } |
92 | 98 | }, |
93 | 99 | "handleHomeEndKeys": { |
94 | 100 | "description": "If <code>true</code>, the component handles the "Home" and "End" keys when the popup is open. It should move focus to the first option and last option, respectively." |
|
102 | 108 | "inputValue": { "description": "The input value." }, |
103 | 109 | "isOptionEqualToValue": { |
104 | 110 | "description": "Used to determine if the option represents the given value. Uses strict equality by default. ⚠️ Both arguments need to be handled, an option can only match with one value.", |
105 | | - "typeDescriptions": { "option": "The option to test.", "value": "The value to test against." } |
| 111 | + "typeDescriptions": { |
| 112 | + "option": { "name": "option", "description": "The option to test." }, |
| 113 | + "value": { "name": "value", "description": "The value to test against." } |
| 114 | + } |
106 | 115 | }, |
107 | 116 | "limitTags": { |
108 | 117 | "description": "The maximum number of tags that will be visible when not focused. Set <code>-1</code> to disable the limit." |
|
123 | 132 | "onChange": { |
124 | 133 | "description": "Callback fired when the value changes.", |
125 | 134 | "typeDescriptions": { |
126 | | - "event": "The event source of the callback.", |
127 | | - "value": "The new value of the component.", |
128 | | - "reason": "One of "createOption", "selectOption", "removeOption", "blur" or "clear"." |
| 135 | + "event": { "name": "event", "description": "The event source of the callback." }, |
| 136 | + "value": { "name": "value", "description": "The new value of the component." }, |
| 137 | + "reason": { |
| 138 | + "name": "reason", |
| 139 | + "description": "One of "createOption", "selectOption", "removeOption", "blur" or "clear"." |
| 140 | + } |
129 | 141 | } |
130 | 142 | }, |
131 | 143 | "onClose": { |
132 | 144 | "description": "Callback fired when the popup requests to be closed. Use in controlled mode (see open).", |
133 | 145 | "typeDescriptions": { |
134 | | - "event": "The event source of the callback.", |
135 | | - "reason": "Can be: <code>"toggleInput"</code>, <code>"escape"</code>, <code>"selectOption"</code>, <code>"removeOption"</code>, <code>"blur"</code>." |
| 146 | + "event": { "name": "event", "description": "The event source of the callback." }, |
| 147 | + "reason": { |
| 148 | + "name": "reason", |
| 149 | + "description": "Can be: <code>"toggleInput"</code>, <code>"escape"</code>, <code>"selectOption"</code>, <code>"removeOption"</code>, <code>"blur"</code>." |
| 150 | + } |
136 | 151 | } |
137 | 152 | }, |
138 | 153 | "onHighlightChange": { |
139 | 154 | "description": "Callback fired when the highlight option changes.", |
140 | 155 | "typeDescriptions": { |
141 | | - "event": "The event source of the callback.", |
142 | | - "option": "The highlighted option.", |
143 | | - "reason": "Can be: <code>"keyboard"</code>, <code>"auto"</code>, <code>"mouse"</code>, <code>"touch"</code>." |
| 156 | + "event": { "name": "event", "description": "The event source of the callback." }, |
| 157 | + "option": { "name": "option", "description": "The highlighted option." }, |
| 158 | + "reason": { |
| 159 | + "name": "reason", |
| 160 | + "description": "Can be: <code>"keyboard"</code>, <code>"auto"</code>, <code>"mouse"</code>, <code>"touch"</code>." |
| 161 | + } |
144 | 162 | } |
145 | 163 | }, |
146 | 164 | "onInputChange": { |
147 | 165 | "description": "Callback fired when the input value changes.", |
148 | 166 | "typeDescriptions": { |
149 | | - "event": "The event source of the callback.", |
150 | | - "value": "The new value of the text input.", |
151 | | - "reason": "Can be: <code>"input"</code> (user input), <code>"reset"</code> (programmatic change), <code>"clear"</code>, <code>"blur"</code>, <code>"selectOption"</code>, <code>"removeOption"</code>" |
| 167 | + "event": { "name": "event", "description": "The event source of the callback." }, |
| 168 | + "value": { "name": "value", "description": "The new value of the text input." }, |
| 169 | + "reason": { |
| 170 | + "name": "reason", |
| 171 | + "description": "Can be: <code>"input"</code> (user input), <code>"reset"</code> (programmatic change), <code>"clear"</code>, <code>"blur"</code>, <code>"selectOption"</code>, <code>"removeOption"</code>" |
| 172 | + } |
152 | 173 | } |
153 | 174 | }, |
154 | 175 | "onOpen": { |
155 | 176 | "description": "Callback fired when the popup requests to be opened. Use in controlled mode (see open).", |
156 | | - "typeDescriptions": { "event": "The event source of the callback." } |
| 177 | + "typeDescriptions": { |
| 178 | + "event": { "name": "event", "description": "The event source of the callback." } |
| 179 | + } |
157 | 180 | }, |
158 | 181 | "open": { "description": "If <code>true</code>, the component is shown." }, |
159 | 182 | "openOnFocus": { "description": "If <code>true</code>, the popup will open on input focus." }, |
|
168 | 191 | }, |
169 | 192 | "renderGroup": { |
170 | 193 | "description": "Render the group.", |
171 | | - "typeDescriptions": { "params": "The group to render." } |
| 194 | + "typeDescriptions": { "params": { "name": "params", "description": "The group to render." } } |
172 | 195 | }, |
173 | 196 | "renderOption": { |
174 | 197 | "description": "Render the option, use <code>getOptionLabel</code> by default.", |
175 | 198 | "typeDescriptions": { |
176 | | - "props": "The props to apply on the li element.", |
177 | | - "option": "The option to render.", |
178 | | - "state": "The state of the component." |
| 199 | + "props": { "name": "props", "description": "The props to apply on the li element." }, |
| 200 | + "option": { "name": "option", "description": "The option to render." }, |
| 201 | + "state": { "name": "state", "description": "The state of the component." } |
179 | 202 | } |
180 | 203 | }, |
181 | 204 | "renderTags": { |
182 | 205 | "description": "Render the selected value.", |
183 | 206 | "typeDescriptions": { |
184 | | - "value": "The <code>value</code> provided to the component.", |
185 | | - "getTagProps": "A tag props getter.", |
186 | | - "ownerState": "The state of the Autocomplete component." |
| 207 | + "value": { |
| 208 | + "name": "value", |
| 209 | + "description": "The <code>value</code> provided to the component." |
| 210 | + }, |
| 211 | + "getTagProps": { "name": "getTagProps", "description": "A tag props getter." }, |
| 212 | + "ownerState": { |
| 213 | + "name": "ownerState", |
| 214 | + "description": "The state of the Autocomplete component." |
| 215 | + } |
187 | 216 | } |
188 | 217 | }, |
189 | 218 | "required": { |
|
0 commit comments