[Vis: Default editor] EUIficate ranges param editor #38531
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,166 @@ | ||
| /* | ||
| * 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, { Fragment, useState, useEffect } from 'react'; | ||
| import { | ||
| htmlIdGenerator, | ||
| EuiButtonIcon, | ||
| EuiFieldNumber, | ||
| EuiFlexItem, | ||
| EuiFlexGroup, | ||
| EuiIcon, | ||
| EuiSpacer, | ||
| EuiButtonEmpty, | ||
| } from '@elastic/eui'; | ||
| import { FormattedMessage } from '@kbn/i18n/react'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import { isEqual, omit } from 'lodash'; | ||
| import { AggParamEditorProps } from 'ui/vis/editors/default'; | ||
|
|
||
| const FROM_PLACEHOLDER = '\u2212\u221E'; | ||
| const TO_PLACEHOLDER = '+\u221E'; | ||
|
|
||
| const generateId = htmlIdGenerator(); | ||
| const isEmpty = (value: any) => value === undefined || value === null; | ||
|
|
||
| interface RangeValues { | ||
| from?: number; | ||
| to?: number; | ||
| } | ||
|
|
||
| interface RangeValuesModel extends RangeValues { | ||
| id: string; | ||
| } | ||
|
|
||
| function RangesParamEditor({ agg, value = [], setValue }: AggParamEditorProps<RangeValues[]>) { | ||
| const [ranges, setRanges] = useState(() => value.map(range => ({ ...range, id: generateId() }))); | ||
|
There was a problem hiding this comment. Not sure you need to use a callback state here, couldn't you write: There was a problem hiding this comment. I think the lazy init is used to prevent an id generation on every render. There was a problem hiding this comment. @flash1293 you are completely right |
||
|
|
||
| // set up an initial range when there is no default range | ||
| useEffect(() => { | ||
| if (!value.length) { | ||
| onAddRange(); | ||
| } | ||
| }, []); | ||
|
|
||
| useEffect( | ||
| () => { | ||
| // responsible for discarding changes | ||
| if ( | ||
| value.length !== ranges.length || | ||
| value.some((range, index) => !isEqual(range, omit(ranges[index], 'id'))) | ||
| ) { | ||
| setRanges(value.map(range => ({ ...range, id: generateId() }))); | ||
| } | ||
| }, | ||
| [value] | ||
| ); | ||
|
|
||
| const updateRanges = (rangeValues: RangeValuesModel[]) => { | ||
| // do not set internal id parameter into saved object | ||
| setValue(rangeValues.map(range => omit(range, 'id'))); | ||
| setRanges(rangeValues); | ||
| }; | ||
| const onAddRange = () => updateRanges([...ranges, { id: generateId() }]); | ||
| const onRemoveRange = (id: string) => updateRanges(ranges.filter(range => range.id !== id)); | ||
| const onChangeRange = (id: string, key: string, newValue: string) => | ||
| updateRanges( | ||
| ranges.map(range => | ||
| range.id === id | ||
| ? { | ||
| ...range, | ||
| [key]: newValue === '' ? undefined : parseFloat(newValue), | ||
| } | ||
| : range | ||
| ) | ||
| ); | ||
|
|
||
| return ( | ||
| <> | ||
| {ranges.map(({ from, to, id }) => { | ||
| const deleteBtnTitle = i18n.translate( | ||
| 'common.ui.aggTypes.ranges.removeRangeButtonAriaLabel', | ||
| { | ||
| defaultMessage: 'Remove the range of {from} to {to}', | ||
| values: { | ||
| from: isEmpty(from) ? FROM_PLACEHOLDER : from, | ||
| to: isEmpty(to) ? TO_PLACEHOLDER : to, | ||
| }, | ||
| } | ||
| ); | ||
|
|
||
| return ( | ||
| <Fragment key={id}> | ||
| <EuiFlexGroup gutterSize="s" alignItems="center"> | ||
| <EuiFlexItem> | ||
| <EuiFieldNumber | ||
| aria-label={i18n.translate('common.ui.aggTypes.ranges.fromLabel', { | ||
| defaultMessage: 'From', | ||
| })} | ||
| value={isEmpty(from) ? '' : from} | ||
| placeholder={FROM_PLACEHOLDER} | ||
| onChange={ev => onChangeRange(id, 'from', ev.target.value)} | ||
| fullWidth={true} | ||
| compressed={true} | ||
| /> | ||
| </EuiFlexItem> | ||
| <EuiFlexItem grow={false}> | ||
| <EuiIcon type="sortRight" color="subdued" /> | ||
| </EuiFlexItem> | ||
| <EuiFlexItem> | ||
| <EuiFieldNumber | ||
| aria-label={i18n.translate('common.ui.aggTypes.ranges.toLabel', { | ||
| defaultMessage: 'To', | ||
| })} | ||
| value={isEmpty(to) ? '' : to} | ||
| placeholder={TO_PLACEHOLDER} | ||
| onChange={ev => onChangeRange(id, 'to', ev.target.value)} | ||
| fullWidth={true} | ||
| compressed={true} | ||
| /> | ||
| </EuiFlexItem> | ||
| <EuiFlexItem grow={false}> | ||
| <EuiButtonIcon | ||
| title={deleteBtnTitle} | ||
| aria-label={deleteBtnTitle} | ||
| disabled={value.length === 1} | ||
| color="danger" | ||
| iconType="trash" | ||
| onClick={() => onRemoveRange(id)} | ||
| /> | ||
| </EuiFlexItem> | ||
| </EuiFlexGroup> | ||
| <EuiSpacer size="xs" /> | ||
| </Fragment> | ||
| ); | ||
| })} | ||
|
|
||
| <EuiSpacer size="s" /> | ||
| <EuiFlexItem> | ||
| <EuiButtonEmpty iconType="plusInCircleFilled" onClick={onAddRange} size="xs"> | ||
| <FormattedMessage | ||
| id="common.ui.aggTypes.ranges.addRangeButtonLabel" | ||
| defaultMessage="Add range" | ||
| /> | ||
| </EuiButtonEmpty> | ||
| </EuiFlexItem> | ||
| </> | ||
| ); | ||
| } | ||
|
|
||
| export { RangesParamEditor }; | ||
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
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.
As long as you're using lodash helpers, why not use the equivalent helper to this?
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.
Not sure which lodash helper you are talking about, but if you mean
isNil- it is only available from the version4.0.0. (currently we are using3.10.1)