You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/pages/api-docs/menu.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ The `MuiMenu` name can be used for providing [default props](/customization/glob
28
28
29
29
| Name | Type | Default | Description |
30
30
|:-----|:-----|:--------|:------------|
31
-
| <spanclass="prop-name">anchorEl</span> | <spanclass="prop-type">HTML element<br>| func</span> ||The DOM element used to set the position of the menu. |
31
+
| <spanclass="prop-name">anchorEl</span> | <spanclass="prop-type">HTML element<br>| func</span> ||This is a DOM element, or a function that returns it. It's used to set the position of the menu. |
32
32
| <spanclass="prop-name">autoFocus</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">true</span> | If `true` (Default) will focus the `[role="menu"]` if no focusable child is found. Disabled children are not focusable. If you set this prop to `false` focus will be placed on the parent modal container. This has severe accessibility implications and should only be considered if you manage focus otherwise. |
33
33
| <spanclass="prop-name">children</span> | <spanclass="prop-type">node</span> || Menu contents, normally `MenuItem`s. |
34
34
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
Copy file name to clipboardexpand all lines: docs/pages/api-docs/modal.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ This component shares many concepts with [react-overlays](https://react-bootstra
40
40
| <spanclass="prop-name">BackdropProps</span> | <spanclass="prop-type">object</span> || Props applied to the [`Backdrop`](/api/backdrop/) element. |
41
41
| <spanclass="prop-name required">children *</span> | <spanclass="prop-type">element</span> || A single child content element.<br>⚠️ [Needs to be able to hold a ref](/guides/composition/#caveat-with-refs). |
42
42
| <spanclass="prop-name">closeAfterTransition</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | When set to true the Modal waits until a nested Transition is completed before closing. |
43
-
| <spanclass="prop-name">container</span> | <spanclass="prop-type">object<br>| func</span> || A node, component instance, or function that returns either. The `container` will have the portal children appended to it. |
43
+
| <spanclass="prop-name">container</span> | <spanclass="prop-type">HTML element<br>| React.Component<br>| func</span> || A HTML element, component instance, or function that returns either. The `container` will have the portal children appended to it.<br>By default, it uses the body of the top-level document object, so it's simply `document.body` most of the time. |
44
44
| <spanclass="prop-name">disableAutoFocus</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the `disableAutoFocus` prop.<br>Generally this should never be set to `true` as it makes the modal less accessible to assistive technologies, like screen readers. |
45
45
| <spanclass="prop-name">disableBackdropClick</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, clicking the backdrop will not fire any callback. |
46
46
| <spanclass="prop-name">disableEnforceFocus</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | If `true`, the modal will not prevent focus from leaving the modal while open.<br>Generally this should never be set to `true` as it makes the modal less accessible to assistive technologies, like screen readers. |
Copy file name to clipboardexpand all lines: docs/pages/api-docs/popover.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,13 @@ The `MuiPopover` name can be used for providing [default props](/customization/g
29
29
| Name | Type | Default | Description |
30
30
|:-----|:-----|:--------|:------------|
31
31
| <spanclass="prop-name">action</span> | <spanclass="prop-type">ref</span> || A ref for imperative actions. It currently only supports updatePosition() action. |
32
-
| <spanclass="prop-name">anchorEl</span> | <spanclass="prop-type">HTML element<br>| func</span> || This is the DOM element, or a function that returns it, that may be used to set the position of the popover. |
32
+
| <spanclass="prop-name">anchorEl</span> | <spanclass="prop-type">HTML element<br>| func</span> || This is a DOM element, or a function that returns it. It's used to set the position of the popover. |
33
33
| <spanclass="prop-name">anchorOrigin</span> | <spanclass="prop-type">{ horizontal: 'center'<br>| 'left'<br>| 'right'<br>| number, vertical: 'bottom'<br>| 'center'<br>| 'top'<br>| number }</span> | <spanclass="prop-default">{ vertical: 'top', horizontal: 'left',}</span> | This is the point on the anchor where the popover's `anchorEl` will attach to. This is not used when the anchorReference is 'anchorPosition'.<br>Options: vertical: [top, center, bottom]; horizontal: [left, center, right]. |
34
34
| <spanclass="prop-name">anchorPosition</span> | <spanclass="prop-type">{ left: number, top: number }</span> || This is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area. |
35
35
| <spanclass="prop-name">anchorReference</span> | <spanclass="prop-type">'anchorEl'<br>| 'anchorPosition'<br>| 'none'</span> | <spanclass="prop-default">'anchorEl'</span> | This determines which anchor prop to refer to to set the position of the popover. |
36
36
| <spanclass="prop-name">children</span> | <spanclass="prop-type">node</span> || The content of the component. |
37
37
| <spanclass="prop-name">classes</span> | <spanclass="prop-type">object</span> || Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
38
-
| <spanclass="prop-name">container</span> | <spanclass="prop-type">func<br>| React.Component<br>| HTML element</span> || A node, component instance, or function that returns either. The `container` will passed to the Modal component.By default, it uses the body of the anchorEl's top-level document object, so it's simply `document.body` most of the time. |
38
+
| <spanclass="prop-name">container</span> | <spanclass="prop-type">HTML element<br>| React.Component<br>| func</span> || A HTML element, component instance, or function that returns either. The `container` will passed to the Modal component.<br>By default, it uses the body of the anchorEl's top-level document object, so it's simply `document.body` most of the time. |
39
39
| <spanclass="prop-name">elevation</span> | <spanclass="prop-type">number</span> | <spanclass="prop-default">8</span> | The elevation of the popover. |
40
40
| <spanclass="prop-name">getContentAnchorEl</span> | <spanclass="prop-type">func</span> || This function is called in order to retrieve the content anchor element. It's the opposite of the `anchorEl` prop. The content anchor element should be an element inside the popover. It's used to correctly scroll and set the position of the popover. The positioning strategy tries to make the content anchor element just above the anchor element. |
41
41
| <spanclass="prop-name">marginThreshold</span> | <spanclass="prop-type">number</span> | <spanclass="prop-default">16</span> | Specifies how close to the edge of the window the popover can appear. |
Copy file name to clipboardexpand all lines: docs/pages/api-docs/popper.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Poppers rely on the 3rd party library [Popper.js](https://popper.js.org/docs/v1/
26
26
27
27
| Name | Type | Default | Description |
28
28
|:-----|:-----|:--------|:------------|
29
-
| <spanclass="prop-name">anchorEl</span> | <spanclass="prop-type">object<br>| func</span> ||This is the reference element, or a function that returns it, that may be used to set the position of the popover. The return value will passed as the reference object of the Popper instance.<br>The reference element should be an HTML element instance or a [referenceObject](https://popper.js.org/docs/v1/#referenceObject). |
29
+
| <spanclass="prop-name">anchorEl</span> | <spanclass="prop-type">HTML element<br>| object<br>| func</span> ||A HTML element, [referenceObject](https://popper.js.org/docs/v1/#referenceObject), or a function that returns either. It's used to set the position of the popper. The return value will passed as the reference object of the Popper instance. |
30
30
| <spanclass="prop-name required">children *</span> | <spanclass="prop-type">node<br>| func</span> || Popper render function or node. |
31
31
| <spanclass="prop-name">container</span> | <spanclass="prop-type">func<br>| React.Component<br>| HTML element</span> || A node, component instance, or function that returns either. The `container` will passed to the Modal component. By default, it uses the body of the anchorEl's top-level document object, so it's simply `document.body` most of the time. |
32
32
| <spanclass="prop-name">disablePortal</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | Disable the portal behavior. The children stay within it's parent DOM hierarchy. |
Copy file name to clipboardexpand all lines: docs/pages/api-docs/portal.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ that exists outside the DOM hierarchy of the parent component.
28
28
| Name | Type | Default | Description |
29
29
|:-----|:-----|:--------|:------------|
30
30
| <spanclass="prop-name">children</span> | <spanclass="prop-type">node</span> || The children to render into the `container`. |
31
-
| <spanclass="prop-name">container</span> | <spanclass="prop-type">HTML element<br>| React.Component<br>| func</span> || A HTML element, component instance, or function that returns either. The `container` will have the portal children appended to it.By default, it uses the body of the top-level document object, so it's simply `document.body` most of the time. |
31
+
| <spanclass="prop-name">container</span> | <spanclass="prop-type">HTML element<br>| React.Component<br>| func</span> || A HTML element, component instance, or function that returns either. The `container` will have the portal children appended to it.<br>By default, it uses the body of the top-level document object, so it's simply `document.body` most of the time. |
32
32
| <spanclass="prop-name">disablePortal</span> | <spanclass="prop-type">bool</span> | <spanclass="prop-default">false</span> | Disable the portal behavior. The children stay within it's parent DOM hierarchy. |
33
33
| <spanclass="prop-name">onRendered</span> | <spanclass="prop-type">func</span> || Callback fired once the children has been mounted into the `container`.<br>This prop will be deprecated and removed in v5, the ref can be used instead. |
0 commit comments