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.

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

[docs] Add reference links to picker field components #10631

Merged
merged 13 commits into from
Oct 12, 2023
Merged

[docs] Add reference links to picker field components #10631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
72ee17c
added SingleInputTimeRangeField and SingleInputDateTimeRangeField com…
michelengelen Oct 10, 2023
d3f64d7
added reference links to DateField component
michelengelen Oct 10, 2023
598738c
added reference links to TimeField component
michelengelen Oct 10, 2023
ac59f28
added reference links to DateTimeField component
michelengelen Oct 10, 2023
23c8ec3
added reference links to MultiInputDateRangeField component
michelengelen Oct 10, 2023
08baf76
added reference links to MultiInputDateTimeRangeField component
michelengelen Oct 10, 2023
6c0d699
added reference links to MultiInputTimeRangeField component
michelengelen Oct 10, 2023
023d09a
added reference links to SingleInputDateRangeField component
michelengelen Oct 10, 2023
4a6a78d
added reference links to SingleInputDateTimeRangeField component
michelengelen Oct 10, 2023
108cc26
added reference links to SingleInputTimeRangeField component
michelengelen Oct 10, 2023
ba58e0b
moved JSDoc comments to the initializer
michelengelen Oct 10, 2023
7741955
updated generated json for api docs
michelengelen Oct 10, 2023
d27ddaa
updated component annotation and generated API description
michelengelen Oct 12, 2023
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
2 changes: 2 additions & 0 deletions docs/pages/x/api/date-pickers/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@
- [MultiInputDateRangeField](/x/api/date-pickers/multi-input-date-range-field/)
- [SingleInputDateRangeField](/x/api/date-pickers/single-input-date-range-field/)
- [MultiInputTimeRangeField](/x/api/date-pickers/multi-input-time-range-field/)
- [SingleInputTimeRangeField](/x/api/date-pickers/single-input-time-range-field/)
Copy link
Member

Choose a reason for hiding this comment

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

Nice spot, thanks for adding these in. 👍 🙌

- [MultiInputDateTimeRangeField](/x/api/date-pickers/multi-input-date-time-range-field/)
- [SingleInputDateTimeRangeField](/x/api/date-pickers/single-input-date-time-range-field/)

### Calendars

Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers-pro/src/MultiInputDateRangeField/MultiInputDateRangeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ type MultiInputDateRangeFieldComponent = (<TDate>(
props: MultiInputDateRangeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any };

/**
* Demos:
*
* - [DateRangeField](http://mui.com/x/react-date-pickers/date-range-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [MultiInputDateRangeField API](https://mui.com/x/api/multi-input-date-range-field/)
*/
const MultiInputDateRangeField = React.forwardRef(function MultiInputDateRangeField<TDate>(
inProps: MultiInputDateRangeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions ...ages/x-date-pickers-pro/src/MultiInputDateTimeRangeField/MultiInputDateTimeRangeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ type MultiInputDateTimeRangeFieldComponent = (<TDate>(
props: MultiInputDateTimeRangeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any };

/**
* Demos:
*
* - [DateTimeRangeField](http://mui.com/x/react-date-pickers/date-time-range-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [MultiInputDateTimeRangeField API](https://mui.com/x/api/multi-input-date-time-range-field/)
*/
const MultiInputDateTimeRangeField = React.forwardRef(function MultiInputDateTimeRangeField<TDate>(
inProps: MultiInputDateTimeRangeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers-pro/src/MultiInputTimeRangeField/MultiInputTimeRangeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ type MultiInputTimeRangeFieldComponent = (<TDate>(
props: MultiInputTimeRangeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any };

/**
* Demos:
*
* - [TimeRangeField](http://mui.com/x/react-date-pickers/time-range-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [MultiInputTimeRangeField API](https://mui.com/x/api/multi-input-time-range-field/)
*/
const MultiInputTimeRangeField = React.forwardRef(function MultiInputTimeRangeField<TDate>(
inProps: MultiInputTimeRangeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers-pro/src/SingleInputDateRangeField/SingleInputDateRangeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ type DateRangeFieldComponent = (<TDate>(
props: SingleInputDateRangeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any; fieldType?: string };

/**
* Demos:
*
* - [DateRangeField](http://mui.com/x/react-date-pickers/date-range-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [SingleInputDateRangeField API](https://mui.com/x/api/single-input-date-range-field/)
*/
const SingleInputDateRangeField = React.forwardRef(function SingleInputDateRangeField<TDate>(
inProps: SingleInputDateRangeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions ...es/x-date-pickers-pro/src/SingleInputDateTimeRangeField/SingleInputDateTimeRangeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ type DateRangeFieldComponent = (<TDate>(
props: SingleInputDateTimeRangeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any; fieldType?: string };

/**
* Demos:
*
* - [DateTimeRangeField](http://mui.com/x/react-date-pickers/date-time-range-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [SingleInputDateTimeRangeField API](https://mui.com/x/api/single-input-date-time-range-field/)
*/
const SingleInputDateTimeRangeField = React.forwardRef(function SingleInputDateTimeRangeField<
TDate,
>(inProps: SingleInputDateTimeRangeFieldProps<TDate>, ref: React.Ref<HTMLDivElement>) {
Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers-pro/src/SingleInputTimeRangeField/SingleInputTimeRangeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ type DateRangeFieldComponent = (<TDate>(
props: SingleInputTimeRangeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any; fieldType?: string };

/**
* Demos:
*
* - [TimeRangeField](http://mui.com/x/react-date-pickers/time-range-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [SingleInputTimeRangeField API](https://mui.com/x/api/single-input-time-range-field/)
*/
const SingleInputTimeRangeField = React.forwardRef(function SingleInputTimeRangeField<TDate>(
inProps: SingleInputTimeRangeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers/src/DateField/DateField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ type DateFieldComponent = (<TDate>(
props: DateFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any };

/**
* Demos:
*
* - [DateField](http://mui.com/x/react-date-pickers/date-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [DateField API](https://mui.com/x/api/date-pickers/date-field/)
*/
const DateField = React.forwardRef(function DateField<TDate>(
inProps: DateFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers/src/DateTimeField/DateTimeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ type DateTimeFieldComponent = (<TDate>(
props: DateTimeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any };

/**
* Demos:
*
* - [DateTimeField](http://mui.com/x/react-date-pickers/date-time-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [DateTimeField API](https://mui.com/x/api/date-pickers/date-time-field/)
*/
const DateTimeField = React.forwardRef(function DateTimeField<TDate>(
inProps: DateTimeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
10 changes: 10 additions & 0 deletions packages/x-date-pickers/src/TimeField/TimeField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ type TimeFieldComponent = (<TDate>(
props: TimeFieldProps<TDate> & React.RefAttributes<HTMLDivElement>,
) => React.JSX.Element) & { propTypes?: any };

/**
* Demos:
*
* - [TimeField](http://mui.com/x/react-date-pickers/time-field/)
* - [Fields](https://mui.com/x/react-date-pickers/fields/)
*
* API:
*
* - [TimeField API](https://mui.com/x/api/date-pickers/time-field/)
*/
const TimeField = React.forwardRef(function TimeField<TDate>(
inProps: TimeFieldProps<TDate>,
ref: React.Ref<HTMLDivElement>,
Expand Down
Loading