Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Polish transform template tag frontend (#70095)

Romeo Van Snick7d8f3849bf6b
diff --git a/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
index 3e1dc1f72da..db73da94899 100644
--- a/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
@@ -148,6 +148,8 @@ describe("scenarios > admin > transforms", () => {
.icon("close")
.click();
+ assertNoParameterSettingsAreVisible();
+
editorSidebar()
.findByText("Always require a value")
.scrollIntoView()
@@ -156,9 +158,7 @@ describe("scenarios > admin > transforms", () => {
queryEditor().button("Save").should("be.disabled");
- editorSidebar()
- .findByText(/Default filter widget value/)
- .scrollIntoView();
+ editorSidebar().findByText("Default value").scrollIntoView();
setDefaultValue();
queryEditor().button("Save").should("be.enabled").click();
@@ -189,6 +189,8 @@ describe("scenarios > admin > transforms", () => {
H.popover().findByText("Animals").click();
H.popover().findByText("Score").click();
+ assertNoParameterSettingsAreVisible();
+
editorSidebar()
.findByText("Always require a value")
.scrollIntoView()
@@ -233,6 +235,8 @@ describe("scenarios > admin > transforms", () => {
H.popover().findByText("Schema a").click();
H.popover().findByText("Animals").click();
+ assertNoParameterSettingsAreVisible();
+
queryEditor().button("Save").should("be.enabled").click();
H.undoToast()
.should("have.text", "Transform query updated")
@@ -364,3 +368,15 @@ function assertIsTransformRunnable() {
function getRunButton(options: { timeout?: number } = {}) {
return cy.findAllByTestId("run-button").eq(0, options);
}
+
+function assertNoParameterSettingsAreVisible() {
+ editorSidebar().within(() => {
+ cy.findByText("How should users filter on this variable?").should(
+ "not.exist",
+ );
+ cy.findByText("People can pick").should("not.exist");
+ cy.findByText("Time grouping options").should("not.exist");
+ cy.findByText("Parameter widget label").should("not.exist");
+ cy.findByText("Filter widget label").should("not.exist");
+ });
+}
diff --git a/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx b/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx
index 37585b223fd..b3f434ff197 100644
--- a/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx
+++ b/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx
@@ -10,10 +10,18 @@ interface RequiredParamToggleProps {
value: boolean;
onChange: (value: boolean) => void;
disabledTooltip: React.ReactNode;
+ parametersAreUserVisible?: boolean;
}
export function RequiredParamToggle(props: RequiredParamToggleProps) {
- const { disabled, value, onChange, uniqueId, disabledTooltip } = props;
+ const {
+ disabled,
+ value,
+ onChange,
+ uniqueId,
+ disabledTooltip,
+ parametersAreUserVisible = true,
+ } = props;
const id = `required_param_toggle_${uniqueId}`;
return (
@@ -41,10 +49,12 @@ export function RequiredParamToggle(props: RequiredParamToggleProps) {
)}
</label>
- <Text
- mt="sm"
- lh={1.2}
- >{t`When enabled, people can change the value or reset it, but can't clear it entirely.`}</Text>
+ {parametersAreUserVisible && (
+ <Text
+ mt="sm"
+ lh={1.2}
+ >{t`When enabled, people can change the value or reset it, but can't clear it entirely.`}</Text>
+ )}
</div>
</Flex>
);
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
index e230aa7b036..b3b177ca333 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
@@ -84,6 +84,7 @@ interface OwnProps {
config: ParameterValuesConfig,
) => void;
setParameterValue: (tagId: TemplateTagId, value: RowValue) => void;
+ parametersAreUserVisible?: boolean;
}
function mapStateToProps(state: State) {
@@ -253,7 +254,7 @@ class TagEditorParamInner extends Component<
});
};
- setParameterAttribute(attr: keyof TemplateTag, val: any) {
+ setTemplateTagAttribute(attr: keyof TemplateTag, val: any) {
// only register an update if the value actually changes
if (this.props.tag[attr] !== val) {
this.props.setTemplateTag({
@@ -331,6 +332,7 @@ class TagEditorParamInner extends Component<
parameter,
embeddedParameterVisibility,
setTemplateTagConfig,
+ parametersAreUserVisible = true,
} = this.props;
const isDimension = tag.type === "dimension";
@@ -385,16 +387,17 @@ class TagEditorParamInner extends Component<
/>
)}
- {((!isDimension && !isTable) || widgetOptions.length > 0) && (
- <FilterWidgetLabelInput
- tag={tag}
- onChange={(value) =>
- this.setParameterAttribute("display-name", value)
- }
- />
- )}
+ {parametersAreUserVisible &&
+ ((!isDimension && !isTable) || widgetOptions.length > 0) && (
+ <FilterWidgetLabelInput
+ tag={tag}
+ onChange={(value) =>
+ this.setTemplateTagAttribute("display-name", value)
+ }
+ />
+ )}
- {parameter && isTemporalUnit && (
+ {parametersAreUserVisible && parameter && isTemporalUnit && (
<>
<ContainerLabel>{t`Time grouping options`}</ContainerLabel>
<Box mb="xl">
@@ -410,7 +413,7 @@ class TagEditorParamInner extends Component<
!newTemporalUnits.includes(tag.default as TemporalUnit)
) {
// reset value as it's not on the new list of available options
- this.setParameterAttribute("default", null);
+ this.setTemplateTagAttribute("default", null);
this.props.setParameterValue(tag.id, null);
}
}
@@ -420,26 +423,30 @@ class TagEditorParamInner extends Component<
</>
)}
- {parameter && canUseCustomSource(parameter) && (
- <InputContainer>
- <ContainerLabel>{t`How should users filter on this variable?`}</ContainerLabel>
- <ValuesSourceSettings
+ {parametersAreUserVisible &&
+ parameter &&
+ canUseCustomSource(parameter) && (
+ <InputContainer>
+ <ContainerLabel>{t`How should users filter on this variable?`}</ContainerLabel>
+ <ValuesSourceSettings
+ parameter={parameter}
+ onChangeQueryType={this.setQueryType}
+ onChangeSourceSettings={this.setSourceSettings}
+ />
+ </InputContainer>
+ )}
+
+ {parametersAreUserVisible &&
+ parameter &&
+ isSingleOrMultiSelectable(parameter) && (
+ <ParameterMultiSelectInput
+ tag={tag}
parameter={parameter}
- onChangeQueryType={this.setQueryType}
- onChangeSourceSettings={this.setSourceSettings}
+ onChangeMultiSelect={(isMultiSelect) =>
+ setTemplateTagConfig(tag, { isMultiSelect })
+ }
/>
- </InputContainer>
- )}
-
- {parameter && isSingleOrMultiSelectable(parameter) && (
- <ParameterMultiSelectInput
- tag={tag}
- parameter={parameter}
- onChangeMultiSelect={(isMultiSelect) =>
- setTemplateTagConfig(tag, { isMultiSelect })
- }
- />
- )}
+ )}
{parameter && (
<DefaultRequiredValueControl
@@ -447,10 +454,11 @@ class TagEditorParamInner extends Component<
parameter={parameter}
isEmbeddedDisabled={embeddedParameterVisibility === "disabled"}
onChangeDefaultValue={(value) => {
- this.setParameterAttribute("default", value);
+ this.setTemplateTagAttribute("default", value);
this.props.setParameterValue(tag.id, value);
}}
onChangeRequired={this.setRequired}
+ parametersAreUserVisible={parametersAreUserVisible}
/>
)}
</Box>
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx
index 6e3cadd3b37..8acdd11ca07 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx
@@ -16,12 +16,14 @@ export function DefaultRequiredValueControl({
tag,
parameter,
isEmbeddedDisabled,
+ parametersAreUserVisible = true,
onChangeDefaultValue,
onChangeRequired,
}: {
tag: TemplateTag;
parameter: Parameter;
isEmbeddedDisabled: boolean;
+ parametersAreUserVisible?: boolean;
onChangeDefaultValue: (value: any) => void;
onChangeRequired: (value: boolean) => void;
}) {
@@ -38,24 +40,22 @@ export function DefaultRequiredValueControl({
return (
<div>
<ContainerLabel id={`default-value-label-${tag.id}`}>
- {getLabel(tag)}
+ {getLabel(tag, parametersAreUserVisible)}
{isMissing && <ErrorSpan> ({t`required`})</ErrorSpan>}
</ContainerLabel>
<Flex gap="xs" direction="column">
- {parameter && (
- <div aria-labelledby={`default-value-label-${tag.id}`}>
- <DefaultParameterValueWidget
- parameter={parameterWithoutDefault}
- value={tag.default}
- setValue={onChangeDefaultValue}
- isEditing
- commitImmediately
- mimicMantine
- placeholder={placeholder}
- />
- </div>
- )}
+ <div aria-labelledby={`default-value-label-${tag.id}`}>
+ <DefaultParameterValueWidget
+ parameter={parameterWithoutDefault}
+ value={tag.default}
+ setValue={onChangeDefaultValue}
+ isEditing
+ commitImmediately
+ mimicMantine
+ placeholder={placeholder}
+ />
+ </div>
<RequiredParamToggle
uniqueId={tag.id}
@@ -80,14 +80,18 @@ export function DefaultRequiredValueControl({
</Text>
</>
}
+ parametersAreUserVisible={parametersAreUserVisible}
/>
</Flex>
</div>
);
}
-function getLabel(tag: TemplateTag) {
- return tag.type === "temporal-unit"
- ? t`Default parameter widget value`
- : t`Default filter widget value`;
+function getLabel(tag: TemplateTag, parametersAreUserVisible: boolean) {
+ if (parametersAreUserVisible) {
+ return tag.type === "temporal-unit"
+ ? t`Default parameter widget value`
+ : t`Default filter widget value`;
+ }
+ return t`Default value`;
}
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx
index 1c2dc2c5627..7b5c6b3ee32 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx
@@ -42,6 +42,7 @@ interface TagEditorSidebarProps {
setParameterValue: (tagId: TemplateTagId, value: RowValue) => void;
onClose: () => void;
getEmbeddedParameterVisibility: GetEmbeddedParamVisibility;
+ parametersAreUserVisible?: boolean;
}
export function TagEditorSidebar({
@@ -55,6 +56,7 @@ export function TagEditorSidebar({
setParameterValue,
onClose,
getEmbeddedParameterVisibility,
+ parametersAreUserVisible = true,
}: TagEditorSidebarProps) {
const [section, setSection] = useState<TabId>(() => {
const tags = query.variableTemplateTags();
@@ -94,6 +96,7 @@ export function TagEditorSidebar({
setTemplateTagConfig={setTemplateTagConfig}
setParameterValue={setParameterValue}
getEmbeddedParameterVisibility={getEmbeddedParameterVisibility}
+ parametersAreUserVisible={parametersAreUserVisible}
/>
) : (
<Box p="lg">
@@ -122,6 +125,7 @@ interface SettingsPaneProps {
) => void;
setParameterValue: (tagId: TemplateTagId, value: RowValue) => void;
getEmbeddedParameterVisibility: GetEmbeddedParamVisibility;
+ parametersAreUserVisible?: boolean;
}
const SettingsPane = ({
@@ -133,6 +137,7 @@ const SettingsPane = ({
setTemplateTagConfig,
setParameterValue,
getEmbeddedParameterVisibility,
+ parametersAreUserVisible = true,
}: SettingsPaneProps) => {
return tags.map((tag) => (
<div key={tag.id}>
@@ -150,6 +155,7 @@ const SettingsPane = ({
setTemplateTag={setTemplateTag}
setTemplateTagConfig={setTemplateTagConfig}
setParameterValue={setParameterValue}
+ parametersAreUserVisible={parametersAreUserVisible}
/>
</div>
));
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
index b590a0ec28f..99321bdc87a 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
@@ -30,6 +30,7 @@ type NativeQuerySidebarProps = {
onOpenSnippetModalWithSelectedText: () => void;
parameterValues: Record<string, RowValue>;
setParameterValues: (newParameterValues: Record<string, RowValue>) => void;
+ parametersAreUserVisible?: boolean;
};
export function NativeQuerySidebar({
@@ -127,6 +128,7 @@ function TemplateTagsSidebar({
onToggleTemplateTagsSidebar,
setParameterValues,
parameterValues,
+ parametersAreUserVisible,
onChangeQuery,
}: NativeQuerySidebarProps) {
const sampleDatabaseId = useSelector(getSampleDatabaseId);
@@ -157,6 +159,7 @@ function TemplateTagsSidebar({
onChangeQuery(newQuestion.query());
}}
getEmbeddedParameterVisibility={VISIBILITY_ALWAYS_ENABLED}
+ parametersAreUserVisible={parametersAreUserVisible}
/>
);
}
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
index 485a3102a02..be88a8c6992 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
@@ -33,6 +33,7 @@ type QueryEditorProps = {
topBarInnerContent?: ReactNode;
height?: string | number;
extraEditorButton?: ReactNode;
+ parametersAreUserVisible?: boolean;
};
export function QueryEditor({
@@ -49,6 +50,7 @@ export function QueryEditor({
topBarInnerContent,
height = "100%",
extraEditorButton,
+ parametersAreUserVisible = true,
}: QueryEditorProps) {
const {
question,
@@ -182,6 +184,7 @@ export function QueryEditor({
openSnippetModalWithSelectedText
}
onChangeQuery={onChangeQuery}
+ parametersAreUserVisible={parametersAreUserVisible}
/>
)}
{!isNative && uiState.sidebarType === "native-query" && (
diff --git a/frontend/src/metabase/transforms/components/TransformEditor/TransformEditor.tsx b/frontend/src/metabase/transforms/components/TransformEditor/TransformEditor.tsx
index d7c4ce5b8fe..b5f5ea1a389 100644
--- a/frontend/src/metabase/transforms/components/TransformEditor/TransformEditor.tsx
+++ b/frontend/src/metabase/transforms/components/TransformEditor/TransformEditor.tsx
@@ -113,6 +113,7 @@ export function TransformEditor({
/>
))
}
+ parametersAreUserVisible={false}
/>
);
}