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.

Sign up for GitHub

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

fix(theming): return hex from generated getColor values #1999

Merged
merged 5 commits into from
Jan 10, 2025
Merged

fix(theming): return hex from generated getColor values #1999

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f721050
fix(theming): return hex from generated `getColor` values
jzempel Jan 7, 2025
874bbc6
Enhance `getColor` storybook demo with generated hue info
jzempel Jan 7, 2025
2b97f8a
Refine story with generated hue only when color is not in the theme
jzempel Jan 9, 2025
08c3ee2
Formatting
jzempel Jan 9, 2025
0612cce
Optimization
jzempel Jan 9, 2025
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
90 changes: 71 additions & 19 deletions packages/theming/demo/stories/GetColorStory.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,40 @@
import React from 'react';
import { StoryFn } from '@storybook/react';
import styled, { useTheme } from 'styled-components';
import { IGardenTheme, getCheckeredBackground, getColor } from '@zendeskgarden/react-theming';
import { opacify } from 'color2k';
import {
ColorParameters,
IGardenTheme,
getCheckeredBackground,
getColor
} from '@zendeskgarden/react-theming';
import { LG, SM } from '@zendeskgarden/react-typography';
import { Grid } from '@zendeskgarden/react-grid';
import { Tag } from '@zendeskgarden/react-tags';

const StyledDiv = styled.div.attrs<{ background: string }>(p => ({
style: { background: p.background }
}))<{ background: string }>`
const StyledDiv = styled.div.attrs<{ $background: string }>(p => ({
style: { background: p.$background }
}))`
display: flex;
align-items: center;
justify-content: center;
min-width: 32px;
height: 208px;
`;

interface IColorProps {
dark?: object;
hue?: string;
light?: object;
offset?: number;
shade?: number;
theme: IGardenTheme;
transparency?: number;
variable?: string;
}

const Color = ({ dark, hue, light, offset, shade, theme, transparency, variable }: IColorProps) => {
const Color = ({
dark,
hue,
light,
offset,
shade,
theme,
transparency,
variable
}: ColorParameters) => {
let background;
let tag;
let generatedHue;

try {
const backgroundColor = getColor({
Expand All @@ -57,19 +65,63 @@ const Color = ({ dark, hue, light, offset, shade, theme, transparency, variable
{backgroundColor}
</Tag>
);

const hues = [...Object.keys(theme.colors), ...Object.keys(theme.palette)].filter(
_hue => _hue !== 'base' && _hue !== 'variables'
);
const selectedHue = (theme.colors.base === 'dark' ? dark?.hue : light?.hue) || hue || '';

if (!(variable || hues.includes(selectedHue))) {
generatedHue = [...Array(12).keys()].reduce<Record<number, string>>((retVal, index) => {
const _shade = (index + 1) * 100;

retVal[_shade] = getColor({ theme, hue: opacify(backgroundColor, 1), shade: _shade });

return retVal;
}, {});

/* eslint-disable-next-line no-console */
console.log(generatedHue);
}
} catch (error) {
background = 'transparent';
tag = (
<Tag hue="red" size="large">
<Tag hue="dangerHue" size="large">
{error instanceof Error ? error.message : String(error)}
</Tag>
);
}

return <StyledDiv background={background}>{tag}</StyledDiv>;
return (
<>
<StyledDiv $background={background}>{tag}</StyledDiv>
{!!generatedHue && (
<>
<LG style={{ margin: '20px 0 12px' }}>Generated hue</LG>
Copy link
Contributor

Choose a reason for hiding this comment

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

[nit] Should we align our vocabulary with the Color Principles docs?

Suggested change
<LG style={{ margin: '20px 0 12px' }}>Generated hue</LG>
<LG style={{ margin: '20px 0 12px' }}>Generated palette</LG>

Alternatively:

Suggested change
<LG style={{ margin: '20px 0 12px' }}>Generated hue</LG>
<LG style={{ margin: '20px 0 12px' }}>Generated color scale</LG>

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd prefer to align with the technical theme object and palette documentation. Btw, the term is also used in color principles.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I see. 👍

<Grid gutters={false}>
<Grid.Row wrap="nowrap">
{Object.entries(generatedHue).map(([_shade, backgroundColor], index) => (
<Grid.Col key={index} textAlign="center">
<StyledDiv $background={backgroundColor}>
<Tag
hue={getColor({ theme, variable: 'background.default' })}
style={{ position: 'absolute', transform: 'rotate(-90deg)' }}
>
{backgroundColor}
</Tag>
</StyledDiv>
<SM>{_shade}</SM>
</Grid.Col>
))}
</Grid.Row>
</Grid>
</>
)}
</>
);
};

interface IArgs extends Omit<IColorProps, 'theme'> {
interface IArgs extends Omit<ColorParameters, 'theme'> {
theme: {
colors: Omit<IGardenTheme['colors'], 'base'>;
opacity: IGardenTheme['opacity'];
Expand Down
4 changes: 2 additions & 2 deletions packages/theming/src/utils/getColor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* found at http://www.apache.org/licenses/LICENSE-2.0.
*/

import { getScale, parseToRgba } from 'color2k';
import { getScale, parseToRgba, toHex as _toHex } from 'color2k';
import { darken, getContrast, lighten, rgba } from 'polished';
import get from 'lodash.get';
import memoize from 'lodash.memoize';
Expand Down Expand Up @@ -151,7 +151,7 @@ const generateColorScale = memoize((color: string) => {
const contrastRatios = [];

for (let i = 0; i <= scaleSize; i++) {
const _color = scale(i);
const _color = _toHex(scale(i));
colors.push(_color);
contrastRatios.push(getContrast('#FFF', _color));
}
Expand Down
Loading