forked from getredash/redash
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate Parameters component to React (getredash#4006)
* Start Parameters Migration * Add dirtyCount * Use workaround with setState * Apply Changes * Add EditSettingsDialog * Add Cmd/Ctrl + Enter behavior * Remove isApplying * Delete Angular version of parameters * Update tests * Remove angular stuff * Update jest * Drag placeholder * Update events * Use old button styling and move css * Reviewing code * Add parameter rearrange test * Add Parameter Settings title change test * Update Parameter Settings button styling * Move parameter url logic back to Parameters * Disable url update when query is new * Styling changes (getredash#4019) * Ran's title width styling * Update drag test * Improve sizing for Number inputs Co-Authored-By: Ran Byron <ranbena@gmail.com> * Fix issue with dragged parameter wrapping Co-Authored-By: Ran Byron <ranbena@gmail.com> * Don't reevaluate dirtyParamCount * Allow multiple values :) * Fix parameter alignments * Fix Select width on search * Update client/app/components/Parameters.less Co-Authored-By: Ran Byron <ranbena@gmail.com> * Humanize param.name * Make sure angular updates Execute disabled status
- Loading branch information
1 parent
192bc18
commit bc21f8c
Showing
18 changed files
with
519 additions
and
279 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
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 |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| import React from 'react'; | ||
| import PropTypes from 'prop-types'; | ||
| import { size, filter, forEach, extend } from 'lodash'; | ||
| import { react2angular } from 'react2angular'; | ||
| import { sortableContainer, sortableElement, sortableHandle } from 'react-sortable-hoc'; | ||
| import { $location } from '@/services/ng'; | ||
| import { Parameter } from '@/services/query'; | ||
| import ParameterApplyButton from '@/components/ParameterApplyButton'; | ||
| import ParameterValueInput from '@/components/ParameterValueInput'; | ||
| import EditParameterSettingsDialog from './EditParameterSettingsDialog'; | ||
| import { toHuman } from '@/filters'; | ||
|
|
||
| import './Parameters.less'; | ||
|
|
||
| const DragHandle = sortableHandle(({ parameterName }) => ( | ||
| <div className="drag-handle" data-test={`DragHandle-${parameterName}`} /> | ||
| )); | ||
|
|
||
| const SortableItem = sortableElement(({ className, parameterName, disabled, children }) => ( | ||
| <div className={className} data-editable={!disabled || null}> | ||
| {!disabled && <DragHandle parameterName={parameterName} />} | ||
| {children} | ||
| </div> | ||
| )); | ||
| const SortableContainer = sortableContainer(({ children }) => children); | ||
|
|
||
| function updateUrl(parameters) { | ||
| const params = extend({}, $location.search()); | ||
| parameters.forEach((param) => { | ||
| extend(params, param.toUrlParams()); | ||
| }); | ||
| Object.keys(params).forEach(key => params[key] == null && delete params[key]); | ||
| $location.search(params); | ||
| } | ||
|
|
||
| export class Parameters extends React.Component { | ||
| static propTypes = { | ||
| parameters: PropTypes.arrayOf(PropTypes.instanceOf(Parameter)), | ||
| editable: PropTypes.bool, | ||
| disableUrlUpdate: PropTypes.bool, | ||
| onValuesChange: PropTypes.func, | ||
| onPendingValuesChange: PropTypes.func, | ||
| onParametersEdit: PropTypes.func, | ||
| }; | ||
|
|
||
| static defaultProps = { | ||
| parameters: [], | ||
| editable: false, | ||
| disableUrlUpdate: false, | ||
| onValuesChange: () => {}, | ||
| onPendingValuesChange: () => {}, | ||
| onParametersEdit: () => {}, | ||
| } | ||
|
|
||
| constructor(props) { | ||
| super(props); | ||
| const { parameters } = props; | ||
| this.state = { parameters, dragging: false }; | ||
| if (!props.disableUrlUpdate) { | ||
| updateUrl(parameters); | ||
| } | ||
| } | ||
|
|
||
| componentDidUpdate = (prevProps) => { | ||
| const { parameters, disableUrlUpdate } = this.props; | ||
| if (prevProps.parameters !== parameters) { | ||
| this.setState({ parameters }); | ||
| if (!disableUrlUpdate) { | ||
| updateUrl(parameters); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| handleKeyDown = (e) => { | ||
| // Cmd/Ctrl/Alt + Enter | ||
| if (e.keyCode === 13 && (e.ctrlKey || e.metaKey || e.altKey)) { | ||
| e.stopPropagation(); | ||
| this.applyChanges(); | ||
| } | ||
| }; | ||
|
|
||
| setPendingValue = (param, value, isDirty) => { | ||
| const { onPendingValuesChange } = this.props; | ||
| this.setState(({ parameters }) => { | ||
| if (isDirty) { | ||
| param.setPendingValue(value); | ||
| } else { | ||
| param.clearPendingValue(); | ||
| } | ||
| onPendingValuesChange(); | ||
| return { parameters }; | ||
| }); | ||
| }; | ||
|
|
||
| moveParameter = ({ oldIndex, newIndex }) => { | ||
| const { onParametersEdit } = this.props; | ||
| if (oldIndex !== newIndex) { | ||
| this.setState(({ parameters }) => { | ||
| parameters.splice(newIndex, 0, parameters.splice(oldIndex, 1)[0]); | ||
| onParametersEdit(); | ||
| return { parameters }; | ||
| }); | ||
| } | ||
| this.setState({ dragging: false }); | ||
| }; | ||
|
|
||
| onBeforeSortStart = () => { | ||
| this.setState({ dragging: true }); | ||
| }; | ||
|
|
||
| applyChanges = () => { | ||
| const { onValuesChange, disableUrlUpdate } = this.props; | ||
| this.setState(({ parameters }) => { | ||
| forEach(parameters, p => p.applyPendingValue()); | ||
| onValuesChange(); | ||
| if (!disableUrlUpdate) { | ||
| updateUrl(parameters); | ||
| } | ||
| return { parameters }; | ||
| }); | ||
| }; | ||
|
|
||
| showParameterSettings = (parameter, index) => { | ||
| const { onParametersEdit } = this.props; | ||
| EditParameterSettingsDialog | ||
| .showModal({ parameter }) | ||
| .result.then((updated) => { | ||
| this.setState(({ parameters }) => { | ||
| const updatedParameter = extend(parameter, updated); | ||
| parameters[index] = new Parameter(updatedParameter, updatedParameter.parentQueryId); | ||
| onParametersEdit(); | ||
| return { parameters }; | ||
| }); | ||
| }); | ||
| }; | ||
|
|
||
| renderParameter(param, index) { | ||
| const { editable } = this.props; | ||
| return ( | ||
| <div | ||
| key={param.name} | ||
| className="di-block" | ||
| data-test={`ParameterName-${param.name}`} | ||
| > | ||
| <div className="parameter-heading"> | ||
| <label>{param.title || toHuman(param.name)}</label> | ||
| {editable && ( | ||
| <button | ||
| className="btn btn-default btn-xs m-l-5" | ||
| onClick={() => this.showParameterSettings(param, index)} | ||
| data-test={`ParameterSettings-${param.name}`} | ||
| type="button" | ||
| > | ||
| <i className="fa fa-cog" /> | ||
| </button> | ||
| )} | ||
| </div> | ||
| <ParameterValueInput | ||
| type={param.type} | ||
| value={param.normalizedValue} | ||
| parameter={param} | ||
| enumOptions={param.enumOptions} | ||
| queryId={param.queryId} | ||
| allowMultipleValues={!!param.multiValuesOptions} | ||
| onSelect={(value, isDirty) => this.setPendingValue(param, value, isDirty)} | ||
| /> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| render() { | ||
| const { parameters, dragging } = this.state; | ||
| const { editable } = this.props; | ||
| const dirtyParamCount = size(filter(parameters, 'hasPendingValue')); | ||
| return ( | ||
| <SortableContainer | ||
| axis="xy" | ||
| useDragHandle | ||
| lockToContainerEdges | ||
| helperClass="parameter-dragged" | ||
| updateBeforeSortStart={this.onBeforeSortStart} | ||
| onSortEnd={this.moveParameter} | ||
| > | ||
| <div | ||
| className="parameter-container" | ||
| onKeyDown={dirtyParamCount ? this.handleKeyDown : null} | ||
| data-draggable={editable || null} | ||
| data-dragging={dragging || null} | ||
| > | ||
| {parameters.map((param, index) => ( | ||
| <SortableItem className="parameter-block" key={param.name} index={index} parameterName={param.name} disabled={!editable}> | ||
| {this.renderParameter(param, index)} | ||
| </SortableItem> | ||
| ))} | ||
|
|
||
| <ParameterApplyButton onClick={this.applyChanges} paramCount={dirtyParamCount} /> | ||
| </div> | ||
| </SortableContainer> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| export default function init(ngModule) { | ||
| ngModule.component('parameters', react2angular(Parameters)); | ||
| } | ||
|
|
||
| init.init = true; |
Oops, something went wrong.