Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add global overrides to theme builder #2985

Merged
merged 2 commits into from
Nov 21, 2024
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
7 changes: 5 additions & 2 deletions demo/ts/components/theme-builder/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ const ThemeBuilder = () => {
React.useState<ColorScalePropType>("qualitative");
const [showThemeConfigPreview, setShowThemeConfigPreview] =
React.useState(false);
const [showTooltips, setShowTooltips] = React.useState(true);
const [showTooltips, setShowTooltips] = React.useState(false);

const handleThemeSelect = (themeName: string) => {
const theme = themes.find((t) => t.name === themeName);
Expand All @@ -96,7 +96,10 @@ const ThemeBuilder = () => {
setCustomThemeConfig({ ...theme?.config });
};

const updateCustomThemeConfig = (path: string, newValue: unknown) => {
const updateCustomThemeConfig = (
path: string | string[],
newValue: unknown,
) => {
if (!customThemeConfig) return;
const updatedConfig = setNestedConfigValue(
customThemeConfig,
Expand Down
75 changes: 61 additions & 14 deletions demo/ts/components/theme-builder/options-config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type ThemeBuilderFieldConfig =
| {
type: "slider" | "select" | "colorPicker";
label: string;
path: string;
path: string | string[];
min?: number;
max?: number;
step?: number;
Expand All @@ -48,16 +48,23 @@ type ThemeBuilderOptionsConfig = {

const defaultFill = "#000";

const getPath = (basePath: string | string[], key: string) => {
if (Array.isArray(basePath)) {
return basePath.map((p) => `${p}.${key}`);
}
return `${basePath}.${key}`;
};

const getBaseStrokeConfig = (
basePath: string,
basePath: string | string[],
includedStrokeProps: StrokeProps[] = [],
): ThemeBuilderFieldConfig[] => {
const config = [
{
type: "colorPicker",
label: StrokeProps.STROKE,
default: defaultFill,
path: `${basePath}.stroke`,
path: getPath(basePath, "stroke"),
},
{
type: "slider",
Expand All @@ -66,15 +73,15 @@ const getBaseStrokeConfig = (
max: 5,
unit: "px",
default: 1,
path: `${basePath}.strokeWidth`,
path: getPath(basePath, "strokeWidth"),
},
{
type: "slider",
label: StrokeProps.STROKE_DASH_ARRAY,
min: 0,
max: 10,
default: 0,
path: `${basePath}.strokeDasharray`,
path: getPath(basePath, "strokeDasharray"),
},
{
type: "select",
Expand All @@ -85,7 +92,7 @@ const getBaseStrokeConfig = (
{ label: "Butt", value: "butt" },
],
default: "round",
path: `${basePath}.strokeLinecap`,
path: getPath(basePath, "strokeLinecap"),
},
{
type: "select",
Expand All @@ -96,7 +103,7 @@ const getBaseStrokeConfig = (
{ label: "Miter", value: "miter" },
],
default: "round",
path: `${basePath}.strokeLinejoin`,
path: getPath(basePath, "strokeLinejoin"),
},
] as ThemeBuilderFieldConfig[];
return includedStrokeProps.length
Expand All @@ -106,16 +113,16 @@ const getBaseStrokeConfig = (
: config;
};

const getBaseLabelsConfig: (basePath: string) => ThemeBuilderFieldConfig[] = (
basePath: string,
) => [
const getBaseLabelsConfig = (
basePath: string | string[],
): ThemeBuilderFieldConfig[] => [
{
type: "slider",
label: "Font Size",
min: 10,
max: 24,
unit: "px",
path: `${basePath}.fontSize`,
path: getPath(basePath, "fontSize"),
default: 12,
},
{
Expand All @@ -124,13 +131,13 @@ const getBaseLabelsConfig: (basePath: string) => ThemeBuilderFieldConfig[] = (
min: 0,
max: 50,
unit: "px",
path: `${basePath}.padding`,
path: getPath(basePath, "padding"),
default: 8,
},
{
type: "colorPicker",
label: "Fill",
path: `${basePath}.fill`,
path: getPath(basePath, "fill"),
default: defaultFill,
},
];
Expand All @@ -146,6 +153,47 @@ const optionsConfig: ThemeBuilderOptionsConfig = [
},
],
},
{
type: "section",
title: "Global Settings",
fields: [
{
type: "section",
label: "Labels",
fields: getBaseLabelsConfig([
"axis.style.axisLabel",
"polarAxis.style.tickLabels",
"polarDependentAxis.style.tickLabels",
"tooltip.style",
"area.style.labels",
"bar.style.labels",
"candlestick.style.labels",
"errorbar.style.labels",
"histogram.style.labels",
"legend.style.labels",
"line.style.labels",
"pie.style.labels",
"scatter.style.labels",
"voronoi.style.labels",
]),
},
{
type: "section",
label: "Data",
fields: getBaseStrokeConfig([
"area.style.data",
"bar.style.data",
"candlestick.style.data",
"errorbar.style.data",
"histogram.style.data",
"line.style.data",
"pie.style.data",
"scatter.style.data",
"voronoi.style.data",
]),
},
],
},
{
type: "section",
title: "Axis",
Expand Down Expand Up @@ -890,7 +938,6 @@ const optionsConfig: ThemeBuilderOptionsConfig = [
},
],
},
// tooltip
{
type: "section",
title: "Tooltip",
Expand Down
31 changes: 18 additions & 13 deletions demo/ts/components/theme-builder/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,35 @@ import { VictoryThemeDefinition } from "victory-core";

export const setNestedConfigValue = (
config: VictoryThemeDefinition,
path: string,
paths: string | string[],
value: unknown,
) => {
const pathArray = path.split(".");
const updatedConfig = { ...config };
pathArray.reduce((acc, key, i) => {
if (i === pathArray.length - 1) {
acc[key] = value;
} else {
acc[key] = { ...acc[key] };
}
return acc[key];
}, updatedConfig);
const pathsArray = Array.isArray(paths) ? paths : [paths];

pathsArray.forEach((path) => {
const pathArray = path.split(".");
pathArray.reduce((acc, key, i) => {
if (i === pathArray.length - 1) {
acc[key] = value;
} else {
acc[key] = { ...acc[key] };
}
return acc[key];
}, updatedConfig);
});

return updatedConfig;
};

export const getConfigValue = (
config: VictoryThemeDefinition,
path: string,
path: string | string[],
defaultValue?: unknown,
) => {
if (!path) return undefined;
const pathArray = path.split(".");
const pathString = Array.isArray(path) ? path[0] : path;
if (!pathString) return undefined;
const pathArray = pathString.split(".");
return pathArray.reduce((acc, key) => {
return acc && acc[key] ? acc[key] : defaultValue || undefined;
}, config);
Expand Down
Loading