Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ export const timeComparisonControls: ({
'difference between the main time series and each time shift; ' +
'as the percentage change; or as the ratio between series and time shifts.',
),
visibility: () => Boolean(showCalculationType),
hidden: () => Boolean(showCalculationType),
},
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,9 @@ export interface BaseControlConfig<
props: ControlPanelsContainerProps,
controlData: AnyDict,
) => boolean;
hidden?:
| boolean
| ((props: ControlPanelsContainerProps, controlData: AnyDict) => boolean);
}

export interface ControlValueValidator<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,60 @@ describe('ControlPanelsContainer', () => {
'percent_metrics',
);
});

test('hidden state of controls is correctly applied', async () => {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

getChartControlPanelRegistry().registerValue('table', {
controlPanelSections: [
{
label: t('Time Comparison'),
expanded: true,
controlSetRows: [
[
{
name: 'time_compare',
config: {
type: 'SelectControl',
freeForm: true,
label: t('Time shift'),
choices: [],
},
},
],
[
{
name: 'start_date_offset',
config: {
type: 'SelectControl',
choices: [],
label: t('Shift start date'),
hidden: true,
},
},
],
[
{
name: 'comparison_type',
config: {
type: 'SelectControl',
label: t('Calculation type'),
default: 'values',
choices: [],
hidden: () => true,
},
},
],
],
},
],
});
render(<ControlPanelsContainer {...getDefaultProps()} />, {
useRedux: true,
});

expect(screen.getByText('Time shift')).toBeInTheDocument();
expect(screen.getByText('Shift start date')).toBeInTheDocument();
expect(screen.getByText('Calculation type')).toBeInTheDocument();
expect(screen.getByText('Shift start date')).not.toBeVisible();
expect(screen.getByText('Calculation type')).not.toBeVisible();
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -448,13 +448,13 @@ export const ControlPanelsContainer = (props: ControlPanelsContainerProps) => {

const renderControl = ({ name, config }: CustomControlItem) => {
const { controls, chart, exploreState } = props;
const { visibility } = config;
const { visibility, hidden, ...restConfig } = config;

// If the control item is not an object, we have to look up the control data from
// the centralized controls file.
// When it is an object we read control data straight from `config` instead
const controlData = {
...config,
...restConfig,
...controls[name],
...(shouldRecalculateControlState({ name, config })
? config?.mapStateToProps?.(exploreState, controls[name], chart)
Expand All @@ -476,6 +476,11 @@ export const ControlPanelsContainer = (props: ControlPanelsContainerProps) => {
? visibility.call(config, props, controlData)
: undefined;

const isHidden =
typeof hidden === 'function'
? hidden.call(config, props, controlData)
: hidden;

const label =
typeof baseLabel === 'function'
? baseLabel(exploreState, controls[name], chart)
Expand Down Expand Up @@ -536,6 +541,7 @@ export const ControlPanelsContainer = (props: ControlPanelsContainerProps) => {
validationErrors={validationErrors}
actions={props.actions}
isVisible={isVisible}
hidden={isHidden}
{...restProps}
/>
</StashFormDataContainer>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ import { DndItemType } from '../DndItemType';
import { DndItemValue } from './types';
import { DropzoneContext } from '../ExploreContainer';

interface DatasourceControl extends ControlConfig {
interface DatasourceControl extends Omit<ControlConfig, 'hidden'> {
datasource?: IDatasource;
}
export interface IDatasource {
Expand Down Expand Up @@ -389,6 +389,7 @@ export default function DataSourcePanel({
formData={formData}
/>
)}
{/* @ts-ignore */}
<Control {...datasourceControl} name="datasource" actions={actions} />
{datasource.id != null && mainBody}
</DatasourceContainer>
Expand Down