The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
GDGT-2024 Consolidate ChartSettingsWidget's `noPadding`, `marginBottom`, and `borderBottom` (#71154)
Kamil Mielnik361549c5af96
diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.styled.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.styled.tsxindex 745418e919a..f7567d4bb16 100644--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.styled.tsx+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.styled.tsx@@ -4,17 +4,11 @@ import { css } from "@emotion/react";import styled from "@emotion/styled";export const Root = styled.div<{- noPadding?: boolean;inline?: boolean;- marginBottom?: string;- borderBottom?: boolean;}>`- ${(props) =>- !props.noPadding &&- css`- margin-left: 2rem;- margin-right: 2rem;- `}+ margin-left: 2rem;+ margin-right: 2rem;+ margin-bottom: 1.5em;${(props) =>props.hidden &&@@ -22,12 +16,6 @@ export const Root = styled.div<{display: none;`}- ${(props) =>- !props.hidden &&- css`- margin-bottom: ${props.marginBottom || "1.5em"};- `}-${(props) =>props.inline &&!props.hidden &&@@ -38,13 +26,6 @@ export const Root = styled.div<{align-items: center;`}- ${(props) =>- props.borderBottom &&- css`- padding-bottom: 1rem;- border-bottom: 1px solid var(--mb-color-border);- `}-input {transition: border 0.3s;diff --git a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsxindex b82a93722fa..609710239f8 100644--- a/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx+++ b/frontend/src/metabase/visualizations/components/ChartSettingsWidget.tsx@@ -1,5 +1,5 @@import cx from "classnames";-import type { ComponentType } from "react";+import type { CSSProperties, ComponentType } from "react";import PopoverS from "metabase/common/components/Popover/Popover.module.css";import FormS from "metabase/css/components/form.module.css";@@ -14,13 +14,11 @@ type Props = {hidden?: boolean;widget?: string | ComponentType<{ id: string }>;inline?: boolean;- marginBottom?: string;props?: Record<string, unknown>;- noPadding?: boolean;variant?: "default" | "form-field";- borderBottom?: boolean;dataTestId?: string;id: string;+ style?: CSSProperties;};const ChartSettingsWidget = ({@@ -30,13 +28,10 @@ const ChartSettingsWidget = ({hidden,variant = "default",inline = false,- marginBottom = undefined,widget: Widget,dataTestId,props,- // disables X padding for certain widgets so divider line extends to edge- noPadding,- borderBottom,+ style,// NOTE: pass along special props to support:// * adding additional fields// * substituting widgets@@ -46,16 +41,14 @@ const ChartSettingsWidget = ({return (<Roothidden={hidden}- noPadding={noPadding}className={cx({[FormS.FormField]: isFormField,[PopoverS.FormField]: isFormField,})}inline={inline}- marginBottom={marginBottom}data-testid={dataTestId ?? `chart-settings-widget-${extraWidgetProps.id}`}data-field-title={title}- borderBottom={borderBottom}+ style={style}>{title && (<Group align="center" gap="xs" mb={inline && !hidden ? 0 : "sm"}>diff --git a/frontend/src/metabase/visualizations/components/ColumnSettings.jsx b/frontend/src/metabase/visualizations/components/ColumnSettings.jsxindex 4d90a2bed19..25fede37ea9 100644--- a/frontend/src/metabase/visualizations/components/ColumnSettings.jsx+++ b/frontend/src/metabase/visualizations/components/ColumnSettings.jsx@@ -82,7 +82,10 @@ export const ColumnSettings = ({key={widget.id}{...widget}unset={storedSettings[widget.id] === undefined}- noPadding+ style={{+ marginLeft: 0,+ marginRight: 0,+ }}variant={variant}/>))diff --git a/frontend/src/metabase/visualizations/lib/settings.ts b/frontend/src/metabase/visualizations/lib/settings.tsindex 9d8a435d54a..2b59963cfec 100644--- a/frontend/src/metabase/visualizations/lib/settings.ts+++ b/frontend/src/metabase/visualizations/lib/settings.ts@@ -195,7 +195,7 @@ function getSettingWidget<T, TValue, TProps extends Record<string, unknown>>(}const getHiddenFn = settingDef.getHidden;- const { getMarginBottom, getProps, ...settingDefProps } = settingDef;+ const { getProps, getWrapperStyle, ...settingDefProps } = settingDef;const section = settingDef.getSection? settingDef.getSection(resolvedObject, computedSettings, extra)@@ -209,7 +209,6 @@ function getSettingWidget<T, TValue, TProps extends Record<string, unknown>>(hidden: getHiddenFn? getHiddenFn(resolvedObject, computedSettings, extra): (settingDef.hidden ?? false),- marginBottom: getMarginBottom?.(resolvedObject, computedSettings, extra),props:getProps?.(resolvedObject,@@ -223,6 +222,7 @@ function getSettingWidget<T, TValue, TProps extends Record<string, unknown>>(typeof settingDef.widget === "string"? WIDGETS[settingDef.widget]: settingDef.widget,+ style: getWrapperStyle?.(resolvedObject, computedSettings, extra),onChange,onChangeSettings, // this gives a widget access to update other settings};diff --git a/frontend/src/metabase/visualizations/lib/settings/goal.ts b/frontend/src/metabase/visualizations/lib/settings/goal.tsindex 3b6495f4920..e6f73096b24 100644--- a/frontend/src/metabase/visualizations/lib/settings/goal.ts+++ b/frontend/src/metabase/visualizations/lib/settings/goal.ts@@ -35,7 +35,9 @@ export const GRAPH_GOAL_SETTINGS: VisualizationSettingsDefinitions = {widget: "toggle",getDefault: () => false,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),},"graph.goal_value": {get section() {diff --git a/frontend/src/metabase/visualizations/lib/settings/graph.ts b/frontend/src/metabase/visualizations/lib/settings/graph.tsindex 845e14ddc39..3ec65edf568 100644--- a/frontend/src/metabase/visualizations/lib/settings/graph.ts+++ b/frontend/src/metabase/visualizations/lib/settings/graph.ts@@ -103,11 +103,13 @@ export const GRAPH_DATA_SETTINGS: VisualizationSettingsDefinitions = {return t`X-axis`;},widget: "fields",- getMarginBottom: (series, vizSettings) =>- vizSettings["graph.dimensions"]?.length === 2 &&- series.length <= MAX_SERIES- ? "0.5rem"- : "1rem",+ getWrapperStyle: (series, vizSettings) => ({+ marginBottom:+ vizSettings["graph.dimensions"]?.length === 2 &&+ series.length <= MAX_SERIES+ ? "0.5rem"+ : "1rem",+ }),isValid: (series, vizSettings) => {const dimensions = vizSettings["graph.dimensions"] ?? [];if (dimensions.length === 0) {@@ -158,8 +160,10 @@ export const GRAPH_DATA_SETTINGS: VisualizationSettingsDefinitions = {return t`Data`;},widget: ChartSettingSeriesOrder,- getMarginBottom: () => "1rem",useRawSeries: true,+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),getValue: (rawSeries, settings) => {const seriesModels = getSeriesModelsForSettings(rawSeries, settings);const seriesKeys = seriesModels.map((s) => s.vizSettingsKey);@@ -386,7 +390,9 @@ export const SPLIT_PANELS_SETTINGS: VisualizationSettingsDefinitions = {widget: "toggle",getDefault: () => false,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),getHidden: (series, settings) => {const displays = series.map((single) => settings.series?.(single).display,@@ -464,7 +470,9 @@ export const GRAPH_TREND_SETTINGS: VisualizationSettingsDefinitions = {},useRawSeries: true,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),},};@@ -480,7 +488,9 @@ export const GRAPH_DISPLAY_VALUES_SETTINGS: VisualizationSettingsDefinitions = {getHidden: (series, vizSettings) => !canHaveDataLabels(series, vizSettings),getDefault: getDefaultShowDataLabels,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),},"graph.label_value_frequency": {get section() {@@ -1095,7 +1105,9 @@ export const BOXPLOT_SETTINGS: VisualizationSettingsDefinitions<widget: "toggle",getDefault: () => false,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),},"boxplot.show_values_mode": {get section() {diff --git a/frontend/src/metabase/visualizations/lib/settings/nested.ts b/frontend/src/metabase/visualizations/lib/settings/nested.tsindex 59b0ae4061b..05830bdeb13 100644--- a/frontend/src/metabase/visualizations/lib/settings/nested.ts+++ b/frontend/src/metabase/visualizations/lib/settings/nested.ts@@ -131,7 +131,15 @@ export function nestedSettings<onChangeSettings,extra,);- return widgets.map((widget) => ({ ...widget, noPadding: true }));++ return widgets.map((widget) => ({+ ...widget,+ style: {+ ...widget.style,+ marginLeft: 0,+ marginRight: 0,+ },+ }));}// decorate with nested settings HOCdiff --git a/frontend/src/metabase/visualizations/lib/settings/series.ts b/frontend/src/metabase/visualizations/lib/settings/series.tsindex 21f9b2700f5..1750b825b89 100644--- a/frontend/src/metabase/visualizations/lib/settings/series.ts+++ b/frontend/src/metabase/visualizations/lib/settings/series.ts@@ -268,7 +268,10 @@ export function seriesSetting({getSettingDefinitionsForObject: () => COMMON_SETTINGS,component: ChartNestedSettingSeries,readDependencies: [SERIES_COLORS_SETTING_KEY, ...readDependencies],- noPadding: true,+ getWrapperStyle: () => ({+ marginLeft: 0,+ marginRight: 0,+ }),getExtraProps: (series) => ({seriesCardNames: series.reduce<Record<string, string>>((memo, singleSeries) => {diff --git a/frontend/src/metabase/visualizations/types/visualization.ts b/frontend/src/metabase/visualizations/types/visualization.tsindex 2391fa7b353..ce9ddffb558 100644--- a/frontend/src/metabase/visualizations/types/visualization.ts+++ b/frontend/src/metabase/visualizations/types/visualization.ts@@ -1,4 +1,4 @@-import type { ComponentType, ReactNode } from "react";+import type { CSSProperties, ComponentType, ReactNode } from "react";import type { OptionsType } from "metabase/lib/formatting/types";import type { IconName, IconProps } from "metabase/ui";@@ -350,17 +350,16 @@ export type VisualizationSettingDefinition<: ComputedVisualizationSettings,extra?: SettingsExtra,) => string;- autoOpenWhenUnset?: boolean;- noPadding?: boolean;- value?: TValue;- set?: boolean;- getMarginBottom?: (+ getWrapperStyle?: (object: T,settings: T extends DatasetColumn? ColumnSettings: ComputedVisualizationSettings,extra?: SettingsExtra,- ) => string;+ ) => CSSProperties | undefined;+ autoOpenWhenUnset?: boolean;+ value?: TValue;+ set?: boolean;persistDefault?: boolean;inline?: boolean;getProps?: (@@ -389,10 +388,10 @@ export type CompleteVisualizationSettingDefinition<TProps extends Record<string, unknown> = Record<string, unknown>,> = Omit<VisualizationSettingDefinition<T, TValue, TProps>,- "getMarginBottom" | "getProps"+ "getProps" | "getWrapperStyle"> & {id: string;- marginBottom?: string;+ style?: CSSProperties;props: Partial<TProps>;};diff --git a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsxindex 8415c1f3b89..03579d5a835 100644--- a/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx+++ b/frontend/src/metabase/visualizations/visualizations/Funnel/Funnel.tsx@@ -92,7 +92,9 @@ Object.assign(Funnel, {dashboard: false,useRawSeries: true,showColumnSetting: true,- getMarginBottom: () => "0.625rem",+ getWrapperStyle: () => ({+ marginBottom: "0.625rem",+ }),}),"funnel.order_dimension": {getValue: (_series: RawSeries, settings: ComputedVisualizationSettings) =>diff --git a/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.tsindex 385b3c09536..c7a4c9e58e6 100644--- a/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/Gauge/chart-definition.ts@@ -87,7 +87,10 @@ export const GAUGE_CHART_DEFINITION: VisualizationDefinition = {},widget: ChartSettingSegmentsEditor,persistDefault: true,- noPadding: true,+ getWrapperStyle: () => ({+ marginLeft: 0,+ marginRight: 0,+ }),},},};diff --git a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.tsindex dc32517d586..f7a37be1ad1 100644--- a/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts+++ b/frontend/src/metabase/visualizations/visualizations/PieChart/chart-definition.ts@@ -151,7 +151,9 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {!extra?.isDashboard || card?.display === "waterfall",getSection: (_series, _settings, extra) =>extra?.isDashboard ? t`Display` : t`Style`,- getMarginBottom: () => "0",+ getWrapperStyle: () => ({+ marginBottom: 0,+ }),getProps: (_series, vizSettings, _onChange, _extra, onChangeSettings) => {const pieRows = vizSettings["pie.rows"];if (pieRows == null) {@@ -197,7 +199,9 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {widget: "toggle",getDefault: getDefaultShowLegend,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),},"pie.show_total": {get section() {@@ -209,7 +213,9 @@ export const PIE_CHART_DEFINITION: VisualizationDefinition = {widget: "toggle",getDefault: getDefaultShowTotal,inline: true,- getMarginBottom: () => "1rem",+ getWrapperStyle: () => ({+ marginBottom: "1rem",+ }),},"pie.show_labels": {get section() {diff --git a/frontend/src/metabase/visualizations/visualizations/PivotTable/settings.ts b/frontend/src/metabase/visualizations/visualizations/PivotTable/settings.tsindex 2afbdfa4bb6..404a67c512c 100644--- a/frontend/src/metabase/visualizations/visualizations/PivotTable/settings.ts+++ b/frontend/src/metabase/visualizations/visualizations/PivotTable/settings.ts@@ -269,7 +269,10 @@ export const _columnSettings = {},widget: ChartSettingIconRadio,inline: true,- borderBottom: true,+ getWrapperStyle: () => ({+ paddingBottom: "1rem",+ borderBottom: `1px solid var(--mb-color-border)`,+ }),getProps: () => ({options: [{diff --git a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsx b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsxindex 43513b3c7f6..459f5eced25 100644--- a/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsx+++ b/frontend/src/metabase/visualizations/visualizations/Scalar/Scalar.tsx@@ -96,7 +96,10 @@ export class Scalar extends Component<},widget: ChartSettingSegmentsEditor,persistDefault: true,- noPadding: true,+ getWrapperStyle: () => ({+ marginLeft: 0,+ marginRight: 0,+ }),getProps: () => ({canRemoveAll: true,}),