Skip to content

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

update copy and styling of table variable select (#71101)

Jakub Chodorowicz4c4c049ac826
diff --git a/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.module.css b/frontend/src/metabase/common/components/LabelWithInfo/LabelWithInfo.module.css
similarity index 86%
rename from frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.module.css
rename to frontend/src/metabase/common/components/LabelWithInfo/LabelWithInfo.module.css
index 25cc55d4e1c..b14831e89a8 100644
--- a/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.module.css
+++ b/frontend/src/metabase/common/components/LabelWithInfo/LabelWithInfo.module.css
@@ -1,4 +1,4 @@
-.SettingRequiredLabel {
+.LabelWithInfo {
display: flex;
align-items: center;
gap: 0.5rem;
diff --git a/frontend/src/metabase/common/components/LabelWithInfo/LabelWithInfo.tsx b/frontend/src/metabase/common/components/LabelWithInfo/LabelWithInfo.tsx
new file mode 100644
index 00000000000..401679f63c3
--- /dev/null
+++ b/frontend/src/metabase/common/components/LabelWithInfo/LabelWithInfo.tsx
@@ -0,0 +1,31 @@
+import type { ReactNode } from "react";
+
+import { HoverCard, Icon, Stack } from "metabase/ui";
+
+import S from "./LabelWithInfo.module.css";
+
+type LabelWithInfoProps = {
+ label: ReactNode;
+ info?: ReactNode;
+ htmlFor?: string;
+};
+
+export function LabelWithInfo({ label, info, htmlFor }: LabelWithInfoProps) {
+ return (
+ <label className={S.LabelWithInfo} htmlFor={htmlFor}>
+ {label}
+ {info && (
+ <HoverCard shadow="xs">
+ <HoverCard.Target>
+ <Icon name="info" />
+ </HoverCard.Target>
+ <HoverCard.Dropdown maw="24rem">
+ <Stack p="md" gap="sm">
+ {info}
+ </Stack>
+ </HoverCard.Dropdown>
+ </HoverCard>
+ )}
+ </label>
+ );
+}
diff --git a/frontend/src/metabase/common/components/LabelWithInfo/index.ts b/frontend/src/metabase/common/components/LabelWithInfo/index.ts
new file mode 100644
index 00000000000..26a9c97a4ca
--- /dev/null
+++ b/frontend/src/metabase/common/components/LabelWithInfo/index.ts
@@ -0,0 +1 @@
+export { LabelWithInfo } from "./LabelWithInfo";
diff --git a/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx b/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx
index b3f434ff197..8449e296b0b 100644
--- a/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx
+++ b/frontend/src/metabase/parameters/components/RequiredParamToggle/RequiredParamToggle.tsx
@@ -1,8 +1,7 @@
import { t } from "ttag";
-import { Flex, HoverCard, Icon, Stack, Switch, Text } from "metabase/ui";
-
-import S from "./RequiredParamToggle.module.css";
+import { LabelWithInfo } from "metabase/common/components/LabelWithInfo";
+import { Flex, Switch, Text } from "metabase/ui";
interface RequiredParamToggleProps {
disabled?: boolean;
@@ -33,21 +32,11 @@ export function RequiredParamToggle(props: RequiredParamToggleProps) {
onChange={(event) => onChange(event.currentTarget.checked)}
/>
<div>
- <label className={S.SettingRequiredLabel} htmlFor={id}>
- {t`Always require a value`}
- {disabled && (
- <HoverCard position="top-end" shadow="xs">
- <HoverCard.Target>
- <Icon name="info" />
- </HoverCard.Target>
- <HoverCard.Dropdown w={320}>
- <Stack p="md" gap="sm">
- {disabledTooltip}
- </Stack>
- </HoverCard.Dropdown>
- </HoverCard>
- )}
- </label>
+ <LabelWithInfo
+ label={t`Always require a value`}
+ info={disabled ? disabledTooltip : undefined}
+ htmlFor={id}
+ />
{parametersAreUserVisible && (
<Text
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx
index 2ec1c3909a0..7e4fb7a332e 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx
@@ -164,11 +164,11 @@ describe("TagEditorParam", () => {
});
expect(
- screen.getByRole("switch", { name: /emit table alias/i }),
+ screen.getByRole("switch", { name: /use variable name as alias/i }),
).toBeChecked();
await userEvent.click(
- screen.getByRole("switch", { name: /emit table alias/i }),
+ screen.getByRole("switch", { name: /use variable name as alias/i }),
);
expect(setTemplateTag).toHaveBeenLastCalledWith(
expect.objectContaining({
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
index 7b700f4fc80..b716ac04af1 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
@@ -1,7 +1,9 @@
+import { useId } from "react";
import { t } from "ttag";
+import { LabelWithInfo } from "metabase/common/components/LabelWithInfo";
import { SchemaAndTableDataSelector } from "metabase/query_builder/components/DataSelector";
-import { Group, HoverCard, Icon, Switch, Text } from "metabase/ui";
+import { Group, Switch } from "metabase/ui";
import type Database from "metabase-lib/v1/metadata/Database";
import type { TableId, TemplateTag } from "metabase-types/api";
@@ -24,6 +26,7 @@ export function TableMappingSelect({
}: TableMappingSelectProps) {
const tableId = tag["table-id"];
const isEmpty = tableId == null;
+ const id = useId();
return (
<>
@@ -46,27 +49,17 @@ export function TableMappingSelect({
/>
</InputContainer>
<InputContainer>
- <Group gap="xs">
+ <Group gap="sm">
<Switch
- id={`emit-alias-toggle-${tag.id}`}
- label={t`Emit table alias`}
+ id={id}
checked={tag["emit-alias"] ?? true}
onChange={(e) => onChangeEmitAlias(e.currentTarget.checked)}
/>
- <HoverCard>
- <HoverCard.Target>
- <Icon
- c="text-secondary"
- name="info"
- data-testid="emit-alias-info-icon"
- />
- </HoverCard.Target>
- <HoverCard.Dropdown>
- <Text p="md" maw="24rem">
- {t`When enabled, the table reference will include an alias matching the variable name.`}
- </Text>
- </HoverCard.Dropdown>
- </HoverCard>
+ <LabelWithInfo
+ label={t`Use variable name as alias`}
+ info={t`You can refer to this table by the variable name in other parts of the query.`}
+ htmlFor={id}
+ />
</Group>
</InputContainer>
</>