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

[pickers] Allow custom fields to validate the value #14486

Merged
merged 17 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
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
51 changes: 51 additions & 0 deletions docs/data/date-pickers/experimentation/CustomField.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import * as React from 'react';
import dayjs from 'dayjs';
import TextField from '@mui/material/TextField';
import { DemoContainer } from '@mui/x-date-pickers/internals/demo';
import { AdapterDayjs } from '@mui/x-date-pickers/AdapterDayjs';
import { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';
import { DatePicker } from '@mui/x-date-pickers/DatePicker';
import { useValidation, validateDate } from '@mui/x-date-pickers/validation';

import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';

function ReadOnlyField(props) {
const { internalProps, forwardedProps } = useSplitFieldInternalAndForwardedProps(
props,
'date',
);

const { value, timezone, format } = internalProps;
const { InputProps, slotProps, slots, ...other } = forwardedProps;

const { hasValidationError } = useValidation({
validator: validateDate,
value,
timezone,
props: internalProps,
});

return (
<TextField
{...other}
value={value == null ? '' : value.format(format)}
InputProps={{ ...InputProps, readOnly: true }}
error={hasValidationError}
/>
);
}

export default function CustomField() {
return (
<LocalizationProvider dateAdapter={AdapterDayjs}>
<DemoContainer components={['DatePicker']}>
<DatePicker
label="Date Picker"
slots={{ field: ReadOnlyField }}
maxDate={dayjs('2022-04-17')}
defaultValue={dayjs('2022-04-18')}
/>
</DemoContainer>
</LocalizationProvider>
);
}
51 changes: 51 additions & 0 deletions docs/data/date-pickers/experimentation/CustomField.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import * as React from 'react';
import dayjs, { Dayjs } from 'dayjs';
import TextField from '@mui/material/TextField';
import { DemoContainer } from '@mui/x-date-pickers/internals/demo';
import { AdapterDayjs } from '@mui/x-date-pickers/AdapterDayjs';
import { LocalizationProvider } from '@mui/x-date-pickers/LocalizationProvider';
import { DatePicker } from '@mui/x-date-pickers/DatePicker';
import { useValidation, validateDate } from '@mui/x-date-pickers/validation';
import { DateFieldInPickerProps } from '@mui/x-date-pickers/DateField';
import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';

function ReadOnlyField(props: DateFieldInPickerProps<Dayjs, false>) {
const { internalProps, forwardedProps } = useSplitFieldInternalAndForwardedProps(
props,
'date',
);

const { value, timezone, format } = internalProps;
const { InputProps, slotProps, slots, ...other } = forwardedProps;

const { hasValidationError } = useValidation({
validator: validateDate,
value,
timezone,
props: internalProps,
});

return (
<TextField
{...other}
value={value == null ? '' : value.format(format)}
InputProps={{ ...InputProps, readOnly: true }}
error={hasValidationError}
/>
);
}

export default function CustomField() {
return (
<LocalizationProvider dateAdapter={AdapterDayjs}>
<DemoContainer components={['DatePicker']}>
<DatePicker
label="Date Picker"
slots={{ field: ReadOnlyField }}
maxDate={dayjs('2022-04-17')}
defaultValue={dayjs('2022-04-18')}
/>
</DemoContainer>
</LocalizationProvider>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<DatePicker
label="Date Picker"
slots={{ field: ReadOnlyField }}
maxDate={dayjs('2022-04-17')}
defaultValue={dayjs('2022-04-18')}
/>
11 changes: 11 additions & 0 deletions docs/data/date-pickers/experimentation/experimentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
productId: x-date-pickers
---

# Date and Time Pickers experimentation

<p class="description">Demos not accessible through the navbar of the doc</p>

## Custom field

{{"demo": "CustomField.js"}}
7 changes: 7 additions & 0 deletions docs/pages/x/react-date-pickers/experimentation.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import * as React from 'react';
import MarkdownDocs from 'docs/src/modules/components/MarkdownDocs';
import * as pageProps from 'docsx/data/date-pickers/experimentation/experimentation.md?muiMarkdown';

export default function Page() {
return <MarkdownDocs {...pageProps} />;
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import PropTypes from 'prop-types';
import { extractValidationProps, PickerViewRendererLookup } from '@mui/x-date-pickers/internals';
import { PickerViewRendererLookup } from '@mui/x-date-pickers/internals';
import { extractValidationProps } from '@mui/x-date-pickers/validation';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import resolveComponentProps from '@mui/utils/resolveComponentProps';
import { refType } from '@mui/utils';
Expand All @@ -10,7 +11,7 @@ import { useDateRangePickerDefaultizedProps } from '../DateRangePicker/shared';
import { renderDateRangeViewCalendar } from '../dateRangeViewRenderers';
import { MultiInputDateRangeField } from '../MultiInputDateRangeField';
import { useDesktopRangePicker } from '../internals/hooks/useDesktopRangePicker';
import { validateDateRange } from '../internals/utils/validation/validateDateRange';
import { validateDateRange } from '../validation';
import { DateRange } from '../models';

type DesktopDateRangePickerComponent = (<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ import * as React from 'react';
import PropTypes from 'prop-types';
import {
DefaultizedProps,
extractValidationProps,
isDatePickerView,
isInternalTimeView,
PickerViewRenderer,
PickerViewsRendererProps,
resolveDateTimeFormat,
useUtils,
} from '@mui/x-date-pickers/internals';
import { extractValidationProps } from '@mui/x-date-pickers/validation';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import resolveComponentProps from '@mui/utils/resolveComponentProps';
import { refType } from '@mui/utils';
Expand All @@ -32,7 +32,7 @@ import {
useDesktopRangePicker,
UseDesktopRangePickerProps,
} from '../internals/hooks/useDesktopRangePicker';
import { validateDateTimeRange } from '../internals/utils/validation/validateDateTimeRange';
import { validateDateTimeRange } from '../validation';
import { DateTimeRangePickerView } from '../internals/models';
import { DateRange } from '../models';
import {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import PropTypes from 'prop-types';
import { extractValidationProps, PickerViewRendererLookup } from '@mui/x-date-pickers/internals';
import { PickerViewRendererLookup } from '@mui/x-date-pickers/internals';
import { extractValidationProps } from '@mui/x-date-pickers/validation';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import resolveComponentProps from '@mui/utils/resolveComponentProps';
import { refType } from '@mui/utils';
Expand All @@ -10,7 +11,7 @@ import { useDateRangePickerDefaultizedProps } from '../DateRangePicker/shared';
import { renderDateRangeViewCalendar } from '../dateRangeViewRenderers';
import { MultiInputDateRangeField } from '../MultiInputDateRangeField';
import { useMobileRangePicker } from '../internals/hooks/useMobileRangePicker';
import { validateDateRange } from '../internals/utils/validation/validateDateRange';
import { validateDateRange } from '../validation';
import { DateRange } from '../models';

type MobileDateRangePickerComponent = (<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { refType } from '@mui/utils';
import {
DIALOG_WIDTH,
VIEW_HEIGHT,
extractValidationProps,
isInternalTimeView,
isDatePickerView,
PickerViewRenderer,
Expand All @@ -14,6 +13,7 @@ import {
resolveDateTimeFormat,
useUtils,
} from '@mui/x-date-pickers/internals';
import { extractValidationProps } from '@mui/x-date-pickers/validation';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import resolveComponentProps from '@mui/utils/resolveComponentProps';
import {
Expand All @@ -32,7 +32,7 @@ import {
UseMobileRangePickerProps,
useMobileRangePicker,
} from '../internals/hooks/useMobileRangePicker';
import { validateDateTimeRange } from '../internals/utils/validation/validateDateTimeRange';
import { validateDateTimeRange } from '../validation';
import { DateTimeRangePickerView } from '../internals/models';
import { DateRange } from '../models';
import {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,16 @@ import {
unstable_generateUtilityClass as generateUtilityClass,
unstable_generateUtilityClasses as generateUtilityClasses,
} from '@mui/utils';
import {
splitFieldInternalAndForwardedProps,
convertFieldResponseIntoMuiTextFieldProps,
} from '@mui/x-date-pickers/internals';
import { convertFieldResponseIntoMuiTextFieldProps } from '@mui/x-date-pickers/internals';
import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import { PickersTextField } from '@mui/x-date-pickers/PickersTextField';
import {
MultiInputDateRangeFieldProps,
MultiInputDateRangeFieldSlotProps,
} from './MultiInputDateRangeField.types';
import { useMultiInputDateRangeField } from '../internals/hooks/useMultiInputRangeField/useMultiInputDateRangeField';
import { MultiInputRangeFieldClasses, RangePosition, UseDateRangeFieldProps } from '../models';
import { MultiInputRangeFieldClasses, RangePosition } from '../models';

export const multiInputDateRangeFieldClasses: MultiInputRangeFieldClasses = generateUtilityClasses(
'MuiMultiInputDateRangeField',
Expand Down Expand Up @@ -91,10 +89,10 @@ const MultiInputDateRangeField = React.forwardRef(function MultiInputDateRangeFi
name: 'MuiMultiInputDateRangeField',
});

const { internalProps, forwardedProps } = splitFieldInternalAndForwardedProps<
typeof themeProps,
keyof Omit<UseDateRangeFieldProps<any, any>, 'clearable' | 'onClear'>
>(themeProps, 'date');
const { internalProps, forwardedProps } = useSplitFieldInternalAndForwardedProps(
themeProps,
'date',
);

const {
slots,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,15 @@ import {
unstable_generateUtilityClass as generateUtilityClass,
unstable_generateUtilityClasses as generateUtilityClasses,
} from '@mui/utils';
import {
splitFieldInternalAndForwardedProps,
convertFieldResponseIntoMuiTextFieldProps,
} from '@mui/x-date-pickers/internals';
import { convertFieldResponseIntoMuiTextFieldProps } from '@mui/x-date-pickers/internals';
import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import { PickersTextField } from '@mui/x-date-pickers/PickersTextField';
import {
MultiInputDateTimeRangeFieldProps,
MultiInputDateTimeRangeFieldSlotProps,
} from './MultiInputDateTimeRangeField.types';
import { useMultiInputDateTimeRangeField } from '../internals/hooks/useMultiInputRangeField/useMultiInputDateTimeRangeField';
import { UseDateTimeRangeFieldProps } from '../internals/models/dateTimeRange';
import { MultiInputRangeFieldClasses, RangePosition } from '../models';

export const multiInputDateTimeRangeFieldClasses: MultiInputRangeFieldClasses =
Expand Down Expand Up @@ -90,10 +87,10 @@ const MultiInputDateTimeRangeField = React.forwardRef(function MultiInputDateTim
name: 'MuiMultiInputDateTimeRangeField',
});

const { internalProps, forwardedProps } = splitFieldInternalAndForwardedProps<
typeof themeProps,
keyof Omit<UseDateTimeRangeFieldProps<any, any>, 'clearable' | 'onClear'>
>(themeProps, 'date-time');
const { internalProps, forwardedProps } = useSplitFieldInternalAndForwardedProps(
themeProps,
'date-time',
);

const {
slots,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,15 @@ import {
unstable_generateUtilityClass as generateUtilityClass,
unstable_generateUtilityClasses as generateUtilityClasses,
} from '@mui/utils';
import {
splitFieldInternalAndForwardedProps,
convertFieldResponseIntoMuiTextFieldProps,
} from '@mui/x-date-pickers/internals';
import { convertFieldResponseIntoMuiTextFieldProps } from '@mui/x-date-pickers/internals';
import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import { PickersTextField } from '@mui/x-date-pickers/PickersTextField';
import {
MultiInputTimeRangeFieldProps,
MultiInputTimeRangeFieldSlotProps,
} from './MultiInputTimeRangeField.types';
import { useMultiInputTimeRangeField } from '../internals/hooks/useMultiInputRangeField/useMultiInputTimeRangeField';
import { UseTimeRangeFieldProps } from '../internals/models/timeRange';
import { MultiInputRangeFieldClasses, RangePosition } from '../models';

export const multiInputTimeRangeFieldClasses: MultiInputRangeFieldClasses = generateUtilityClasses(
Expand Down Expand Up @@ -92,10 +89,10 @@ const MultiInputTimeRangeField = React.forwardRef(function MultiInputTimeRangeFi
name: 'MuiMultiInputTimeRangeField',
});

const { internalProps, forwardedProps } = splitFieldInternalAndForwardedProps<
typeof themeProps,
keyof Omit<UseTimeRangeFieldProps<any, any>, 'clearable' | 'onClear'>
>(themeProps, 'time');
const { internalProps, forwardedProps } = useSplitFieldInternalAndForwardedProps(
themeProps,
'time',
);

const {
slots,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import * as React from 'react';
import {
useField,
splitFieldInternalAndForwardedProps,
useDefaultizedDateField,
} from '@mui/x-date-pickers/internals';
import { useField, useDefaultizedDateField } from '@mui/x-date-pickers/internals';
import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import { UseSingleInputDateRangeFieldProps } from './SingleInputDateRangeField.types';
import { rangeValueManager, getRangeFieldValueManager } from '../internals/utils/valueManagers';
import { validateDateRange } from '../internals/utils/validation/validateDateRange';
import { validateDateRange } from '../validation';
import { RangeFieldSection, DateRange } from '../models';

export const useSingleInputDateRangeField = <
Expand All @@ -23,10 +20,7 @@ export const useSingleInputDateRangeField = <
TAllProps
>(inProps);

const { forwardedProps, internalProps } = splitFieldInternalAndForwardedProps<
typeof props,
keyof UseSingleInputDateRangeFieldProps<TDate, TEnableAccessibleFieldDOMStructure>
>(props, 'date');
const { forwardedProps, internalProps } = useSplitFieldInternalAndForwardedProps(props, 'date');

const fieldValueManager = React.useMemo(
() => getRangeFieldValueManager<TDate>({ dateSeparator: internalProps.dateSeparator }),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import * as React from 'react';
import {
useField,
splitFieldInternalAndForwardedProps,
useDefaultizedDateTimeField,
} from '@mui/x-date-pickers/internals';
import { useField, useDefaultizedDateTimeField } from '@mui/x-date-pickers/internals';
import { useSplitFieldInternalAndForwardedProps } from '@mui/x-date-pickers/hooks';
import { PickerValidDate } from '@mui/x-date-pickers/models';
import { UseSingleInputDateTimeRangeFieldProps } from './SingleInputDateTimeRangeField.types';
import { rangeValueManager, getRangeFieldValueManager } from '../internals/utils/valueManagers';
import { validateDateTimeRange } from '../internals/utils/validation/validateDateTimeRange';
import { validateDateTimeRange } from '../validation';
import { RangeFieldSection, DateRange } from '../models';

export const useSingleInputDateTimeRangeField = <
Expand All @@ -26,10 +23,10 @@ export const useSingleInputDateTimeRangeField = <
TAllProps
>(inProps);

const { forwardedProps, internalProps } = splitFieldInternalAndForwardedProps<
typeof props,
keyof UseSingleInputDateTimeRangeFieldProps<any, any>
>(props, 'date-time');
const { forwardedProps, internalProps } = useSplitFieldInternalAndForwardedProps(
props,
'date-time',
);

const fieldValueManager = React.useMemo(
() => getRangeFieldValueManager<TDate>({ dateSeparator: internalProps.dateSeparator }),
Expand Down
Loading