Skip to content

feat(clerk-js): Add colorShadow variable option #6290

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

Open
wants to merge 4 commits into
base: alexcarpenter/user-2202-add-clerk-css-variable-utilities-for-current-variables
Choose a base branch
from
Open
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
4 changes: 3 additions & 1 deletion packages/clerk-js/src/ui/customizables/parseAppearance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
createFontSizeScale,
createFontWeightScale,
createRadiiUnits,
createShadowsUnits,
createSpaceScale,
} from './parseVariables';

Expand Down Expand Up @@ -144,5 +145,6 @@ const createInternalThemeFromVariables = (theme: Theme | undefined): DeepPartial
const fontSizes = { ...createFontSizeScale(theme) };
const fontWeights = { ...createFontWeightScale(theme) };
const fonts = { ...createFonts(theme) };
return createInternalTheme({ colors, radii, space, fontSizes, fontWeights, fonts } as any);
const shadows = { ...createShadowsUnits(theme) };
return createInternalTheme({ colors, radii, space, fontSizes, fontWeights, fonts, shadows } as any);
};
19 changes: 19 additions & 0 deletions packages/clerk-js/src/ui/customizables/parseVariables.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ import { spaceScaleKeys } from '../foundations/sizes';
import type { fontWeights } from '../foundations/typography';
import { colors } from '../utils/colors';
import { colorOptionToThemedAlphaScale, colorOptionToThemedLightnessScale } from '../utils/colors/scales';
import { createAlphaColorMixString } from '../utils/colors/utils';
import { cssSupports } from '../utils/cssSupports';
import { fromEntries } from '../utils/fromEntries';
import { removeUndefinedProps } from '../utils/removeUndefinedProps';
import { createShadowSet, generateShadow } from '../foundations/shadows';

