Skip to content

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

Fix list-view violations (#74877)

Fraser116c9343a470
diff --git a/frontend/src/metabase/list-view/components/ListView/index.ts b/frontend/src/metabase/list-view/components/ListView/index.ts
deleted file mode 100644
index 0f3fbf417a2..00000000000
--- a/frontend/src/metabase/list-view/components/ListView/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./ListView";
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index 0e8939932b5..2ec34d97cac 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -53,12 +53,6 @@ import { setUIControls } from "metabase/redux/query-builder";
import type { DatasetEditorTab, QueryBuilderMode } from "metabase/redux/store";
import { getMetadata } from "metabase/selectors/metadata";
import { Box, Flex, Icon, Tooltip } from "metabase/ui";
-import {
- extractRemappings,
- getVisualizationTransformed,
-} from "metabase/visualizations";
-import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";
-import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
@@ -72,7 +66,6 @@ import type {
Field,
RawSeries,
ResultsMetadata,
- Series,
VisualizationDisplay,
VisualizationSettings,
} from "metabase-types/api";
@@ -85,6 +78,10 @@ import {
import { DatasetFieldMetadataSidebar } from "./DatasetFieldMetadataSidebar";
import { DatasetQueryEditor } from "./DatasetQueryEditor";
import { EditorTabs } from "./EditorTabs";
+import {
+ ListViewConfigurationPanel,
+ getComputedVisualizationSettings,
+} from "./ListViewConfigurationPanel";
import { EDITOR_TAB_INDEXES } from "./constants";
type MetadataDiff = Record<string, Partial<Field>>;
@@ -284,18 +281,6 @@ function getTempRawSeries(
] as RawSeries;
}
-function getComputedVisualizationSettings(
- series: Series | null,
-): ComputedVisualizationSettings | null {
- if (series == null) {
- return series;
- }
-
- return getComputedSettingsForSeries(
- getVisualizationTransformed(extractRemappings(series)).series,
- ) as ComputedVisualizationSettings;
-}
-
const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
const {
question,
@@ -357,6 +342,11 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
);
}, [rawSeries, datasetEditorTab, question]);
+ const isShowingListViewConfig =
+ isShowingListViewConfiguration &&
+ question.display() === "list" &&
+ rawSeries?.[0]?.data != null;
+
const isDirty = isModelQueryDirty || isMetadataDirty;
const { data: modelIndexes } = useListModelIndexesQuery(
@@ -748,21 +738,34 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
})}
>
<DebouncedFrame className={cx(CS.flexFull)} enabled>
- <QueryVisualization
- {...props}
- rawSeries={tempRawSeries}
- className={CS.spread}
- noHeader
- queryBuilderMode="dataset"
- onHeaderColumnReorder={handleHeaderColumnReorder}
- isShowingDetailsOnlyColumns={datasetEditorTab !== "metadata"}
- hasMetadataPopovers={false}
- handleVisualizationClick={handleTableElementClick}
- tableHeaderHeight={isEditingColumns && TABLE_HEADER_HEIGHT}
- renderTableHeader={renderTableHeader}
- scrollToColumn={focusedFieldIndex + scrollToColumnModifier}
- renderEmptyMessage={isEditingColumns}
- />
+ {/**
+ * The list view configuration UI replaces the table preview while the user arranges list columns,
+ * (toggled from the "Metadata" tab sidebar). It's rendered here, and not inside the List visualization itself,
+ * because configuring the list updates the question being edited,
+ * and the visualizationsmodule can't depend on query_builder state/actions.
+ */}
+ {isShowingListViewConfig ? (
+ <ListViewConfigurationPanel
+ question={question}
+ rawSeries={rawSeries}
+ />
+ ) : (
+ <QueryVisualization
+ {...props}
+ rawSeries={tempRawSeries}
+ className={CS.spread}
+ noHeader
+ queryBuilderMode="dataset"
+ onHeaderColumnReorder={handleHeaderColumnReorder}
+ isShowingDetailsOnlyColumns={datasetEditorTab !== "metadata"}
+ hasMetadataPopovers={false}
+ handleVisualizationClick={handleTableElementClick}
+ tableHeaderHeight={isEditingColumns && TABLE_HEADER_HEIGHT}
+ renderTableHeader={renderTableHeader}
+ scrollToColumn={focusedFieldIndex + scrollToColumnModifier}
+ renderEmptyMessage={isEditingColumns}
+ />
+ )}
</DebouncedFrame>
</Box>
</Flex>
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/ListViewColumnsSidebar.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/ListViewColumnsSidebar.tsx
index f4a554826ab..8f5a9782810 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/ListViewColumnsSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorSettingsSidebar/ListViewColumnsSidebar.tsx
@@ -1,7 +1,6 @@
import { useMemo, useState } from "react";
import { t } from "ttag";
-import { useListColumns } from "metabase/list-view/components/ListView";
import {
Button,
type FlexProps,
@@ -13,6 +12,7 @@ import {
} from "metabase/ui";
import { ColumnItem } from "metabase/visualizations/components/settings/ColumnItem";
import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import { useListColumns } from "metabase/visualizations/visualizations/List/components/ListView";
import type { DatasetColumn } from "metabase-types/api";
import styles from "./ListViewColumnsSidebar.module.css";
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/ListViewConfigurationPanel.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/ListViewConfigurationPanel.tsx
new file mode 100644
index 00000000000..2f95bb34651
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/ListViewConfigurationPanel.tsx
@@ -0,0 +1,120 @@
+import { useCallback, useMemo } from "react";
+
+import { updateQuestion as updateQuestionAction } from "metabase/query_builder/actions";
+import { useDispatch } from "metabase/redux";
+import {
+ extractRemappings,
+ getVisualizationTransformed,
+} from "metabase/visualizations";
+import { getComputedSettingsForSeries } from "metabase/visualizations/lib/settings/visualization";
+import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
+import { ListViewConfiguration } from "metabase/visualizations/visualizations/List/components/ListView";
+import * as Lib from "metabase-lib";
+import type Question from "metabase-lib/v1/Question";
+import type { IconName, RawSeries, Series } from "metabase-types/api";
+
+export function getComputedVisualizationSettings(
+ series: Series | null,
+): ComputedVisualizationSettings | null {
+ if (series == null) {
+ return series;
+ }
+
+ return getComputedSettingsForSeries(
+ getVisualizationTransformed(extractRemappings(series)).series,
+ ) as ComputedVisualizationSettings;
+}
+
+type ListViewConfigurationPanelProps = {
+ question: Question;
+ rawSeries: RawSeries | null;
+};
+
+/**
+ * Renders the list view column configuration UI in place of the dataset
+ * editor's table preview while the user is arranging list columns.
+ */
+export const ListViewConfigurationPanel = ({
+ question,
+ rawSeries,
+}: ListViewConfigurationPanelProps) => {
+ const dispatch = useDispatch();
+
+ const data = rawSeries?.[0]?.data;
+
+ const settings = useMemo(
+ () => getComputedVisualizationSettings(rawSeries) ?? undefined,
+ [rawSeries],
+ );
+
+ const columnsMetadata = useMemo(() => {
+ if (!data) {
+ return [];
+ }
+ const query = question.query();
+ return data.cols.map((col) => Lib.fromLegacyColumn(query, -1, col));
+ }, [data, question]);
+
+ const entityType = useMemo(() => {
+ try {
+ const query = question.query();
+ const sourceTableId = Lib.sourceTableOrCardId(query);
+ const table = question.metadata().table(sourceTableId);
+ // entity_type exists in the database but not in the TypeScript types
+ return (table as any)?.entity_type;
+ } catch {
+ return undefined;
+ }
+ }, [question]);
+
+ const handleChange = useCallback(
+ ({
+ left,
+ right,
+ entityIcon,
+ entityIconColor,
+ entityIconEnabled,
+ useImageColumn,
+ }: {
+ left?: string[];
+ right?: string[];
+ entityIcon?: IconName | null;
+ entityIconColor?: string;
+ entityIconEnabled?: boolean;
+ useImageColumn?: boolean;
+ }) => {
+ const settings = { ...(question.settings() || {}) };
+ if (left && right) {
+ settings["list.columns"] = { left, right };
+ }
+ if (entityIcon !== undefined) {
+ settings["list.entity_icon"] = entityIcon;
+ }
+ if (entityIconColor !== undefined) {
+ settings["list.entity_icon_color"] = entityIconColor;
+ }
+ if (entityIconEnabled !== undefined) {
+ settings["list.entity_icon_enabled"] = entityIconEnabled;
+ }
+ if (useImageColumn !== undefined) {
+ settings["list.use_image_column"] = useImageColumn;
+ }
+ dispatch(updateQuestionAction(question.updateSettings(settings)));
+ },
+ [question, dispatch],
+ );
+
+ if (!data) {
+ return null;
+ }
+
+ return (
+ <ListViewConfiguration
+ data={data}
+ settings={settings}
+ columnsMetadata={columnsMetadata}
+ entityType={entityType}
+ onChange={handleChange}
+ />
+ );
+};
diff --git a/frontend/src/metabase/visualizations/register.js b/frontend/src/metabase/visualizations/register.js
index dd8f02c8a8f..e7077054985 100644
--- a/frontend/src/metabase/visualizations/register.js
+++ b/frontend/src/metabase/visualizations/register.js
@@ -1,4 +1,3 @@
-import { ListViz } from "metabase/list-view/components/ListViz";
import {
registerVisualization,
setDefaultVisualization,
@@ -11,6 +10,7 @@ import { ComboChart } from "./visualizations/ComboChart";
import { Funnel } from "./visualizations/Funnel";
import { Gauge } from "./visualizations/Gauge";
import { LineChart } from "./visualizations/LineChart";
+import { ListViz } from "./visualizations/List/components/ListViz";
import { Map } from "./visualizations/Map";
import { ObjectDetail } from "./visualizations/ObjectDetail";
import { PieChart } from "./visualizations/PieChart";
diff --git a/frontend/src/metabase/list-view/components/ListView/ColumnValue.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/ColumnValue.tsx
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/ColumnValue.tsx
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/ColumnValue.tsx
diff --git a/frontend/src/metabase/list-view/components/ListView/ListView.module.css b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListView.module.css
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/ListView.module.css
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListView.module.css
diff --git a/frontend/src/metabase/list-view/components/ListView/ListView.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListView.tsx
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/ListView.tsx
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListView.tsx
diff --git a/frontend/src/metabase/list-view/components/ListView/ListViewConfiguration.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListViewConfiguration.tsx
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/ListViewConfiguration.tsx
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListViewConfiguration.tsx
diff --git a/frontend/src/metabase/list-view/components/ListView/ListViewItem.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListViewItem.tsx
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/ListViewItem.tsx
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListViewItem.tsx
diff --git a/frontend/src/metabase/list-view/components/ListView/ListViewItem.unit.spec.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListViewItem.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/ListViewItem.unit.spec.tsx
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/ListViewItem.unit.spec.tsx
diff --git a/frontend/src/metabase/visualizations/visualizations/List/components/ListView/index.ts b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/index.ts
new file mode 100644
index 00000000000..f26ab6ea0cf
--- /dev/null
+++ b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/index.ts
@@ -0,0 +1,2 @@
+export * from "./ListView";
+export * from "./ListViewConfiguration";
diff --git a/frontend/src/metabase/list-view/components/ListView/styling.ts b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/styling.ts
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/styling.ts
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/styling.ts
diff --git a/frontend/src/metabase/list-view/components/ListView/use-external-drag-overlay.ts b/frontend/src/metabase/visualizations/visualizations/List/components/ListView/use-external-drag-overlay.ts
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListView/use-external-drag-overlay.ts
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListView/use-external-drag-overlay.ts
diff --git a/frontend/src/metabase/list-view/components/ListViz/ListViz.module.css b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.module.css
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListViz/ListViz.module.css
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.module.css
diff --git a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
similarity index 76%
rename from frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
index d3150df80e8..694e296fc2d 100644
--- a/frontend/src/metabase/list-view/components/ListViz/ListViz.tsx
+++ b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/ListViz.tsx
@@ -2,12 +2,6 @@ import cx from "classnames";
import { useMemo } from "react";
import { t } from "ttag";
-import { updateQuestion } from "metabase/query_builder/actions";
-import {
- getIsListViewConfigurationShown,
- getQuestion,
-} from "metabase/query_builder/selectors";
-import { useDispatch, useSelector } from "metabase/redux";
import { Box } from "metabase/ui";
import { color } from "metabase/ui/utils/colors";
import { displayNameForColumn } from "metabase/utils/formatting";
@@ -25,6 +19,7 @@ import type {
VisualizationProps,
} from "metabase/visualizations/types";
import * as Lib from "metabase-lib";
+import Question from "metabase-lib/v1/Question";
import {
isAvatarURL,
isCoordinate,
@@ -34,10 +29,9 @@ import {
isString,
isURL,
} from "metabase-lib/v1/types/utils/isa";
-import type { DatasetColumn, IconName, Series } from "metabase-types/api";
+import type { DatasetColumn, Series } from "metabase-types/api";
import { ListView } from "../ListView/ListView";
-import { ListViewConfiguration } from "../ListView/ListViewConfiguration";
import S from "./ListViz.module.css";
@@ -259,6 +253,8 @@ const vizDefinition: VisualizationDefinition = {
};
export const ListViz = ({
+ card,
+ metadata,
data,
settings,
onVisualizationClick,
@@ -266,11 +262,13 @@ export const ListViz = ({
isDashboard,
onZoomRow,
}: VisualizationProps & VisualizationPassThroughProps) => {
- const dispatch = useDispatch();
- const question = useSelector(getQuestion);
- const isShowingListViewConfiguration = useSelector(
- getIsListViewConfigurationShown,
- );
+ const question = useMemo(() => {
+ if (!card || !metadata) {
+ return null;
+ }
+ return new Question(card, metadata);
+ }, [card, metadata]);
+
const { sortedColumnName, sortingDirection } = useMemo(() => {
if (!question) {
return {};
@@ -287,15 +285,6 @@ export const ListViz = ({
return {};
}, [question]);
- const columnsMetadata = useMemo(() => {
- if (!question) {
- return [];
- }
- const query = question.query();
- return data.cols.map((col) => Lib.fromLegacyColumn(query, -1, col));
- }, [data, question]);
-
- // Get the entity type from the question's source table
const entityType = useMemo(() => {
if (!question) {
return undefined;
@@ -304,8 +293,7 @@ export const ListViz = ({
try {
const query = question.query();
const sourceTableId = Lib.sourceTableOrCardId(query);
- const metadata = question.metadata();
- const table = metadata.table(sourceTableId);
+ const table = question.metadata().table(sourceTableId);
// Return the entity type if available, otherwise undefined
// Use type assertion since entity_type exists in the database but not in TypeScript types
@@ -320,46 +308,6 @@ export const ListViz = ({
const handleSort = (column: DatasetColumn) => {
onVisualizationClick({ column });
};
- const updateListSettings = ({
- left,
- right,
- entityIcon,
- entityIconColor,
- entityIconEnabled,
- useImageColumn,
- }: {
- left?: string[];
- right?: string[];
- entityIcon?: IconName | null;
- entityIconColor?: string;
- entityIconEnabled?: boolean;
- useImageColumn?: boolean;
- }) => {
- const settings = { ...(question?.settings() || {}) };
- if (left && right) {
- settings["list.columns"] = {
- left,
- right,
- };
- }
- if (entityIcon !== undefined) {
- settings["list.entity_icon"] = entityIcon;
- }
- if (entityIconColor !== undefined) {
- settings["list.entity_icon_color"] = entityIconColor;
- }
- if (entityIconEnabled !== undefined) {
- settings["list.entity_icon_enabled"] = entityIconEnabled;
- }
- if (useImageColumn !== undefined) {
- settings["list.use_image_column"] = useImageColumn;
- }
-
- const nextQuestion = question?.updateSettings(settings);
- if (nextQuestion) {
- dispatch(updateQuestion(nextQuestion));
- }
- };
return (
<Box
@@ -369,27 +317,17 @@ export const ListViz = ({
[S.listViewDashcard]: isDashboard,
})}
>
- {isShowingListViewConfiguration ? (
- <ListViewConfiguration
- data={data}
- settings={settings}
- onChange={updateListSettings}
- entityType={entityType}
- columnsMetadata={columnsMetadata}
- />
- ) : (
- <ListView
- className={isDashboard ? S.dashboardListView : undefined}
- data={data}
- settings={settings}
- sortedColumnName={sortedColumnName}
- sortingDirection={sortingDirection}
- onSortClick={handleSort}
- entityType={entityType}
- isInteractive={queryBuilderMode !== "dataset"}
- onZoomRow={onZoomRow}
- />
- )}
+ <ListView
+ className={isDashboard ? S.dashboardListView : undefined}
+ data={data}
+ settings={settings}
+ sortedColumnName={sortedColumnName}
+ sortingDirection={sortingDirection}
+ onSortClick={handleSort}
+ entityType={entityType}
+ isInteractive={queryBuilderMode !== "dataset"}
+ onZoomRow={onZoomRow}
+ />
</Box>
);
};
diff --git a/frontend/src/metabase/list-view/components/ListViz/index.ts b/frontend/src/metabase/visualizations/visualizations/List/components/ListViz/index.ts
similarity index 100%
rename from frontend/src/metabase/list-view/components/ListViz/index.ts
rename to frontend/src/metabase/visualizations/visualizations/List/components/ListViz/index.ts