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 action tokens to PrimaryButton with brand base as fallback #3081

Open
wants to merge 15 commits into
base: prerelease/minor
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 10 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
2 changes: 1 addition & 1 deletion modules/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"@workday/canvas-kit-react": "^12.2.2",
"@workday/canvas-kit-styling": "^12.2.2",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"markdown-to-jsx": "^7.2.0",
"react-syntax-highlighter": "^15.5.0",
"ts-node": "^10.9.1"
Expand Down
2 changes: 1 addition & 1 deletion modules/labs-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"@workday/canvas-kit-react": "^12.2.2",
"@workday/canvas-kit-styling": "^12.2.2",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"@workday/design-assets-types": "^0.2.8",
"chroma-js": "^2.2.0",
"lodash.flatten": "^4.4.0",
Expand Down
2 changes: 1 addition & 1 deletion modules/preview-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"@workday/canvas-kit-react": "^12.2.2",
"@workday/canvas-kit-styling": "^12.2.2",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"@workday/design-assets-types": "^0.2.8"
},
"devDependencies": {
Expand Down
42 changes: 27 additions & 15 deletions modules/react/button/lib/PrimaryButton.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,38 +23,50 @@ const primaryButtonStencil = createStencil({
extends: buttonStencil,
base: {
// Base Styles
[buttonStencil.vars.background]: brand.primary.base,
[buttonStencil.vars.background]: cssVar(brand.action.base, brand.primary.base),
[buttonStencil.vars.borderRadius]: system.shape.round,
[buttonStencil.vars.label]: brand.primary.accent,
[systemIconStencil.vars.color]: cssVar(buttonColorPropVars.default.icon, brand.primary.accent),
[buttonStencil.vars.label]: cssVar(brand.action.accent, brand.primary.accent),
[systemIconStencil.vars.color]: cssVar(
buttonColorPropVars.default.icon,
cssVar(brand.action.accent, brand.primary.accent)
),
// Focus Styles
'&:focus-visible, &.focus': {
[buttonStencil.vars.background]: brand.primary.base,
[buttonStencil.vars.label]: brand.primary.accent,
[buttonStencil.vars.background]: cssVar(brand.action.base, brand.primary.base),
[buttonStencil.vars.label]: cssVar(brand.action.accent, brand.primary.accent),
[buttonStencil.vars.boxShadowInner]: system.color.border.inverse,
[buttonStencil.vars.boxShadowOuter]: brand.common.focusOutline,
[systemIconStencil.vars.color]: cssVar(buttonColorPropVars.focus.icon, brand.primary.accent),
[systemIconStencil.vars.color]: cssVar(
buttonColorPropVars.focus.icon,
cssVar(brand.action.accent, brand.primary.accent)
),
},
// Hover Styles
'&:hover, &.hover': {
[buttonStencil.vars.background]: brand.primary.dark,
[buttonStencil.vars.label]: brand.primary.accent,
[systemIconStencil.vars.color]: cssVar(buttonColorPropVars.hover.icon, brand.primary.accent),
[buttonStencil.vars.background]: cssVar(brand.action.dark, brand.primary.dark),
[buttonStencil.vars.label]: cssVar(brand.action.accent, brand.primary.accent),
[systemIconStencil.vars.color]: cssVar(
buttonColorPropVars.hover.icon,
cssVar(brand.action.accent, brand.primary.accent)
),
},
// Active Styles
'&:active, &.active': {
[buttonStencil.vars.background]: brand.primary.darkest,
[buttonStencil.vars.label]: brand.primary.accent,
[systemIconStencil.vars.color]: cssVar(buttonColorPropVars.active.icon, brand.primary.accent),
[buttonStencil.vars.background]: cssVar(brand.action.darkest, brand.primary.darkest),
[buttonStencil.vars.label]: cssVar(brand.action.accent, brand.primary.accent),
[systemIconStencil.vars.color]: cssVar(
buttonColorPropVars.active.icon,
cssVar(brand.action.accent, brand.primary.accent)
),
},
// Disabled Styles
'&:disabled, &.disabled': {
[buttonStencil.vars.background]: brand.primary.base,
[buttonStencil.vars.label]: brand.primary.accent,
[buttonStencil.vars.background]: cssVar(brand.action.base, brand.primary.base),
[buttonStencil.vars.label]: cssVar(brand.action.accent, brand.primary.accent),
[buttonStencil.vars.opacity]: system.opacity.disabled,
[systemIconStencil.vars.color]: cssVar(
buttonColorPropVars.disabled.icon,
brand.primary.accent
cssVar(brand.action.accent, brand.primary.accent)
),
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {customColorTheme} from '../../../../../utils/storybook';
import {playCircleIcon, relatedActionsVerticalIcon} from '@workday/canvas-system-icons-web';
import {PrimaryButton} from '@workday/canvas-kit-react/button';
import {Container, stateTableColumnProps} from './utils';
import {customColorThemeWithAction} from '../../../../../utils/storybook/customThemes';

export default {
title: 'Testing/Buttons/Button/Primary Button',
Expand Down Expand Up @@ -99,6 +100,10 @@ export const PrimaryButtonThemedStates = {
render: () => <PrimaryButtonTest theme={{canvas: customColorTheme}} />,
};

export const PrimaryButtonThemedActionStates = {
render: () => <PrimaryButtonTest theme={{canvas: customColorThemeWithAction}} />,
};

export const PrimaryIconButtonThemedStates = {
render: () => <PrimaryIconButtonTest theme={{canvas: customColorTheme}} />,
};
32 changes: 20 additions & 12 deletions modules/react/common/lib/CanvasProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ const defaultBranding = createStyles({
[brand.primary.base]: base.blueberry400,
[brand.primary.light]: base.blueberry200,
[brand.primary.lightest]: base.blueberry100,
[brand.action.accent]: base.frenchVanilla100,
[brand.action.darkest]: base.blueberry600,
[brand.action.dark]: base.blueberry500,
[brand.action.base]: base.blueberry400,
[brand.action.light]: base.blueberry200,
[brand.action.lightest]: base.blueberry100,
[brand.gradient
.primary]: `linear-gradient(90deg, ${brand.primary.base} 0%, ${brand.primary.dark} 100%)`,
});
Expand All @@ -65,20 +71,22 @@ export const useCanvasThemeToCssVars = (
const className = (elemProps.className || '').split(' ').concat(defaultBranding).join(' ');
const style = elemProps.style || {};
const {palette} = filledTheme.canvas;
(['common', 'primary', 'error', 'alert', 'success', 'neutral'] as const).forEach(color => {
if (color === 'common') {
// @ts-ignore
style[brand.common.focusOutline] = palette.common.focusOutline;
}
(['lightest', 'light', 'main', 'dark', 'darkest', 'contrast'] as const).forEach(key => {
// We only want to set custom colors if they do not match the default. The `defaultBranding` class will take care of the rest.
// @ts-ignore
if (palette[color][key] !== defaultCanvasTheme.palette[color][key]) {
(['common', 'primary', 'error', 'alert', 'success', 'neutral', 'action'] as const).forEach(
color => {
if (color === 'common') {
// @ts-ignore
style[brand[color][mappedKeys[key]]] = palette[color][key];
style[brand.common.focusOutline] = palette.common.focusOutline;
}
});
});
(['lightest', 'light', 'main', 'dark', 'darkest', 'contrast'] as const).forEach(key => {
// We only want to set custom colors if they do not match the default. The `defaultBranding` class will take care of the rest.
// @ts-ignore
if (palette[color][key] !== defaultCanvasTheme.palette[color][key]) {
// @ts-ignore
style[brand[color][mappedKeys[key]]] = palette[color][key];
}
});
}
);
return {...elemProps, className, style};
};

Expand Down
3 changes: 2 additions & 1 deletion modules/react/common/lib/theming/createCanvasTheme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,13 @@ function fillPalette(

function calculateCanvasTheme(partialTheme: PartialCanvasTheme): CanvasTheme {
const {palette = {}, breakpoints = {}, direction, ...extraFields} = partialTheme;
const {primary, alert, error, success, neutral, common = {}} = palette!;
const {primary, alert, error, success, neutral, action, common = {}} = palette!;

const mergeable: PartialCanvasTheme = {
palette: {
common,
primary: fillPalette(defaultCanvasTheme.palette.primary, primary),
action: fillPalette(defaultCanvasTheme.palette.primary, action || primary),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This bit of code allows for consumers just to define primary and not require them to define action.
The below code when passed to canvas provider will work, with action not being defined.

const customColorTheme: PartialCanvasTheme = {
  palette: {
    primary: {
      main: 'purple',
      contrast: 'turquoise',
    },
    error: {
      main: 'crimson',
    },
    success: {
      main: 'aquamarine',
    },
    neutral: {
      main: 'gray',
    },
    common: {
      focusOutline: 'turquoise',
    },
  },
};

If you pass the following, action will win

const customColorThemeWithAction: PartialCanvasTheme = {
  palette: {
    primary: {
      main: 'purple',
      contrast: 'turquoise',
    },
    action: {
      main: 'red',
    },
    error: {
      main: 'crimson',
    },
    success: {
      main: 'aquamarine',
    },
    neutral: {
      main: 'gray',
    },
    common: {
      focusOutline: 'turquoise',
    },
  },
};

alert: fillPalette(defaultCanvasTheme.palette.alert, alert),
error: fillPalette(defaultCanvasTheme.palette.error, error),
success: fillPalette(defaultCanvasTheme.palette.success, success),
Expand Down
8 changes: 8 additions & 0 deletions modules/react/common/lib/theming/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ export const defaultCanvasTheme: CanvasTheme = {
darkest: colors.blueberry600,
contrast: colors.frenchVanilla100,
},
action: {
lightest: colors.blueberry100,
light: colors.blueberry200,
main: colors.blueberry400,
dark: colors.blueberry500,
darkest: colors.blueberry600,
contrast: colors.frenchVanilla100,
},
alert: {
lightest: colors.cantaloupe100,
light: colors.cantaloupe300,
Expand Down
1 change: 1 addition & 0 deletions modules/react/common/lib/theming/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export interface CanvasTheme {
alert: CanvasThemePalette;
success: CanvasThemePalette;
neutral: CanvasThemePalette;
action: CanvasThemePalette;
};
/**
* ### Theme Breakpoints
Expand Down
52 changes: 52 additions & 0 deletions modules/react/common/spec/createCanvasTheme.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,20 @@ describe('createCanvasTheme', () => {
const input = {
palette: {
primary: palette,
action: palette,
},
};
const theme = createCanvasTheme(input);

const expected = {...defaultCanvasTheme};
expected.palette.action = {
lightest: 'orange',
light: 'orange',
main: 'orange',
dark: 'orange',
darkest: 'orange',
contrast: 'orange',
};
expected.palette.primary = palette;

expect(theme).toEqual(expected);
Expand All @@ -51,6 +61,15 @@ describe('createCanvasTheme', () => {
contrast: '#494949',
};

expected.palette.action = {
lightest: '#ffff7d',
light: '#ffd64a',
main: 'orange',
josh-bagwell marked this conversation as resolved.
Show resolved Hide resolved
dark: '#c67600',
darkest: '#904a00',
contrast: '#494949',
};

expect(theme).toEqual(expected);
});

Expand All @@ -65,7 +84,40 @@ describe('createCanvasTheme', () => {
const theme = createCanvasTheme(input);
const expected = {...defaultCanvasTheme};
expected.palette.primary.dark = 'black';
expected.palette.action.dark = 'black';
expect(theme).toEqual(expected);
});

test('calling with a custom palette with action colors should keep the default primary color and only set action', () => {
const input = {
palette: {
primary: {
dark: 'black',
},
action: {
dark: 'navy',
},
},
};
const theme = createCanvasTheme(input);
const expected = {...defaultCanvasTheme};
expected.palette.primary.dark = 'black';
expected.palette.action.dark = 'navy';
expect(theme).toEqual(expected);
});

test('if not action color is defined, it should default to primary color', () => {
const input = {
palette: {
primary: {
dark: 'black',
},
},
};
const theme = createCanvasTheme(input);
const expected = {...defaultCanvasTheme};
expected.palette.primary.dark = 'black';
expected.palette.action.dark = 'black';
expect(theme).toEqual(expected);
});

Expand Down
2 changes: 1 addition & 1 deletion modules/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"@workday/canvas-kit-popup-stack": "^12.2.2",
"@workday/canvas-kit-styling": "^12.2.2",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"@workday/design-assets-types": "^0.2.8",
"chroma-js": "^2.2.0",
"csstype": "^3.0.2",
Expand Down
2 changes: 1 addition & 1 deletion modules/styling-transform/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"dependencies": {
"@emotion/serialize": "^1.0.2",
"@workday/canvas-kit-styling": "^12.2.2",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"stylis": "4.0.13",
"ts-node": "^10.9.1",
"typescript": "5.0"
Expand Down
2 changes: 1 addition & 1 deletion modules/styling/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"@emotion/styled": "^11.6.0",
"@workday/canvas-kit-react": "^12.2.2",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"typescript": "5.0"
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@
"@workday/canvas-accent-icons-web": "^3.0.9",
"@workday/canvas-applet-icons-web": "^2.0.9",
"@workday/canvas-system-icons-web": "^3.0.0",
"@workday/canvas-tokens-web": "^2.0.1",
"@workday/canvas-tokens-web": "^2.1.0",
"jest-environment-jsdom": "^29.7.0",
"ts-jest": "^29.2.4"
},
Expand Down
27 changes: 27 additions & 0 deletions utils/storybook/customThemes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,30 @@ export const customColorTheme: PartialCanvasTheme = {
},
},
};

export const customColorThemeWithAction: PartialCanvasTheme = {
palette: {
primary: {
main: 'purple',
contrast: 'turquoise',
},
action: {
main: 'red',
josh-bagwell marked this conversation as resolved.
Show resolved Hide resolved
},
alert: {
main: 'coral',
},
error: {
main: 'crimson',
},
success: {
main: 'aquamarine',
},
neutral: {
main: 'gray',
},
common: {
focusOutline: 'turquoise',
},
},
};
10 changes: 6 additions & 4 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6158,10 +6158,10 @@
dependencies:
"@workday/design-assets-types" "0.2.8"

"@workday/canvas-tokens-web@^2.0.1":
version "2.0.1"
resolved "https://registry.yarnpkg.com/@workday/canvas-tokens-web/-/canvas-tokens-web-2.0.1.tgz#b7d3df6849a869b0adf57e9b9ab924c6a4f778da"
integrity sha512-PRfhnqFEe08kjn0vQPicfHh5zCCIYgunnCLYfSpVkwBX1OZHEFvCpB0pmz67P3313sty0/BmYWgzPmv3VT9mkA==
"@workday/canvas-tokens-web@^2.1.0":
version "2.1.0"
resolved "https://registry.npmjs.org/@workday/canvas-tokens-web/-/canvas-tokens-web-2.1.0.tgz#3fa68416c003dd84a217909db556ab385360a34e"
integrity sha512-qDkhronvKRmautzHWLAlGYwI0UsrXmRN07EFCHPROFAbVglMdd1D3LIeP2ECtQ76qOcEVJM79vQJdwai4B9K7g==

"@workday/design-assets-types@0.2.10":
version "0.2.10"
Expand Down Expand Up @@ -15684,6 +15684,7 @@ string-replace-loader@^3.1.0:
schema-utils "^3.0.0"

"string-width-cjs@npm:string-width@^4.2.0", "string-width@^1.0.2 || 2 || 3 || 4", string-width@^4.2.3:
name string-width-cjs
version "4.2.3"
resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010"
integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==
Expand Down Expand Up @@ -16987,6 +16988,7 @@ wordwrap@^1.0.0:
integrity sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=

"wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0:
name wrap-ansi-cjs
version "7.0.0"
resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43"
integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==
Expand Down
Loading