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

chore: remove typography selection in app theming #36110

Merged
merged 8 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ export * from "./useSpacing";
export * from "./useTypography";
export * from "./useTheme";
export * from "./useCssTokens";
export * from "./useIconDensity";
export * from "./useIconSizing";
Original file line number Diff line number Diff line change
@@ -1,23 +1,16 @@
import { useEffect, useState } from "react";
import type { IconDensity, TokenObj } from "../../token";
import { useMemo } from "react";
import type { IconDensity } from "../../token";

export const useIconDensity = (density: IconDensity, userDensity = 1) => {
const [strokeWidth, setStrokeWidth] = useState<TokenObj>();

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: In all these hooks, mainly refactored useState + useEffect pattern to useMemo.

Reason: useState + useEffect create 1 extra render.

useEffect(() => {
switch (true) {
case userDensity < 1:
setStrokeWidth(density.tight);
break;
case userDensity === 1:
setStrokeWidth(density.regular);
break;
case userDensity > 1:
setStrokeWidth(density.loose);
break;
default:
setStrokeWidth(density.regular);
break;
const strokeWidth = useMemo(() => {
if (userDensity < 1) {
return density.tight;
} else if (userDensity === 1) {
return density.regular;
} else if (userDensity > 1) {
return density.loose;
} else {
return density.regular;
}
}, [userDensity, density]);

Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,16 @@
import { useEffect, useState } from "react";
import type { IconSizing, TokenObj } from "../../token";
import { useMemo } from "react";
import type { IconSizing } from "../../token";

export const useIconSizing = (sizing: IconSizing, userSizing = 1) => {
const [iconSize, setIconSize] = useState<TokenObj>();

useEffect(() => {
switch (true) {
case userSizing < 1:
setIconSize(sizing.small);
break;
case userSizing === 1:
setIconSize(sizing.regular);
break;
case userSizing > 1:
setIconSize(sizing.big);
break;
default:
setIconSize(sizing.regular);
break;
const iconSize = useMemo(() => {
if (userSizing < 1) {
return sizing.small;
} else if (userSizing === 1) {
return sizing.regular;
} else if (userSizing > 1) {
return sizing.big;
} else {
return sizing.regular;
}
}, [userSizing, sizing]);

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useEffect, useState } from "react";
import { useMemo } from "react";
import { calculateScales } from "./calculateScales";

import type { TokenObj, TokenScaleConfig } from "../../token";
Expand All @@ -8,7 +8,7 @@ export const getSizing = (
userDensity = 1,
userSizing = 1,
count = 200,
) => {
): TokenObj => {
const { userDensityRatio = 1, userSizingRatio = 1, V, ...rest } = sizing;
const ratio = userDensity * userDensityRatio + userSizing * userSizingRatio;

Expand All @@ -35,11 +35,9 @@ export const useSizing = (
userDensity = 1,
userSizing = 1,
) => {
const [sizing, setSizing] = useState<TokenObj>();

useEffect(() => {
setSizing(getSizing(config, userDensity, userSizing));
}, [userDensity, userSizing, config]);
const sizing = useMemo(() => {
return getSizing(config, userDensity, userSizing);
}, [config, userDensity, userSizing]);

return {
sizing,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { useEffect, useState } from "react";
import { useMemo } from "react";
import { calculateScales } from "./calculateScales";

import type { TokenObj, TokenScaleConfig } from "../../token";
import type { TokenScaleConfig } from "../../token";

export const getSpacing = (
spacing: TokenScaleConfig,
Expand Down Expand Up @@ -36,16 +36,13 @@ export const useSpacing = (
userDensity = 1,
userSizing = 1,
) => {
const [outerSpacing, setOuterSpacing] = useState<TokenObj>();
const [innerSpacing, setInnerSpacing] = useState<TokenObj>();
const outerSpacing = useMemo(() => {
return getSpacing(outerSpacingConfig, userDensity, userSizing);
}, [outerSpacingConfig, userDensity, userSizing]);

useEffect(() => {
setOuterSpacing(getSpacing(outerSpacingConfig, userDensity, userSizing));
}, [userDensity, userSizing, outerSpacingConfig]);

useEffect(() => {
setInnerSpacing(getSpacing(innerSpacingConfig, userDensity, userSizing));
}, [userDensity, userSizing, innerSpacingConfig]);
const innerSpacing = useMemo(() => {
return getSpacing(innerSpacingConfig, userDensity, userSizing);
}, [innerSpacingConfig, userDensity, userSizing]);

return {
outerSpacing,
Expand Down
184 changes: 53 additions & 131 deletions app/client/packages/design-system/theming/src/hooks/src/useTheme.tsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
import Color from "colorjs.io";
import { useEffect, useState } from "react";
import { useMemo } from "react";
import { TokensAccessor, defaultTokens, tokensConfigs } from "../../token";
import { useSizing, useSpacing, useTypography } from "./";
import {
useSizing,
useSpacing,
useTypography,
useIconSizing,
useIconDensity,
} from "./";

import type { ColorMode } from "../../color";
import type { TokenSource, FontFamily, IconStyle } from "../../token";
import { useIconDensity } from "./useIconDensity";
import { useIconSizing } from "./useIconSizing";
import type { TokenSource, IconStyle } from "../../token";

const tokensAccessor = new TokensAccessor({
...(defaultTokens as TokenSource),
Expand All @@ -16,7 +20,6 @@ export interface UseThemeProps {
seedColor?: string;
colorMode?: ColorMode;
borderRadius?: string;
fontFamily?: FontFamily;
userDensity?: number;
userSizing?: number;
iconStyle?: IconStyle;
Expand All @@ -26,7 +29,6 @@ export function useTheme(props: UseThemeProps = {}) {
const {
borderRadius,
colorMode = "light",
fontFamily,
iconStyle = "outlined",
seedColor,
userDensity = 1,
Expand All @@ -42,168 +44,88 @@ export function useTheme(props: UseThemeProps = {}) {
);
const { typography } = useTypography(
tokensConfigs.typography,
fontFamily,
userDensity,
userSizing,
);

const { iconSize } = useIconSizing(tokensConfigs.icon.sizing, userSizing);

const { strokeWidth } = useIconDensity(
tokensConfigs.icon.density,
userDensity,
);

const [theme, setTheme] = useState(tokensAccessor.getAllTokens);

useEffect(() => {
if (colorMode) {
tokensAccessor.updateColorMode(colorMode);
const theme = useMemo(() => {
// Color mode
tokensAccessor.updateColorMode(colorMode);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getColors(),
colorMode: tokensAccessor.getColorMode(),
};
});
}
}, [colorMode]);

useEffect(() => {
// Border radius
if (borderRadius != null) {
tokensAccessor.updateBorderRadiusElevation({
...defaultTokens.borderRadiusElevation,
base: borderRadius,
});

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getBorderRadiusElevation(),
};
});
}
}, [borderRadius]);

useEffect(() => {
// Seed color
if (seedColor != null) {
let color;

try {
color = Color.parse(seedColor);
Color.parse(seedColor);
tokensAccessor.updateSeedColor(seedColor);
} catch (error) {
// eslint-disable-next-line no-console
console.error(error);
return; // Prevent further execution if color parsing fails
}

if (color != null) {
tokensAccessor.updateSeedColor(seedColor);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getColors(),
};
});
}
}
}, [seedColor]);

useEffect(() => {
// Check typography, as fontFamily may be undefined
// Typography
if (typography != null) {
tokensAccessor.updateFontFamily(fontFamily);
tokensAccessor.updateTypography(typography);

setTheme((prevState) => {
return {
...prevState,
typography: tokensAccessor.getTypography(),
fontFamily: tokensAccessor.getFontFamily(),
};
});
}
}, [typography, fontFamily]);

useEffect(() => {
if (sizing) {
tokensAccessor.updateSizing(sizing);
// Sizing
tokensAccessor.updateSizing(sizing);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getSizing(),
};
});
}
}, [sizing]);
// Spacing
tokensAccessor.updateOuterSpacing(outerSpacing);
tokensAccessor.updateInnerSpacing(innerSpacing);

useEffect(() => {
if (outerSpacing) {
tokensAccessor.updateOuterSpacing(outerSpacing);
// Icon style
tokensAccessor.updateIconStyle(iconStyle);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getOuterSpacing(),
};
});
}
}, [outerSpacing]);

useEffect(() => {
if (innerSpacing) {
tokensAccessor.updateInnerSpacing(innerSpacing);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getInnerSpacing(),
};
});
}
}, [innerSpacing]);

useEffect(() => {
if (iconStyle) {
tokensAccessor.updateIconStyle(iconStyle);

setTheme((prevState) => {
return {
...prevState,
iconStyle: tokensAccessor.getIconStyle(),
};
});
}
}, [iconStyle]);

useEffect(() => {
// Icon size
if (iconSize != null) {
tokensAccessor.updateIconSize(iconSize);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getIconSize(),
};
});
}
}, [iconSize]);

useEffect(() => {
// Stroke width
if (strokeWidth != null) {
tokensAccessor.updateStrokeWidth(strokeWidth);

setTheme((prevState) => {
return {
...prevState,
...tokensAccessor.getStrokeWidth(),
};
});
}
}, [strokeWidth]);

return { theme, setTheme };
return {
...tokensAccessor.getColors(),
colorMode: tokensAccessor.getColorMode(),
...tokensAccessor.getBorderRadiusElevation(),
typography: tokensAccessor.getTypography(),
fontFamily: tokensAccessor.getFontFamily(),
...tokensAccessor.getSizing(),
...tokensAccessor.getOuterSpacing(),
...tokensAccessor.getInnerSpacing(),
iconStyle: tokensAccessor.getIconStyle(),
...tokensAccessor.getIconSize(),
...tokensAccessor.getStrokeWidth(),
};
}, [
colorMode,
borderRadius,
seedColor,
typography,
sizing,
outerSpacing,
innerSpacing,
iconStyle,
iconSize,
strokeWidth,
]);

return { theme };
}
Loading
Loading