-
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.
Add pluggable panel action tests (#20163)
* Add pluggable panel action tests * address code review comments * update inspector snapshot * remove temp declared ts module now that eui has EuiFlyout typings * address code comments
- Loading branch information
1 parent
0078e66
commit bed72f2
Showing
15 changed files
with
609 additions
and
398 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
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,115 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
|
|
||
| import { EuiFlyout } from '@elastic/eui'; | ||
| import { EventEmitter } from 'events'; | ||
| import ReactDOM from 'react-dom'; | ||
|
|
||
| let activeSession: FlyoutSession | null = null; | ||
|
|
||
| const CONTAINER_ID = 'flyout-container'; | ||
|
|
||
| function getOrCreateContainerElement() { | ||
| let container = document.getElementById(CONTAINER_ID); | ||
| if (!container) { | ||
| container = document.createElement('div'); | ||
| container.id = CONTAINER_ID; | ||
| document.body.appendChild(container); | ||
| } | ||
| return container; | ||
| } | ||
|
|
||
| /** | ||
| * A FlyoutSession describes the session of one opened flyout panel. It offers | ||
| * methods to close the flyout panel again. If you open a flyout panel you should make | ||
| * sure you call {@link FlyoutSession#close} when it should be closed. | ||
| * Since a flyout could also be closed without calling this method (e.g. because | ||
| * the user closes it), you must listen to the "closed" event on this instance. | ||
| * It will be emitted whenever the flyout will be closed and you should throw | ||
| * away your reference to this instance whenever you receive that event. | ||
| * @extends EventEmitter | ||
| */ | ||
| class FlyoutSession extends EventEmitter { | ||
| /** | ||
| * Binds the current flyout session to an Angular scope, meaning this flyout | ||
| * session will be closed as soon as the Angular scope gets destroyed. | ||
| * @param {object} scope - An angular scope object to bind to. | ||
| */ | ||
| public bindToAngularScope(scope: ng.IScope): void { | ||
| const removeWatch = scope.$on('$destroy', () => this.close()); | ||
| this.on('closed', () => removeWatch()); | ||
| } | ||
|
|
||
| /** | ||
| * Closes the opened flyout as long as it's still the open one. | ||
| * If this is not the active session anymore, this method won't do anything. | ||
| * If this session was still active and a flyout was closed, the 'closed' | ||
| * event will be emitted on this FlyoutSession instance. | ||
| */ | ||
| public close(): void { | ||
| if (activeSession === this) { | ||
| const container = document.getElementById(CONTAINER_ID); | ||
| if (container) { | ||
| ReactDOM.unmountComponentAtNode(container); | ||
| this.emit('closed'); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Opens a flyout panel with the given component inside. You can use | ||
| * {@link FlyoutSession#close} on the return value to close the flyout. | ||
| * | ||
| * @param flyoutChildren - Mounts the children inside a fly out panel | ||
| * @return {FlyoutSession} The session instance for the opened flyout panel. | ||
| */ | ||
| export function openFlyout( | ||
| flyoutChildren: React.ReactNode, | ||
| flyoutProps: { | ||
| onClose?: () => void; | ||
| 'data-test-subj'?: string; | ||
| } = {} | ||
| ): FlyoutSession { | ||
| // If there is an active inspector session close it before opening a new one. | ||
| if (activeSession) { | ||
| activeSession.close(); | ||
| } | ||
| const container = getOrCreateContainerElement(); | ||
| const session = (activeSession = new FlyoutSession()); | ||
| const onClose = () => { | ||
| if (flyoutProps.onClose) { | ||
| flyoutProps.onClose(); | ||
| } | ||
| session.close(); | ||
| }; | ||
|
|
||
| ReactDOM.render( | ||
| <EuiFlyout {...flyoutProps} onClose={onClose}> | ||
| {flyoutChildren} | ||
| </EuiFlyout>, | ||
| container | ||
| ); | ||
|
|
||
| return session; | ||
| } | ||
|
|
||
| export { FlyoutSession }; |
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,20 @@ | ||
| /* | ||
| * Licensed to Elasticsearch B.V. under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch B.V. licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| export * from './flyout_session'; |
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
Oops, something went wrong.