[Lens] Add "no data" popover #69147
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
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,95 @@ | ||
| /* | ||
| * 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 { mountWithIntl as mount } from 'test_utils/enzyme_helpers'; | ||
| import { NoDataPopover } from './no_data_popover'; | ||
| import { EuiTourStep } from '@elastic/eui'; | ||
| import { act } from 'react-dom/test-utils'; | ||
|
|
||
| describe('NoDataPopover', () => { | ||
| const createMockStorage = () => ({ | ||
| get: jest.fn(), | ||
| set: jest.fn(), | ||
| remove: jest.fn(), | ||
| clear: jest.fn(), | ||
| }); | ||
|
|
||
| it('should hide popover if showNoDataPopover is set to false', () => { | ||
| const Child = () => <span />; | ||
| const instance = mount( | ||
| <NoDataPopover storage={createMockStorage()} showNoDataPopover={false}> | ||
| <Child /> | ||
| </NoDataPopover> | ||
| ); | ||
| expect(instance.find(EuiTourStep).prop('isStepOpen')).toBe(false); | ||
| expect(instance.find(EuiTourStep).find(Child)).toHaveLength(1); | ||
| }); | ||
|
|
||
| it('should hide popover if showNoDataPopover is set to true, but local storage flag is set', () => { | ||
| const child = <span />; | ||
| const storage = createMockStorage(); | ||
| storage.get.mockReturnValue(true); | ||
| const instance = mount( | ||
| <NoDataPopover storage={storage} showNoDataPopover={false}> | ||
| {child} | ||
| </NoDataPopover> | ||
| ); | ||
| expect(instance.find(EuiTourStep).prop('isStepOpen')).toBe(false); | ||
| }); | ||
|
|
||
| it('should render popover if showNoDataPopover is set to true and local storage flag is not set', () => { | ||
| const child = <span />; | ||
| const instance = mount( | ||
| <NoDataPopover storage={createMockStorage()} showNoDataPopover={true}> | ||
| {child} | ||
| </NoDataPopover> | ||
| ); | ||
| expect(instance.find(EuiTourStep).prop('isStepOpen')).toBe(true); | ||
| }); | ||
|
|
||
| it('should hide popover if it is closed', async () => { | ||
| const props = { | ||
| children: <span />, | ||
| showNoDataPopover: true, | ||
| storage: createMockStorage(), | ||
| }; | ||
| const instance = mount(<NoDataPopover {...props} />); | ||
| act(() => { | ||
| instance.find(EuiTourStep).prop('closePopover')!(); | ||
| }); | ||
| instance.setProps({ ...props }); | ||
| expect(instance.find(EuiTourStep).prop('isStepOpen')).toBe(false); | ||
| }); | ||
|
|
||
| it('should set local storage flag and hide on closing with button', () => { | ||
| const props = { | ||
| children: <span />, | ||
| showNoDataPopover: true, | ||
| storage: createMockStorage(), | ||
| }; | ||
| const instance = mount(<NoDataPopover {...props} />); | ||
| act(() => { | ||
| instance.find(EuiTourStep).prop('footerAction')!.props.onClick(); | ||
| }); | ||
| instance.setProps({ ...props }); | ||
| expect(props.storage.set).toHaveBeenCalledWith(expect.any(String), true); | ||
| expect(instance.find(EuiTourStep).prop('isStepOpen')).toBe(false); | ||
| }); | ||
| }); |
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,96 @@ | ||
| /* | ||
| * 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 { ReactElement, useEffect, useState } from 'react'; | ||
| import React from 'react'; | ||
| import { EuiButtonEmpty, EuiText, EuiTourStep } from '@elastic/eui'; | ||
| import { IStorageWrapper } from 'src/plugins/kibana_utils/public'; | ||
| import { i18n } from '@kbn/i18n'; | ||
|
|
||
| const NO_DATA_POPOVER_STORAGE_KEY = 'data.noDataPopover'; | ||
|
|
||
| export function NoDataPopover({ | ||
| showNoDataPopover, | ||
| storage, | ||
| children, | ||
| }: { | ||
| showNoDataPopover?: boolean; | ||
| storage: IStorageWrapper; | ||
| children: ReactElement; | ||
| }) { | ||
| const [noDataPopoverDismissed, setNoDataPopoverDismissed] = useState(() => | ||
| Boolean(storage.get(NO_DATA_POPOVER_STORAGE_KEY)) | ||
| ); | ||
| const [noDataPopoverVisible, setNoDataPopoverVisible] = useState(false); | ||
|
|
||
| useEffect(() => { | ||
| if (showNoDataPopover && !noDataPopoverDismissed) { | ||
| setNoDataPopoverVisible(true); | ||
| } | ||
| }, [noDataPopoverDismissed, showNoDataPopover]); | ||
|
|
||
| return ( | ||
| <EuiTourStep | ||
| onFinish={() => {}} | ||
| closePopover={() => { | ||
| setNoDataPopoverVisible(false); | ||
| }} | ||
| content={ | ||
| <EuiText size="s"> | ||
| <p style={{ maxWidth: 300 }}> | ||
| {i18n.translate('data.noDataPopover.content', { | ||
| defaultMessage: | ||
| "This time range doesn't contain any data. Increase or adjust the time range to see more fields and create charts", | ||
| })} | ||
| </p> | ||
| </EuiText> | ||
| } | ||
| minWidth={300} | ||
| anchorPosition="downCenter" | ||
| step={1} | ||
| stepsTotal={1} | ||
| isStepOpen={noDataPopoverVisible} | ||
| subtitle={i18n.translate('data.noDataPopover.title', { defaultMessage: 'Tip' })} | ||
| title="" | ||
| footerAction={ | ||
| <EuiButtonEmpty | ||
| size="s" | ||
| data-test-subj="noDataPopoverDismissButton" | ||
| onClick={() => { | ||
| storage.set(NO_DATA_POPOVER_STORAGE_KEY, true); | ||
| setNoDataPopoverDismissed(true); | ||
| setNoDataPopoverVisible(false); | ||
| }} | ||
| > | ||
| {i18n.translate('data.noDataPopover.dismissAction', { | ||
| defaultMessage: "Don't show again", | ||
| })} | ||
| </EuiButtonEmpty> | ||
| } | ||
| > | ||
| <div | ||
| onFocus={() => { | ||
| setNoDataPopoverVisible(false); | ||
| }} | ||
| > | ||
| {children} | ||
| </div> | ||
| </EuiTourStep> | ||
| ); | ||
| } | ||
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@flash1293 Minor nit, can you change/add these props: