Skip to content

Commit

Permalink
docs:api
Browse files Browse the repository at this point in the history
  • Loading branch information
MBilalShafi committed Jan 11, 2024
1 parent 1aeb33a commit 243ae70
Show file tree
Hide file tree
Showing 7 changed files with 73 additions and 71 deletions.
48 changes: 24 additions & 24 deletions docs/pages/x/api/date-pickers/date-range-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -209,30 +209,6 @@
"default": "ArrowDropDown",
"class": null
},
{
"name": "desktopPaper",
"description": "Custom component for the paper rendered inside the desktop picker's Popper.",
"default": "PickersPopperPaper",
"class": null
},
{
"name": "desktopTransition",
"description": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"default": "Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.",
"class": null
},
{
"name": "desktopTrapFocus",
"description": "Custom component for trapping the focus inside the views on desktop.",
"default": "FocusTrap from '@mui/base'.",
"class": null
},
{
"name": "popper",
"description": "Custom component for the popper inside which the views are rendered on desktop.",
"default": "Popper from '@mui/material'.",
"class": null
},
{
"name": "actionBar",
"description": "Custom component for the action bar, it is placed below the picker views.",
Expand Down Expand Up @@ -278,6 +254,30 @@
"default": "IconButton",
"class": null
},
{
"name": "desktopPaper",
"description": "Custom component for the paper rendered inside the desktop picker's Popper.",
"default": "PickersPopperPaper",
"class": null
},
{
"name": "desktopTransition",
"description": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"default": "Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.",
"class": null
},
{
"name": "desktopTrapFocus",
"description": "Custom component for trapping the focus inside the views on desktop.",
"default": "FocusTrap from '@mui/base'.",
"class": null
},
{
"name": "popper",
"description": "Custom component for the popper inside which the views are rendered on desktop.",
"default": "Popper from '@mui/material'.",
"class": null
},
{ "name": "field", "description": "", "class": null },
{
"name": "dialog",
Expand Down
48 changes: 24 additions & 24 deletions docs/pages/x/api/date-pickers/desktop-date-range-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -205,30 +205,6 @@
"default": "ArrowDropDown",
"class": null
},
{
"name": "desktopPaper",
"description": "Custom component for the paper rendered inside the desktop picker's Popper.",
"default": "PickersPopperPaper",
"class": null
},
{
"name": "desktopTransition",
"description": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"default": "Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.",
"class": null
},
{
"name": "desktopTrapFocus",
"description": "Custom component for trapping the focus inside the views on desktop.",
"default": "FocusTrap from '@mui/base'.",
"class": null
},
{
"name": "popper",
"description": "Custom component for the popper inside which the views are rendered on desktop.",
"default": "Popper from '@mui/material'.",
"class": null
},
{
"name": "actionBar",
"description": "Custom component for the action bar, it is placed below the picker views.",
Expand Down Expand Up @@ -274,6 +250,30 @@
"default": "IconButton",
"class": null
},
{
"name": "desktopPaper",
"description": "Custom component for the paper rendered inside the desktop picker's Popper.",
"default": "PickersPopperPaper",
"class": null
},
{
"name": "desktopTransition",
"description": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"default": "Grow or Fade from '@mui/material' when `reduceAnimations` is `true`.",
"class": null
},
{
"name": "desktopTrapFocus",
"description": "Custom component for trapping the focus inside the views on desktop.",
"default": "FocusTrap from '@mui/base'.",
"class": null
},
{
"name": "popper",
"description": "Custom component for the popper inside which the views are rendered on desktop.",
"default": "Popper from '@mui/material'.",
"class": null
},
{ "name": "field", "description": "", "class": null }
],
"classes": [],
Expand Down
24 changes: 12 additions & 12 deletions docs/pages/x/api/date-pickers/mobile-date-range-picker.json
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,18 @@
"default": "PickersModalDialogRoot",
"class": null
},
{
"name": "mobilePaper",
"description": "Custom component for the paper rendered inside the mobile picker's Dialog.",
"default": "Paper from '@mui/material'.",
"class": null
},
{
"name": "mobileTransition",
"description": "Custom component for the mobile dialog [Transition](https://mui.com/material-ui/transitions/).",
"default": "Fade from '@mui/material'.",
"class": null
},
{
"name": "actionBar",
"description": "Custom component for the action bar, it is placed below the picker views.",
Expand Down Expand Up @@ -256,18 +268,6 @@
"default": "IconButton",
"class": null
},
{
"name": "mobilePaper",
"description": "Custom component for the paper rendered inside the mobile picker's Dialog.",
"default": "Paper from '@mui/material'.",
"class": null
},
{
"name": "mobileTransition",
"description": "Custom component for the mobile dialog [Transition](https://mui.com/material-ui/transitions/).",
"default": "Fade from '@mui/material'.",
"class": null
},
{ "name": "field", "description": "", "class": null }
],
"classes": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@
"description": "Props passed to the logic operator input component."
},
"logicOperators": { "description": "Sets the available logic operators." },
"multiFilterOperator": { "description": "The current logic operator applied." },
"operatorInputProps": { "description": "Props passed to the operator input component." },
"readOnly": {
"description": "<code>true</code> if the filter is disabled/read only. i.e. <code>colDef.fiterable = false</code> but passed in <code>filterModel</code>"
},
"showMultiFilterOperators": {
"description": "If <code>true</code>, the logic operator field is visible."
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,6 @@
"rightArrowIcon": "Icon displayed in the right view switch button.",
"switchViewButton": "Button displayed to switch between different calendar views.",
"switchViewIcon": "Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.",
"desktopPaper": "Custom component for the paper rendered inside the desktop picker's Popper.",
"desktopTransition": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"desktopTrapFocus": "Custom component for trapping the focus inside the views on desktop.",
"popper": "Custom component for the popper inside which the views are rendered on desktop.",
"actionBar": "Custom component for the action bar, it is placed below the picker views.",
"shortcuts": "Custom component for the shortcuts.",
"layout": "Custom component for wrapping the layout.\nIt wraps the toolbar, views, action bar, and shortcuts.",
Expand All @@ -173,6 +169,10 @@
"textField": "Form control with an input to render a date or time inside the default field.\nIt is rendered twice: once for the start element and once for the end element.\nReceives the same props as `@mui/material/TextField`.",
"clearIcon": "Icon to display inside the clear button.",
"clearButton": "Button to clear the value.",
"desktopPaper": "Custom component for the paper rendered inside the desktop picker's Popper.",
"desktopTransition": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"desktopTrapFocus": "Custom component for trapping the focus inside the views on desktop.",
"popper": "Custom component for the popper inside which the views are rendered on desktop.",
"field": "",
"dialog": "Custom component for the dialog inside which the views are rendered on mobile.",
"mobilePaper": "Custom component for the paper rendered inside the mobile picker's Dialog.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,6 @@
"rightArrowIcon": "Icon displayed in the right view switch button.",
"switchViewButton": "Button displayed to switch between different calendar views.",
"switchViewIcon": "Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.",
"desktopPaper": "Custom component for the paper rendered inside the desktop picker's Popper.",
"desktopTransition": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"desktopTrapFocus": "Custom component for trapping the focus inside the views on desktop.",
"popper": "Custom component for the popper inside which the views are rendered on desktop.",
"actionBar": "Custom component for the action bar, it is placed below the picker views.",
"shortcuts": "Custom component for the shortcuts.",
"layout": "Custom component for wrapping the layout.\nIt wraps the toolbar, views, action bar, and shortcuts.",
Expand All @@ -170,6 +166,10 @@
"textField": "Form control with an input to render a date or time inside the default field.\nIt is rendered twice: once for the start element and once for the end element.\nReceives the same props as `@mui/material/TextField`.",
"clearIcon": "Icon to display inside the clear button.",
"clearButton": "Button to clear the value.",
"desktopPaper": "Custom component for the paper rendered inside the desktop picker's Popper.",
"desktopTransition": "Custom component for the desktop popper [Transition](https://mui.com/material-ui/transitions/).",
"desktopTrapFocus": "Custom component for trapping the focus inside the views on desktop.",
"popper": "Custom component for the popper inside which the views are rendered on desktop.",
"field": ""
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@
"switchViewButton": "Button displayed to switch between different calendar views.",
"switchViewIcon": "Icon displayed in the SwitchViewButton. Rotated by 180° when the open view is 'year'.",
"dialog": "Custom component for the dialog inside which the views are rendered on mobile.",
"mobilePaper": "Custom component for the paper rendered inside the mobile picker's Dialog.",
"mobileTransition": "Custom component for the mobile dialog [Transition](https://mui.com/material-ui/transitions/).",
"actionBar": "Custom component for the action bar, it is placed below the picker views.",
"shortcuts": "Custom component for the shortcuts.",
"layout": "Custom component for wrapping the layout.\nIt wraps the toolbar, views, action bar, and shortcuts.",
Expand All @@ -167,8 +169,6 @@
"textField": "Form control with an input to render a date or time inside the default field.\nIt is rendered twice: once for the start element and once for the end element.\nReceives the same props as `@mui/material/TextField`.",
"clearIcon": "Icon to display inside the clear button.",
"clearButton": "Button to clear the value.",
"mobilePaper": "Custom component for the paper rendered inside the mobile picker's Dialog.",
"mobileTransition": "Custom component for the mobile dialog [Transition](https://mui.com/material-ui/transitions/).",
"field": ""
}
}

0 comments on commit 243ae70

Please sign in to comment.