From 93cb3d65e7cf9814e380eeb8916b849df120bfaa Mon Sep 17 00:00:00 2001 From: Pluvio <39244972+pluvio72@users.noreply.github.com> Date: Fri, 9 Aug 2024 12:45:50 +0100 Subject: [PATCH] [docs][material-ui][Autocomplete] Improve the `options` prop description (#41591) Co-authored-by: ZeeshanTamboli --- docs/translations/api-docs/autocomplete/autocomplete.json | 2 +- packages/mui-material/src/Autocomplete/Autocomplete.js | 2 +- packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/translations/api-docs/autocomplete/autocomplete.json b/docs/translations/api-docs/autocomplete/autocomplete.json index 6ec4dc19a1df49..5a32c235a23f07 100644 --- a/docs/translations/api-docs/autocomplete/autocomplete.json +++ b/docs/translations/api-docs/autocomplete/autocomplete.json @@ -155,7 +155,7 @@ "openText": { "description": "Override the default text for the open popup icon button.
For localization purposes, you can use the provided translations." }, - "options": { "description": "Array of options." }, + "options": { "description": "A list of options that will be shown in the Autocomplete." }, "PaperComponent": { "description": "The component used to render the body of the popup." }, "PopperComponent": { "description": "The component used to position the popup." }, "popupIcon": { "description": "The icon to display in place of the default popup icon." }, diff --git a/packages/mui-material/src/Autocomplete/Autocomplete.js b/packages/mui-material/src/Autocomplete/Autocomplete.js index b640a95cba538e..9e47976db676eb 100644 --- a/packages/mui-material/src/Autocomplete/Autocomplete.js +++ b/packages/mui-material/src/Autocomplete/Autocomplete.js @@ -1113,7 +1113,7 @@ Autocomplete.propTypes /* remove-proptypes */ = { */ openText: PropTypes.string, /** - * Array of options. + * A list of options that will be shown in the Autocomplete. */ options: PropTypes.array.isRequired, /** diff --git a/packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts b/packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts index 266f174f52b5f6..411ee953534e64 100644 --- a/packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts +++ b/packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts @@ -281,7 +281,7 @@ export interface UseAutocompleteProps< */ openOnFocus?: boolean; /** - * Array of options. + * A list of options that will be shown in the Autocomplete. */ options: ReadonlyArray; /**