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] Add more conformance tests improving API docs precision #13800

Merged
merged 14 commits into from
Jul 12, 2024
2 changes: 1 addition & 1 deletion docs/pages/x/api/date-pickers/date-field.json
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@
}
],
"spread": true,
"themeDefaultProps": false,
"themeDefaultProps": true,
"muiName": "MuiDateField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DateField/DateField.tsx",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -358,9 +358,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiDatePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DatePicker/DatePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-picker/\">Date Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/date-pickers/date-range-picker-day.json
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
"isGlobal": false
}
],
"spread": false,
"spread": true,
"themeDefaultProps": false,
"muiName": "MuiDateRangePickerDay",
"forwardsRefTo": "HTMLButtonElement",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/date-pickers/date-time-field.json
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
}
],
"spread": true,
"themeDefaultProps": false,
"themeDefaultProps": true,
"muiName": "MuiDateTimeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DateTimeField/DateTimeField.tsx",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -404,9 +404,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiDateTimePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DateTimePicker/DateTimePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-time-picker/\">Date Time Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/desktop-date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -336,9 +336,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiDesktopDatePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DesktopDatePicker/DesktopDatePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-picker/\">Date Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/desktop-date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -382,9 +382,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiDesktopDateTimePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DesktopDateTimePicker/DesktopDateTimePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-time-picker/\">Date Time Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/x/api/date-pickers/digital-clock.json
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": false,
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiDigitalClock",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/DigitalClock/DigitalClock.tsx",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/mobile-date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiMobileDatePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/MobileDatePicker/MobileDatePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-picker/\">Date Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/mobile-date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -326,9 +326,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiMobileDateTimePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/MobileDateTimePicker/MobileDateTimePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-time-picker/\">Date Time Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,10 @@
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiMultiInputDateRangeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/MultiInputDateRangeField/MultiInputDateRangeField.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-range-field/\">Date Range Field <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a></a></li>\n<li><a href=\"/x/react-date-pickers/fields/\">Fields component</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,10 @@
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiMultiInputDateTimeRangeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/MultiInputDateTimeRangeField/MultiInputDateTimeRangeField.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-time-range-field/\">Date Time Range Field <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a></a></li>\n<li><a href=\"/x/react-date-pickers/fields/\">Fields component</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,10 @@
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiMultiInputTimeRangeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/MultiInputTimeRangeField/MultiInputTimeRangeField.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/fields/\">Fields component</a></li>\n<li><a href=\"/x/react-date-pickers/time-range-field/\">Time Range Field <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a></a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@
"isGlobal": false
}
],
"spread": false,
"themeDefaultProps": false,
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiMultiSectionDigitalClock",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/MultiSectionDigitalClock/MultiSectionDigitalClock.tsx",
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/x/api/date-pickers/pickers-calendar-header.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,10 @@
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "MuiPickersCalendarHeader",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/PickersCalendarHeader/PickersCalendarHeader.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/custom-components/\">Custom slots and subcomponents</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": false,
"muiName": "MuiPickersRangeCalendarHeader",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/PickersRangeCalendarHeader/PickersRangeCalendarHeader.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/custom-components/\">Custom slots and subcomponents</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@
}
],
"spread": true,
"themeDefaultProps": false,
"themeDefaultProps": true,
"muiName": "MuiSingleInputDateRangeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/SingleInputDateRangeField/SingleInputDateRangeField.tsx",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
}
],
"spread": true,
"themeDefaultProps": false,
"themeDefaultProps": true,
"muiName": "MuiSingleInputDateTimeRangeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/SingleInputDateTimeRangeField/SingleInputDateTimeRangeField.tsx",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
}
],
"spread": true,
"themeDefaultProps": false,
"themeDefaultProps": true,
"muiName": "MuiSingleInputTimeRangeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/SingleInputTimeRangeField/SingleInputTimeRangeField.tsx",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/static-date-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiStaticDatePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/StaticDatePicker/StaticDatePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-picker/\">Date Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiStaticDateRangePicker",
"forwardsRefTo": "undefined",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers-pro/src/StaticDateRangePicker/StaticDateRangePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-range-picker/\">Date Range Picker <a href=\"/x/introduction/licensing/#pro-plan\" title=\"Pro plan\"><span class=\"plan-pro\"></span></a></a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/x/api/date-pickers/static-date-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,10 @@
}
],
"classes": [],
"spread": true,
"themeDefaultProps": null,
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiStaticDateTimePicker",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/StaticDateTimePicker/StaticDateTimePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/date-time-picker/\">Date Time Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/x/api/date-pickers/static-time-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@
"spread": false,
"themeDefaultProps": false,
"muiName": "MuiStaticTimePicker",
"forwardsRefTo": "undefined",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/StaticTimePicker/StaticTimePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/time-picker/\">Time Picker</a></li>\n<li><a href=\"/x/react-date-pickers/validation/\">Date and Time Pickers - Validation</a></li></ul>",
Expand Down
3 changes: 2 additions & 1 deletion docs/pages/x/api/date-pickers/time-field.json
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,9 @@
}
],
"spread": true,
"themeDefaultProps": null,
"themeDefaultProps": true,
"muiName": "MuiTimeField",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/x-date-pickers/src/TimeField/TimeField.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/x/react-date-pickers/fields/\">Fields component</a></li>\n<li><a href=\"/x/react-date-pickers/time-field/\">Time Field</a></li></ul>",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ describe('<DateRangePicker /> - Describes', () => {
'themeVariants',
'mergeClassName',
'propsSpread',
'rootClass',
],
}));
});
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ describe('<DateRangePickerDay />', () => {
'rootClass', // forwards classes to DateRangePickerDayDay, but applies root class on DateRangePickerDayRoot
'mergeClassName', // forwards other props (i.e. data-test-id) to the DateRangePickerDayDay, but `className` is applied on the root
'componentsProp',
'propsSpread',
'refForwarding',
// TODO: Fix DateRangePickerDays is not spreading props on root
'themeDefaultProps',
'themeVariants',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ describe('<DateTimeRangePicker /> - Describes', () => {
'themeVariants',
'mergeClassName',
'propsSpread',
'rootClass',
],
}));
});
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ describe('<DesktopDateRangePicker /> - Describes', () => {
'themeVariants',
'mergeClassName',
'propsSpread',
'rootClass',
],
}));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ describe('<DesktopDateTimeRangePicker /> - Describes', () => {
'themeVariants',
'mergeClassName',
'propsSpread',
'rootClass',
],
}));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ describe('<MobileDateRangePicker /> - Describes', () => {
'themeVariants',
'mergeClassName',
'propsSpread',
'rootClass',
],
}));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ describe('<MobileDateTimeRangePicker /> - Describes', () => {
'themeVariants',
'mergeClassName',
'propsSpread',
'rootClass',
],
}));

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import * as React from 'react';
import { pickersCalendarHeaderClasses } from '@mui/x-date-pickers/PickersCalendarHeader';
import { pickersArrowSwitcherClasses } from '@mui/x-date-pickers/internals';
import { PickersRangeCalendarHeader } from '@mui/x-date-pickers-pro/PickersRangeCalendarHeader';
import { ConformanceOptions } from '@mui/internal-test-utils';
import { adapterToUse, createPickerRenderer } from 'test/utils/pickers';
import { describeConformance } from 'test/utils/describeConformance';

