Skip to content

chore: avoid showing placeholder warning every render #8682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

chore: avoid showing placeholder warning every render #8682

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions packages/@react-spectrum/autocomplete/src/SearchAutocomplete.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,13 @@ function SearchAutocomplete<T extends object>(props: SpectrumSearchAutocompleteP
props = useProviderProps(props);
props = useFormProps(props);

if (props.placeholder && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead.');
}
let hasWarned = useRef(false);
useEffect(() => {
if (props.placeholder && !hasWarned.current && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead.');
hasWarned.current = true;
}
}, [props.placeholder]);

let isMobile = useIsMobileDevice();
if (isMobile) {
Expand Down
13 changes: 9 additions & 4 deletions packages/@react-spectrum/color/src/ColorField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import {classNames} from '@react-spectrum/utils';
import {ColorChannel, SpectrumColorFieldProps} from '@react-types/color';
import {ColorFieldContext, useContextProps} from 'react-aria-components';
import React, {Ref, useRef} from 'react';
import React, {Ref, useEffect, useRef} from 'react';
import styles from './colorfield.css';
import {TextFieldBase} from '@react-spectrum/textfield';
import {TextFieldRef} from '@react-types/textfield';
Expand All @@ -30,9 +30,14 @@ export const ColorField = React.forwardRef(function ColorField(props: SpectrumCo
props = useProviderProps(props);
props = useFormProps(props);
[props] = useContextProps(props, null, ColorFieldContext);
if (props.placeholder && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/ColorField.html#help-text');
}

let hasWarned = useRef(false);
useEffect(() => {
if (props.placeholder && !hasWarned.current && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/ColorField.html#help-text');
hasWarned.current = true;
}
}, [props.placeholder]);

if (props.channel) {
return <ColorChannelField {...props} channel={props.channel} forwardedRef={ref} />;
Expand Down
10 changes: 7 additions & 3 deletions packages/@react-spectrum/combobox/src/ComboBox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,13 @@ export const ComboBox = React.forwardRef(function ComboBox<T extends object>(pro
props = useProviderProps(props);
props = useFormProps(props);

if (props.placeholder && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/ComboBox.html#help-text');
}
let hasWarned = useRef(false);
useEffect(() => {
if (props.placeholder && !hasWarned.current && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/ComboBox.html#help-text');
hasWarned.current = true;
}
}, [props.placeholder]);

let isMobile = useIsMobileDevice();
if (isMobile) {
Expand Down
12 changes: 8 additions & 4 deletions packages/@react-spectrum/searchfield/src/SearchField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import {classNames, useSlotProps} from '@react-spectrum/utils';
import {ClearButton} from '@react-spectrum/button';
import Magnifier from '@spectrum-icons/ui/Magnifier';
import React, {forwardRef, ReactElement, Ref, useRef} from 'react';
import React, {forwardRef, ReactElement, Ref, useEffect, useRef} from 'react';
import {SpectrumSearchFieldProps} from '@react-types/searchfield';
import styles from '@adobe/spectrum-css-temp/components/search/vars.css';
import {TextFieldBase} from '@react-spectrum/textfield';
Expand Down Expand Up @@ -42,9 +42,13 @@ export const SearchField = forwardRef(function SearchField(props: SpectrumSearch
...otherProps
} = props;

if (placeholder && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/SearchField.html#help-text');
}
let hasWarned = useRef(false);
Copy link
Member

@snowystinger snowystinger Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make into a usePlaceholderWarning({placeholder, message}) hook?

Copy link
Member Author

@reidbarber reidbarber Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking a larger dev-only runtime hook might be useful? Maybe we can think more about this.

Copy link
Member

@snowystinger snowystinger Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, i was just thinking to reduce code size as a result of duplication

useEffect(() => {
if (placeholder && !hasWarned.current && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/SearchField.html#help-text');
hasWarned.current = true;
}
}, [placeholder]);

let state = useSearchFieldState(props);
let inputRef = useRef<HTMLInputElement>(null);
Expand Down
12 changes: 8 additions & 4 deletions packages/@react-spectrum/textfield/src/TextArea.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*/

import {chain, useLayoutEffect} from '@react-aria/utils';
import React, {Ref, useCallback, useRef} from 'react';
import React, {Ref, useCallback, useEffect, useRef} from 'react';
import {SpectrumTextAreaProps, SpectrumTextFieldBaseProps, TextFieldRef} from '@react-types/textfield';
import {TextFieldBase} from './TextFieldBase';
import {useControlledState} from '@react-stately/utils';
Expand Down Expand Up @@ -69,9 +69,13 @@ export const TextArea = React.forwardRef(function TextArea(props: SpectrumTextAr
}
}, [onHeightChange, inputValue, inputRef]);

if (props.placeholder && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/TextArea.html#help-text');
}
let hasWarned = useRef(false);
useEffect(() => {
if (props.placeholder && !hasWarned.current && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/TextArea.html#help-text');
hasWarned.current = true;
}
}, [props.placeholder]);

let result = useTextField({
...props,
Expand Down
12 changes: 8 additions & 4 deletions packages/@react-spectrum/textfield/src/TextField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* governing permissions and limitations under the License.
*/

import React, {forwardRef, Ref, useRef} from 'react';
import React, {forwardRef, Ref, useEffect, useRef} from 'react';
import {SpectrumTextFieldProps, TextFieldRef} from '@react-types/textfield';
import {TextFieldBase} from './TextFieldBase';
import {useFormProps} from '@react-spectrum/form';
Expand All @@ -29,9 +29,13 @@ export const TextField = forwardRef(function TextField(props: SpectrumTextFieldP
let inputRef = useRef<HTMLInputElement>(null);
let result = useTextField(props, inputRef);

if (props.placeholder && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/TextField.html#help-text');
}
let hasWarned = useRef(false);
useEffect(() => {
if (props.placeholder && !hasWarned.current && process.env.NODE_ENV !== 'production') {
console.warn('Placeholders are deprecated due to accessibility issues. Please use help text instead. See the docs for details: https://react-spectrum.adobe.com/react-spectrum/TextField.html#help-text');
hasWarned.current = true;
}
}, [props.placeholder]);

return (
<TextFieldBase
Expand Down