Skip to content

Commit 8e5a382

Browse files
committed
Updated documentation of 'overlays.openFlyout' public API
1 parent 1eb8594 commit 8e5a382

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [OverlayFlyoutOpenOptions](./kibana-plugin-core-public.overlayflyoutopenoptions.md) &gt; [maskProps](./kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md)
4+
5+
## OverlayFlyoutOpenOptions.maskProps property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
maskProps?: EuiOverlayMaskProps;
11+
```

docs/development/core/public/kibana-plugin-core-public.overlayflyoutopenoptions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ export interface OverlayFlyoutOpenOptions
2020
| [className](./kibana-plugin-core-public.overlayflyoutopenoptions.classname.md) | <code>string</code> | |
2121
| [closeButtonAriaLabel](./kibana-plugin-core-public.overlayflyoutopenoptions.closebuttonarialabel.md) | <code>string</code> | |
2222
| [hideCloseButton](./kibana-plugin-core-public.overlayflyoutopenoptions.hideclosebutton.md) | <code>boolean</code> | |
23+
| [maskProps](./kibana-plugin-core-public.overlayflyoutopenoptions.maskprops.md) | <code>EuiOverlayMaskProps</code> | |
2324
| [maxWidth](./kibana-plugin-core-public.overlayflyoutopenoptions.maxwidth.md) | <code>boolean &#124; number &#124; string</code> | |
2425
| [onClose](./kibana-plugin-core-public.overlayflyoutopenoptions.onclose.md) | <code>(flyout: OverlayRef) =&gt; void</code> | EuiFlyout onClose handler. If provided the consumer is responsible for calling flyout.close() to close the flyout; |
2526
| [ownFocus](./kibana-plugin-core-public.overlayflyoutopenoptions.ownfocus.md) | <code>boolean</code> | |

src/core/public/public.api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { EuiButtonEmptyProps } from '@elastic/eui';
1717
import { EuiConfirmModalProps } from '@elastic/eui';
1818
import { EuiFlyoutSize } from '@elastic/eui';
1919
import { EuiGlobalToastListToast } from '@elastic/eui';
20+
import { EuiOverlayMaskProps } from '@elastic/eui';
2021
import { History } from 'history';
2122
import { Href } from 'history';
2223
import { IconType } from '@elastic/eui';
@@ -1046,6 +1047,8 @@ export interface OverlayFlyoutOpenOptions {
10461047
// (undocumented)
10471048
hideCloseButton?: boolean;
10481049
// (undocumented)
1050+
maskProps?: EuiOverlayMaskProps;
1051+
// (undocumented)
10491052
maxWidth?: boolean | number | string;
10501053
onClose?: (flyout: OverlayRef) => void;
10511054
// (undocumented)

0 commit comments

Comments
 (0)