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

Jump to bottom

[docs] Add API of *DateRangePicker components #25085

Merged
merged 5 commits into from Feb 25, 2021
Merged

[docs] Add API of *DateRangePicker components #25085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c0afd96
Enable API docs for DateRangePicker components
eps1lon Feb 24, 2021
bfa479b
Runnable yarn docs:api
eps1lon Feb 24, 2021
b14651a
[docs] Add API of *DateRangePicker components
eps1lon Feb 24, 2021
1c34d9b
yarn docs:typescript:formatted
eps1lon Feb 24, 2021
927946a
fix demo path
eps1lon Feb 24, 2021
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
23 changes: 23 additions & 0 deletions docs/pages/api-docs/date-range-picker.js
View file
Open in desktop
@@ -0,0 +1,23 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './date-range-picker.json';

export default function Page(props) {
const { descriptions, pageContent } = props;
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
}

Page.getInitialProps = () => {
const req = require.context(
'docs/translations/api-docs/date-range-picker',
false,
/date-range-picker.*.json$/,
);
const descriptions = mapApiPageTranslations(req);

return {
descriptions,
pageContent: jsonPageContent,
};
};
92 changes: 92 additions & 0 deletions docs/pages/api-docs/date-range-picker.json
View file
Open in desktop
@@ -0,0 +1,92 @@
{
"props": {
"onChange": { "type": { "name": "func" }, "required": true },
"renderInput": { "type": { "name": "func" }, "required": true },
"value": {
"type": {
"name": "arrayOf",
"description": "Array&lt;any<br>&#124;&nbsp;Date<br>&#124;&nbsp;number<br>&#124;&nbsp;string&gt;"
},
"required": true
},
"acceptRegex": { "type": { "name": "instanceOf", "description": "RegExp" } },
"allowKeyboardControl": { "type": { "name": "bool" } },
"allowSameDateSelection": { "type": { "name": "bool" } },
"calendars": {
"type": { "name": "enum", "description": "1<br>&#124;&nbsp;2<br>&#124;&nbsp;3" }
},
"cancelText": { "type": { "name": "node" } },
"className": { "type": { "name": "string" } },
"clearable": { "type": { "name": "bool" } },
"clearText": { "type": { "name": "node" } },
"components": {
"type": {
"name": "shape",
"description": "{ LeftArrowButton?: elementType, LeftArrowIcon?: elementType, RightArrowButton?: elementType, RightArrowIcon?: elementType, SwitchViewButton?: elementType, SwitchViewIcon?: elementType }"
}
},
"componentsProps": { "type": { "name": "object" } },
"dateAdapter": { "type": { "name": "object" } },
"defaultCalendarMonth": { "type": { "name": "any" } },
"desktopModeMediaQuery": { "type": { "name": "string" } },
"DialogProps": { "type": { "name": "object" } },
"disableAutoMonthSwitching": { "type": { "name": "bool" } },
"disableCloseOnSelect": { "type": { "name": "bool" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
"disableHighlightToday": { "type": { "name": "bool" } },
"disableMaskedInput": { "type": { "name": "bool" } },
"disableOpenPicker": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"endText": { "type": { "name": "node" } },
"getOpenDialogAriaText": { "type": { "name": "func" } },
"getViewSwitchingButtonText": { "type": { "name": "func" } },
"InputAdornmentProps": { "type": { "name": "object" } },
"inputFormat": { "type": { "name": "string" } },
"leftArrowButtonText": { "type": { "name": "string" } },
"loading": { "type": { "name": "bool" } },
"mask": { "type": { "name": "string" } },
"maxDate": { "type": { "name": "any" } },
"minDate": { "type": { "name": "any" } },
"okText": { "type": { "name": "node" } },
"onAccept": { "type": { "name": "func" } },
"onClose": { "type": { "name": "func" } },
"onError": { "type": { "name": "func" } },
"onMonthChange": { "type": { "name": "func" } },
"onOpen": { "type": { "name": "func" } },
"onViewChange": { "type": { "name": "func" } },
"open": { "type": { "name": "bool" } },
"OpenPickerButtonProps": { "type": { "name": "object" } },
"openPickerIcon": { "type": { "name": "node" } },
"orientation": {
"type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
},
"PopperProps": { "type": { "name": "object" } },
"readOnly": { "type": { "name": "bool" } },
"reduceAnimations": { "type": { "name": "bool" } },
"renderDay": { "type": { "name": "func" } },
"renderLoading": { "type": { "name": "func" } },
"rifmFormatter": { "type": { "name": "func" } },
"rightArrowButtonText": { "type": { "name": "string" } },
"shouldDisableDate": { "type": { "name": "func" } },
"shouldDisableYear": { "type": { "name": "func" } },
"showDaysOutsideCurrentMonth": { "type": { "name": "bool" } },
"showTodayButton": { "type": { "name": "bool" } },
"showToolbar": { "type": { "name": "bool" } },
"startText": { "type": { "name": "node" } },
"todayText": { "type": { "name": "node" } },
"ToolbarComponent": { "type": { "name": "elementType" } },
"toolbarFormat": { "type": { "name": "string" } },
"toolbarPlaceholder": { "type": { "name": "node" } },
"toolbarTitle": { "type": { "name": "node" } },
"TransitionComponent": { "type": { "name": "elementType" } }
},
"name": "DateRangePicker",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"spread": true,
"filename": "/packages/material-ui-lab/src/DateRangePicker/DateRangePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/date-range-picker/\">Date Range Picker</a></li></ul>",
"styledComponent": true,
"cssComponent": false
}
23 changes: 23 additions & 0 deletions docs/pages/api-docs/desktop-date-range-picker.js
View file
Open in desktop
@@ -0,0 +1,23 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './desktop-date-range-picker.json';

export default function Page(props) {
const { descriptions, pageContent } = props;
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
}

Page.getInitialProps = () => {
const req = require.context(
'docs/translations/api-docs/desktop-date-range-picker',
false,
/desktop-date-range-picker.*.json$/,
);
const descriptions = mapApiPageTranslations(req);

return {
descriptions,
pageContent: jsonPageContent,
};
};
84 changes: 84 additions & 0 deletions docs/pages/api-docs/desktop-date-range-picker.json
View file
Open in desktop
@@ -0,0 +1,84 @@
{
"props": {
"onChange": { "type": { "name": "func" }, "required": true },
"renderInput": { "type": { "name": "func" }, "required": true },
"value": {
"type": {
"name": "arrayOf",
"description": "Array&lt;any<br>&#124;&nbsp;Date<br>&#124;&nbsp;number<br>&#124;&nbsp;string&gt;"
},
"required": true
},
"acceptRegex": { "type": { "name": "instanceOf", "description": "RegExp" } },
"allowKeyboardControl": { "type": { "name": "bool" } },
"allowSameDateSelection": { "type": { "name": "bool" } },
"calendars": {
"type": { "name": "enum", "description": "1<br>&#124;&nbsp;2<br>&#124;&nbsp;3" }
},
"className": { "type": { "name": "string" } },
"components": {
"type": {
"name": "shape",
"description": "{ LeftArrowButton?: elementType, LeftArrowIcon?: elementType, RightArrowButton?: elementType, RightArrowIcon?: elementType, SwitchViewButton?: elementType, SwitchViewIcon?: elementType }"
}
},
"componentsProps": { "type": { "name": "object" } },
"dateAdapter": { "type": { "name": "object" } },
"defaultCalendarMonth": { "type": { "name": "any" } },
"disableAutoMonthSwitching": { "type": { "name": "bool" } },
"disableCloseOnSelect": { "type": { "name": "bool" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
"disableHighlightToday": { "type": { "name": "bool" } },
"disableMaskedInput": { "type": { "name": "bool" } },
"disableOpenPicker": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"endText": { "type": { "name": "node" } },
"getOpenDialogAriaText": { "type": { "name": "func" } },
"getViewSwitchingButtonText": { "type": { "name": "func" } },
"InputAdornmentProps": { "type": { "name": "object" } },
"inputFormat": { "type": { "name": "string" } },
"leftArrowButtonText": { "type": { "name": "string" } },
"loading": { "type": { "name": "bool" } },
"mask": { "type": { "name": "string" } },
"maxDate": { "type": { "name": "any" } },
"minDate": { "type": { "name": "any" } },
"onAccept": { "type": { "name": "func" } },
"onClose": { "type": { "name": "func" } },
"onError": { "type": { "name": "func" } },
"onMonthChange": { "type": { "name": "func" } },
"onOpen": { "type": { "name": "func" } },
"onViewChange": { "type": { "name": "func" } },
"open": { "type": { "name": "bool" } },
"OpenPickerButtonProps": { "type": { "name": "object" } },
"openPickerIcon": { "type": { "name": "node" } },
"orientation": {
"type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
},
"PopperProps": { "type": { "name": "object" } },
"readOnly": { "type": { "name": "bool" } },
"reduceAnimations": { "type": { "name": "bool" } },
"renderDay": { "type": { "name": "func" } },
"renderLoading": { "type": { "name": "func" } },
"rifmFormatter": { "type": { "name": "func" } },
"rightArrowButtonText": { "type": { "name": "string" } },
"shouldDisableDate": { "type": { "name": "func" } },
"shouldDisableYear": { "type": { "name": "func" } },
"showDaysOutsideCurrentMonth": { "type": { "name": "bool" } },
"showToolbar": { "type": { "name": "bool" } },
"startText": { "type": { "name": "node" } },
"ToolbarComponent": { "type": { "name": "elementType" } },
"toolbarFormat": { "type": { "name": "string" } },
"toolbarPlaceholder": { "type": { "name": "node" } },
"toolbarTitle": { "type": { "name": "node" } },
"TransitionComponent": { "type": { "name": "elementType" } }
},
"name": "DesktopDateRangePicker",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"spread": true,
"filename": "/packages/material-ui-lab/src/DesktopDateRangePicker/DesktopDateRangePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/date-range-picker/\">Date Range Picker</a></li></ul>",
"styledComponent": true,
"cssComponent": false
}
23 changes: 23 additions & 0 deletions docs/pages/api-docs/mobile-date-range-picker.js
View file
Open in desktop
@@ -0,0 +1,23 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './mobile-date-range-picker.json';

export default function Page(props) {
const { descriptions, pageContent } = props;
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
}

Page.getInitialProps = () => {
const req = require.context(
'docs/translations/api-docs/mobile-date-range-picker',
false,
/mobile-date-range-picker.*.json$/,
);
const descriptions = mapApiPageTranslations(req);

return {
descriptions,
pageContent: jsonPageContent,
};
};
89 changes: 89 additions & 0 deletions docs/pages/api-docs/mobile-date-range-picker.json
View file
Open in desktop
@@ -0,0 +1,89 @@
{
"props": {
"onChange": { "type": { "name": "func" }, "required": true },
"renderInput": { "type": { "name": "func" }, "required": true },
"value": {
"type": {
"name": "arrayOf",
"description": "Array&lt;any<br>&#124;&nbsp;Date<br>&#124;&nbsp;number<br>&#124;&nbsp;string&gt;"
},
"required": true
},
"acceptRegex": { "type": { "name": "instanceOf", "description": "RegExp" } },
"allowKeyboardControl": { "type": { "name": "bool" } },
"allowSameDateSelection": { "type": { "name": "bool" } },
"calendars": {
"type": { "name": "enum", "description": "1<br>&#124;&nbsp;2<br>&#124;&nbsp;3" }
},
"cancelText": { "type": { "name": "node" } },
"className": { "type": { "name": "string" } },
"clearable": { "type": { "name": "bool" } },
"clearText": { "type": { "name": "node" } },
"components": {
"type": {
"name": "shape",
"description": "{ LeftArrowButton?: elementType, LeftArrowIcon?: elementType, RightArrowButton?: elementType, RightArrowIcon?: elementType, SwitchViewButton?: elementType, SwitchViewIcon?: elementType }"
}
},
"componentsProps": { "type": { "name": "object" } },
"dateAdapter": { "type": { "name": "object" } },
"defaultCalendarMonth": { "type": { "name": "any" } },
"DialogProps": { "type": { "name": "object" } },
"disableAutoMonthSwitching": { "type": { "name": "bool" } },
"disableCloseOnSelect": { "type": { "name": "bool" } },
"disabled": { "type": { "name": "bool" } },
"disableFuture": { "type": { "name": "bool" } },
"disableHighlightToday": { "type": { "name": "bool" } },
"disableMaskedInput": { "type": { "name": "bool" } },
"disableOpenPicker": { "type": { "name": "bool" } },
"disablePast": { "type": { "name": "bool" } },
"endText": { "type": { "name": "node" } },
"getOpenDialogAriaText": { "type": { "name": "func" } },
"getViewSwitchingButtonText": { "type": { "name": "func" } },
"InputAdornmentProps": { "type": { "name": "object" } },
"inputFormat": { "type": { "name": "string" } },
"leftArrowButtonText": { "type": { "name": "string" } },
"loading": { "type": { "name": "bool" } },
"mask": { "type": { "name": "string" } },
"maxDate": { "type": { "name": "any" } },
"minDate": { "type": { "name": "any" } },
"okText": { "type": { "name": "node" } },
"onAccept": { "type": { "name": "func" } },
"onClose": { "type": { "name": "func" } },
"onError": { "type": { "name": "func" } },
"onMonthChange": { "type": { "name": "func" } },
"onOpen": { "type": { "name": "func" } },
"onViewChange": { "type": { "name": "func" } },
"open": { "type": { "name": "bool" } },
"OpenPickerButtonProps": { "type": { "name": "object" } },
"openPickerIcon": { "type": { "name": "node" } },
"orientation": {
"type": { "name": "enum", "description": "'landscape'<br>&#124;&nbsp;'portrait'" }
},
"readOnly": { "type": { "name": "bool" } },
"reduceAnimations": { "type": { "name": "bool" } },
"renderDay": { "type": { "name": "func" } },
"renderLoading": { "type": { "name": "func" } },
"rifmFormatter": { "type": { "name": "func" } },
"rightArrowButtonText": { "type": { "name": "string" } },
"shouldDisableDate": { "type": { "name": "func" } },
"shouldDisableYear": { "type": { "name": "func" } },
"showDaysOutsideCurrentMonth": { "type": { "name": "bool" } },
"showTodayButton": { "type": { "name": "bool" } },
"showToolbar": { "type": { "name": "bool" } },
"startText": { "type": { "name": "node" } },
"todayText": { "type": { "name": "node" } },
"ToolbarComponent": { "type": { "name": "elementType" } },
"toolbarFormat": { "type": { "name": "string" } },
"toolbarPlaceholder": { "type": { "name": "node" } },
"toolbarTitle": { "type": { "name": "node" } }
},
"name": "MobileDateRangePicker",
"styles": { "classes": [], "globalClasses": {}, "name": null },
"spread": true,
"filename": "/packages/material-ui-lab/src/MobileDateRangePicker/MobileDateRangePicker.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/date-range-picker/\">Date Range Picker</a></li></ul>",
"styledComponent": true,
"cssComponent": false
}
23 changes: 23 additions & 0 deletions docs/pages/api-docs/static-date-range-picker.js
View file
Open in desktop
@@ -0,0 +1,23 @@
import * as React from 'react';
import ApiPage from 'docs/src/modules/components/ApiPage';
import mapApiPageTranslations from 'docs/src/modules/utils/mapApiPageTranslations';
import jsonPageContent from './static-date-range-picker.json';

export default function Page(props) {
const { descriptions, pageContent } = props;
return <ApiPage descriptions={descriptions} pageContent={pageContent} />;
}

Page.getInitialProps = () => {
const req = require.context(
'docs/translations/api-docs/static-date-range-picker',
false,
/static-date-range-picker.*.json$/,
);
const descriptions = mapApiPageTranslations(req);

return {
descriptions,
pageContent: jsonPageContent,
};
};