export const createColorScales = (theme: Theme) => {
const variables = removeInvalidValues(theme.variables || {});
Expand Down Expand Up @@ -181,3 +183,20 @@ export const createFonts = (theme: Theme) => {
const { fontFamily, fontFamilyButtons } = theme.variables || {};
return removeUndefinedProps({ main: fontFamily, buttons: fontFamilyButtons });
};

export const createShadowsUnits = (theme: Theme) => {
const { colorShadow } = theme.variables || {};
if (!colorShadow) {
return;
}

const shadowColor = colors.toHslaString(colorShadow);
if (!shadowColor) {
return;
}

return createShadowSet(
shadowColor,
generateShadow((color, alpha) => createAlphaColorMixString(color, alpha * 100)),
);
};
64 changes: 46 additions & 18 deletions packages/clerk-js/src/ui/foundations/shadows.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,46 @@
export const shadows = Object.freeze({
menuShadow: '0px 5px 15px 0px rgba(0, 0, 0, 0.08), 0px 15px 35px -5px rgba(25, 28, 33, 0.20)',
fabShadow: '0px 12px 24px rgba(0, 0, 0, 0.32)',
buttonShadow:
'0px 1px 1px 0px rgba(255, 255, 255, 0.07) inset, 0px 2px 3px 0px rgba(34, 42, 53, 0.20), 0px 1px 1px 0px rgba(0, 0, 0, 0.24)',
cardBoxShadow: '0px 5px 15px 0px rgba(0, 0, 0, 0.08), 0px 15px 35px -5px rgba(25, 28, 33, 0.20)',
cardContentShadow: '0px 0px 2px 0px rgba(0, 0, 0, 0.08), 0px 1px 2px 0px rgba(25, 28, 33, 0.06)',
actionCardShadow: '0px 1px 4px 0px rgba(0, 0, 0, 0.12), 0px 4px 8px 0px rgba(106, 115, 133, 0.12)',
outlineButtonShadow: '0px 2px 3px -1px rgba(0, 0, 0, 0.08), 0px 1px 0px 0px rgba(0, 0, 0, 0.02)',
input: '0px 0px 1px 0px {{color}}',
focusRing: '0px 0px 0px 4px {{color}}',
badge: '0px 2px 0px -1px rgba(0, 0, 0, 0.04)',
tableBodyShadow:
'0px 0px 2px 0px rgba(0, 0, 0, 0.08), 0px 1px 2px 0px rgba(25, 28, 33, 0.12), 0px 0px 0px 1px rgba(0, 0, 0, 0.06)',
segmentedControl: '0px 1px 2px 0px rgba(0, 0, 0, 0.08)',
switchControl:
'0px 2px 2px -1px rgba(0, 0, 0, 0.06), 0px 0px 0px 1px rgba(0, 0, 0, 0.06), 0px 4px 4px -2px rgba(0, 0, 0, 0.06)',
} as const);
import { createAlphaColorMixString } from '../utils/colors/utils';
import { clerkCssVar } from '../utils/cssVariables';
import { cssSupports } from '../utils/cssSupports';

type ShadowGenerator = (color: string, alpha: number) => string;

const generateShadow =
(fn: (color: string, alpha: number) => string): ShadowGenerator =>
(color: string, alpha: number) =>
cssSupports.modernColor() ? fn(color, alpha) : `rgba(0, 0, 0, ${alpha})`;

/**
* Creates a complete set of shadows using the provided shadow color
* @param shadowColor - The base color to use for shadows (defaults to black)
* @param shadowGenerator - Function to generate shadow colors with alpha (defaults to CSS variable-based generator)
* @returns Object containing all shadow definitions
*/
export const createShadowSet = (
shadowColor: string = '#000000',
shadowGenerator: ShadowGenerator = generateShadow((color, alpha) =>
createAlphaColorMixString(clerkCssVar('color-shadow', color), alpha * 100),
),
) => {
const highlightColor = '#FFFFFF';
return {
menuShadow: `0px 5px 15px 0px ${shadowGenerator(shadowColor, 0.08)}, 0px 15px 35px -5px ${shadowGenerator(shadowColor, 0.2)}`,
fabShadow: `0px 12px 24px ${shadowGenerator(shadowColor, 0.32)}`,
buttonShadow: `0px 1px 1px 0px ${shadowGenerator(highlightColor, 0.07)} inset, 0px 2px 3px 0px ${shadowGenerator(shadowColor, 0.2)}, 0px 1px 1px 0px ${shadowGenerator(shadowColor, 0.24)}`,
cardBoxShadow: `0px 5px 15px 0px ${shadowGenerator(shadowColor, 0.08)}, 0px 15px 35px -5px ${shadowGenerator(shadowColor, 0.2)}`,
cardContentShadow: `0px 0px 2px 0px ${shadowGenerator(shadowColor, 0.08)}, 0px 1px 2px 0px ${shadowGenerator(shadowColor, 0.06)}`,
actionCardShadow: `0px 1px 4px 0px ${shadowGenerator(shadowColor, 0.12)}, 0px 4px 8px 0px ${shadowGenerator(shadowColor, 0.12)}`,
outlineButtonShadow: `0px 2px 3px -1px ${shadowGenerator(shadowColor, 0.08)}, 0px 1px 0px 0px ${shadowGenerator(shadowColor, 0.02)}`,
input: '0px 0px 1px 0px {{color}}',
focusRing: '0px 0px 0px 4px {{color}}',
badge: `0px 2px 0px -1px ${shadowGenerator(shadowColor, 0.04)}`,
tableBodyShadow: `0px 0px 2px 0px ${shadowGenerator(shadowColor, 0.08)}, 0px 1px 2px 0px ${shadowGenerator(shadowColor, 0.12)}, 0px 0px 0px 1px ${shadowGenerator(shadowColor, 0.06)}`,
segmentedControl: `0px 1px 2px 0px ${shadowGenerator(shadowColor, 0.08)}`,
switchControl: `0px 2px 2px -1px ${shadowGenerator(shadowColor, 0.06)}, 0px 0px 0px 1px ${shadowGenerator(shadowColor, 0.06)}, 0px 4px 4px -2px ${shadowGenerator(shadowColor, 0.06)}`,
};
};

// Default shadows using black shadow color
export const shadows = Object.freeze(createShadowSet());

// Export the generator functions for use in other modules
export { generateShadow };
4 changes: 2 additions & 2 deletions packages/types/src/appearance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -731,8 +731,8 @@ export type Variables = {
*/
colorRing?: CssColor;
/**
* The color of the shadow used in card components.
* @default 'rgba(25, 28, 33, 0.20)'
* The color used as the base for all shadows.
* @default '#000000'
*/
colorShadow?: CssColor;
/**
Expand Down