const CALENDARS_TO_CLASSES_MAP: Record<1 | 2, ConformanceOptions['classes']> = {
1: pickersCalendarHeaderClasses,
2: pickersArrowSwitcherClasses,
};

describe('<PickersRangeCalendarHeader /> - Describes', () => {
const { render } = createPickerRenderer({ clock: 'fake' });

Object.entries(CALENDARS_TO_CLASSES_MAP).forEach(([calendars, classes]) => {
describeConformance(
<PickersRangeCalendarHeader
calendars={parseInt(calendars, 10) as 1 | 2}
monthIndex={0}
month={adapterToUse.date('2018-01-01')}
currentMonth={adapterToUse.date('2018-01-01')}
minDate={adapterToUse.date('1900-01-01')}
maxDate={adapterToUse.date('2100-12-31')}
onMonthChange={() => {}}
views={['day']}
view="day"
timezone="system"
reduceAnimations
/>,
() => ({
classes,
inheritComponent: 'div',
render,
muiName: 'MuiPickersRangeCalendarHeader',
refInstanceof: window.HTMLDivElement,
skip: [
'componentProp',
'componentsProp',
'themeVariants',
'themeDefaultProps',
'themeStyleOverrides',
],
}),
);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,7 @@ describe('<SingleInputDateRangeField /> - Describes', () => {
render,
muiName: 'MuiSingleInputDateRangeField',
refInstanceof: window.HTMLDivElement,
skip: [
'componentProp',
'componentsProp',
'themeDefaultProps',
'themeStyleOverrides',
'themeVariants',
],
skip: ['componentProp', 'componentsProp', 'themeVariants', 'themeStyleOverrides'],
}));

describeRangeValidation(SingleInputDateRangeField, () => ({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,7 @@ describe('<SingleInputDateTimeRangeField /> - Describes', () => {
render,
muiName: 'MuiSingleInputDateTimeRangeField',
refInstanceof: window.HTMLDivElement,
skip: [
'componentProp',
'componentsProp',
'themeDefaultProps',
'themeStyleOverrides',
'themeVariants',
],
skip: ['componentProp', 'componentsProp', 'themeVariants', 'themeStyleOverrides'],
}));

describeRangeValidation(SingleInputDateTimeRangeField, () => ({
Expand Down
Loading