-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move ui/notify banners to New Platform (#43610)
- Loading branch information
Showing
57 changed files
with
1,243 additions
and
576 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.overlaybannermount.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannerMount](./kibana-plugin-public.overlaybannermount.md) | ||
|
||
## OverlayBannerMount type | ||
|
||
A function that will mount the banner inside the provided element. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type OverlayBannerMount = (element: HTMLElement) => OverlayBannerUnmount; | ||
``` |
27 changes: 27 additions & 0 deletions
27
docs/development/core/public/kibana-plugin-public.overlaybannersstart.add.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) > [add](./kibana-plugin-public.overlaybannersstart.add.md) | ||
|
||
## OverlayBannersStart.add() method | ||
|
||
Add a new banner | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
add(mount: OverlayBannerMount, priority?: number): string; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| mount | <code>OverlayBannerMount</code> | | | ||
| priority | <code>number</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`string` | ||
|
||
a unique identifier for the given banner to be used with [OverlayBannersStart.remove()](./kibana-plugin-public.overlaybannersstart.remove.md) and [OverlayBannersStart.replace()](./kibana-plugin-public.overlaybannersstart.replace.md) | ||
|
15 changes: 15 additions & 0 deletions
15
...evelopment/core/public/kibana-plugin-public.overlaybannersstart.getcomponent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) > [getComponent](./kibana-plugin-public.overlaybannersstart.getcomponent.md) | ||
|
||
## OverlayBannersStart.getComponent() method | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
getComponent(): JSX.Element; | ||
``` | ||
<b>Returns:</b> | ||
|
||
`JSX.Element` | ||
|
22 changes: 22 additions & 0 deletions
22
docs/development/core/public/kibana-plugin-public.overlaybannersstart.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) | ||
|
||
## OverlayBannersStart interface | ||
|
||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface OverlayBannersStart | ||
``` | ||
|
||
## Methods | ||
|
||
| Method | Description | | ||
| --- | --- | | ||
| [add(mount, priority)](./kibana-plugin-public.overlaybannersstart.add.md) | Add a new banner | | ||
| [getComponent()](./kibana-plugin-public.overlaybannersstart.getcomponent.md) | | | ||
| [remove(id)](./kibana-plugin-public.overlaybannersstart.remove.md) | Remove a banner | | ||
| [replace(id, mount, priority)](./kibana-plugin-public.overlaybannersstart.replace.md) | Replace a banner in place | | ||
|
26 changes: 26 additions & 0 deletions
26
docs/development/core/public/kibana-plugin-public.overlaybannersstart.remove.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) > [remove](./kibana-plugin-public.overlaybannersstart.remove.md) | ||
|
||
## OverlayBannersStart.remove() method | ||
|
||
Remove a banner | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
remove(id: string): boolean; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| id | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`boolean` | ||
|
||
if the banner was found or not | ||
|
28 changes: 28 additions & 0 deletions
28
docs/development/core/public/kibana-plugin-public.overlaybannersstart.replace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) > [replace](./kibana-plugin-public.overlaybannersstart.replace.md) | ||
|
||
## OverlayBannersStart.replace() method | ||
|
||
Replace a banner in place | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
replace(id: string | undefined, mount: OverlayBannerMount, priority?: number): string; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| id | <code>string | undefined</code> | | | ||
| mount | <code>OverlayBannerMount</code> | | | ||
| priority | <code>number</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`string` | ||
|
||
a new identifier for the given banner to be used with [OverlayBannersStart.remove()](./kibana-plugin-public.overlaybannersstart.remove.md) and [OverlayBannersStart.replace()](./kibana-plugin-public.overlaybannersstart.replace.md) | ||
|
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.overlaybannerunmount.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayBannerUnmount](./kibana-plugin-public.overlaybannerunmount.md) | ||
|
||
## OverlayBannerUnmount type | ||
|
||
A function that will unmount the banner from the element. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type OverlayBannerUnmount = () => void; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/public/kibana-plugin-public.overlaystart.banners.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-public](./kibana-plugin-public.md) > [OverlayStart](./kibana-plugin-public.overlaystart.md) > [banners](./kibana-plugin-public.overlaystart.banners.md) | ||
|
||
## OverlayStart.banners property | ||
|
||
[OverlayBannersStart](./kibana-plugin-public.overlaybannersstart.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
banners: OverlayBannersStart; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,3 +8,4 @@ | |
@import '@elastic/eui/src/global_styling/mixins/index'; | ||
|
||
@import './chrome/index'; | ||
@import './overlays/index'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
@import './banners_list'; |
Oops, something went wrong.