Skip to content
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.

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

Fix(input): Set DateInput and DateTimeInput to uncontrolled input #9543

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
100 changes: 89 additions & 11 deletions packages/ra-ui-materialui/src/input/DateInput.tsx
Expand Up @@ -35,42 +35,120 @@ export const DateInput = ({
defaultValue,
format = getStringFromDate,
label,
name,
source,
resource,
helperText,
margin,
onBlur,
onChange,
onFocus,
parse,
validate,
variant,
...rest
}: DateInputProps) => {
const { field, fieldState, formState, id, isRequired } = useInput({
const {
field,
fieldState: { error, invalid, isTouched },
formState: { isSubmitted },
id,
isRequired,
} = useInput({
defaultValue,
name,
format,
parse,
onBlur,
onChange,
resource,
source,
validate,
...rest,
});
const [renderCount, setRenderCount] = React.useState(1);

const initialDefaultValueRef = React.useRef(field.value);

React.useEffect(() => {
const initialDateValue =
new Date(initialDefaultValueRef.current).getTime() || null;

const fieldDateValue = new Date(field.value).getTime() || null;

if (initialDateValue !== fieldDateValue) {
setRenderCount(r => r + 1);
parse
? field.onChange(parse(field.value))
: field.onChange(field.value);
initialDefaultValueRef.current = field.value;
}
}, [setRenderCount, parse, field]);

const { onBlur: onBlurFromField } = field;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why have a different logic for onBlur and onFocus?

const hasFocus = React.useRef(false);

// update the input text when the user types in the input
const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
if (onChange) {
onChange(event);
}
if (
typeof event.target === 'undefined' ||
typeof event.target.value === 'undefined'
) {
return;
}
const target = event.target;

const newValue =
target.valueAsDate !== undefined &&
target.valueAsDate !== null &&
!isNaN(new Date(target.valueAsDate).getTime())
? parse
? parse(target.valueAsDate)
: getStringFromDate(target.valueAsDate)
: parse
? parse(target.value)
: getStringFromDate(target.value);

// if value empty, set it to null
if (newValue === '') {
field.onChange(null);
return;
}

field.onChange(newValue);
};

const handleFocus = (event: React.FocusEvent<HTMLInputElement>) => {
if (onFocus) {
onFocus(event);
}
hasFocus.current = true;
};

const handleBlur = () => {
if (onBlurFromField) {
onBlurFromField();
}
hasFocus.current = false;
};

const { error, invalid, isTouched } = fieldState;
const { isSubmitted } = formState;
const renderHelperText =
helperText !== false || ((isTouched || isSubmitted) && invalid);

const { ref, name } = field;

console.log('field', field);
Copy link
Contributor

Choose a reason for hiding this comment

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

console.log spotted


return (
<TextField
id={id}
{...field}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why remove {...field} ?

className={clsx('ra-input', `ra-input-${source}`, className)}
name={name}
inputRef={ref}
defaultValue={format(initialDefaultValueRef.current)}
key={renderCount}
type="date"
onChange={handleChange}
onFocus={handleFocus}
onBlur={handleBlur}
className={clsx('ra-input', `ra-input-${source}`, className)}
size="small"
variant={variant}
margin={margin}
Expand Down Expand Up @@ -133,7 +211,7 @@ const getStringFromDate = (value: string | Date) => {
// null, undefined and empty string values should not go through dateFormatter
// otherwise, it returns undefined and will make the input an uncontrolled one.
if (value == null || value === '') {
return '';
return null;
}

if (value instanceof Date) {
Expand Down
89 changes: 81 additions & 8 deletions packages/ra-ui-materialui/src/input/DateTimeInput.tsx
Expand Up @@ -30,35 +30,108 @@ export const DateTimeInput = ({
margin,
onBlur,
onChange,
onFocus,
source,
resource,
parse = parseDateTime,
validate,
variant,
...rest
}: DateTimeInputProps) => {
const { field, fieldState, formState, id, isRequired } = useInput({
const {
field,
fieldState: { error, invalid, isTouched },
formState: { isSubmitted },
id,
isRequired,
} = useInput({
defaultValue,
format,
parse,
onBlur,
onChange,
resource,
source,
validate,
...rest,
});
const [renderCount, setRenderCount] = React.useState(1);

const initialDefaultValueRef = React.useRef(field.value);

React.useEffect(() => {
const initialDateValue =
new Date(initialDefaultValueRef.current).getTime() || null;

const fieldDateValue = new Date(field.value).getTime() || null;

if (initialDateValue !== fieldDateValue) {
setRenderCount(r => r + 1);
parse
? field.onChange(parse(field.value))
: field.onChange(field.value);
initialDefaultValueRef.current = field.value;
}
}, [setRenderCount, parse, field]);

const { onBlur: onBlurFromField } = field;
const hasFocus = React.useRef(false);

// update the input text when the user types in the input
const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
if (onChange) {
onChange(event);
}
if (
typeof event.target === 'undefined' ||
typeof event.target.value === 'undefined'
) {
return;
}
const target = event.target;

const newValue =
target.valueAsDate !== undefined &&
target.valueAsDate !== null &&
!isNaN(new Date(target.valueAsDate).getTime())
? parse
? parse(target.valueAsDate)
: target.valueAsDate
: parse
? parse(target.value)
: formatDateTime(target.value);

field.onChange(newValue);
};

const handleFocus = (event: React.FocusEvent<HTMLInputElement>) => {
if (onFocus) {
onFocus(event);
}
hasFocus.current = true;
};

const handleBlur = () => {
if (onBlurFromField) {
onBlurFromField();
}
hasFocus.current = false;
};

const { error, invalid, isTouched } = fieldState;
const { isSubmitted } = formState;
const renderHelperText =
helperText !== false || ((isTouched || isSubmitted) && invalid);

const { ref, name } = field;

return (
<TextField
id={id}
{...field}
className={clsx('ra-input', `ra-input-${source}`, className)}
inputRef={ref}
name={name}
defaultValue={format(initialDefaultValueRef.current)}
key={renderCount}
type="datetime-local"
onChange={handleChange}
onFocus={handleFocus}
onBlur={handleBlur}
className={clsx('ra-input', `ra-input-${source}`, className)}
size="small"
variant={variant}
margin={margin}
Expand Down