Skip to content

chore(IconButton): migrate to CSS Modules with visual regression baseline #1036

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

Open
DreaminDani wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore(IconButton): migrate to CSS Modules with visual regression baseline #1036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3f02e5
test(IconButton): add visual regression baseline before CSS Modules m…
DreaminDani May 19, 2026
c97a548
chore(IconButton): migrate styling from styled-components to CSS Modules
DreaminDani May 19, 2026
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
5 changes: 5 additions & 0 deletions .changeset/migrate-iconbutton-to-css-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clickhouse/click-ui': patch
---

migration of IconButton from styled-components to css modules. no behavior change.
145 changes: 145 additions & 0 deletions src/components/IconButton/IconButton.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/* stylelint-disable custom-property-pattern -- design tokens use camelCase (e.g. iconButton) */

.iconbutton {
padding: var(--click-button-iconButton-default-space-y)
var(--click-button-iconButton-default-space-x);
border: var(--click-button-stroke) solid;
border-radius: var(--click-button-iconButton-radii-all);
cursor: pointer;
}

.iconbutton_size_sm {
padding: var(--click-button-iconButton-sm-space-y)
var(--click-button-iconButton-sm-space-x);
}

.iconbutton_size_xs {
padding: var(--click-button-iconButton-xs-space-y)
var(--click-button-iconButton-xs-space-x);
}

.iconbutton_type_primary {
border-color: var(--click-button-iconButton-color-primary-stroke-default);
background-color: var(--click-button-iconButton-color-primary-background-default);
color: var(--click-button-iconButton-color-primary-text-default);
}

.iconbutton_type_primary:visited {
background-color: var(--click-button-iconButton-color-primary-background-default);
}

.iconbutton_type_primary:not([disabled]):hover {
border-color: var(--click-button-iconButton-color-primary-stroke-hover);
background-color: var(--click-button-iconButton-color-primary-background-hover);
color: var(--click-button-iconButton-color-primary-text-hover);
}

.iconbutton_type_primary:not([disabled]):focus,
.iconbutton_type_primary:not([disabled]):active,
.iconbutton_type_primary:not([disabled]):focus-within {
border-color: var(--click-button-iconButton-color-primary-stroke-active);
background-color: var(--click-button-iconButton-color-primary-background-active);
color: var(--click-button-iconButton-color-primary-text-active);
}

.iconbutton_type_secondary {
border-color: var(--click-button-iconButton-color-secondary-stroke-default);
background-color: var(--click-button-iconButton-color-secondary-background-default);
color: var(--click-button-iconButton-color-secondary-text-default);
}

.iconbutton_type_secondary:visited {
background-color: var(--click-button-iconButton-color-secondary-background-default);
}

.iconbutton_type_secondary:not([disabled]):hover {
border-color: var(--click-button-iconButton-color-secondary-stroke-hover);
background-color: var(--click-button-iconButton-color-secondary-background-hover);
color: var(--click-button-iconButton-color-secondary-text-hover);
}

.iconbutton_type_secondary:not([disabled]):focus,
.iconbutton_type_secondary:not([disabled]):active,
.iconbutton_type_secondary:not([disabled]):focus-within {
border-color: var(--click-button-iconButton-color-secondary-stroke-active);
background-color: var(--click-button-iconButton-color-secondary-background-active);
color: var(--click-button-iconButton-color-secondary-text-active);
}

.iconbutton_type_ghost {
border-color: var(--click-button-iconButton-color-ghost-stroke-default);
background-color: var(--click-button-iconButton-color-ghost-background-default);
color: var(--click-button-iconButton-color-ghost-text-default);
}

.iconbutton_type_ghost:visited {
background-color: var(--click-button-iconButton-color-ghost-background-default);
}

.iconbutton_type_ghost:not([disabled]):hover {
border-color: var(--click-button-iconButton-color-ghost-stroke-hover);
background-color: var(--click-button-iconButton-color-ghost-background-hover);
color: var(--click-button-iconButton-color-ghost-text-hover);
}

.iconbutton_type_ghost:not([disabled]):focus,
.iconbutton_type_ghost:not([disabled]):active,
.iconbutton_type_ghost:not([disabled]):focus-within {
border-color: var(--click-button-iconButton-color-ghost-stroke-active);
background-color: var(--click-button-iconButton-color-ghost-background-active);
color: var(--click-button-iconButton-color-ghost-text-active);
}

.iconbutton_type_danger {
border-color: var(--click-button-iconButton-color-danger-stroke-default);
background-color: var(--click-button-iconButton-color-danger-background-default);
color: var(--click-button-iconButton-color-danger-text-default);
}

.iconbutton_type_danger:visited {
background-color: var(--click-button-iconButton-color-danger-background-default);
}

.iconbutton_type_danger:not([disabled]):hover {
border-color: var(--click-button-iconButton-color-danger-stroke-hover);
background-color: var(--click-button-iconButton-color-danger-background-hover);
color: var(--click-button-iconButton-color-danger-text-hover);
}

.iconbutton_type_danger:not([disabled]):focus,
.iconbutton_type_danger:not([disabled]):active,
.iconbutton_type_danger:not([disabled]):focus-within {
border-color: var(--click-button-iconButton-color-danger-stroke-active);
background-color: var(--click-button-iconButton-color-danger-background-active);
color: var(--click-button-iconButton-color-danger-text-active);
}

.iconbutton_type_info {
border-color: var(--click-button-iconButton-color-info-stroke-default);
background-color: var(--click-button-iconButton-color-info-background-default);
color: var(--click-button-iconButton-color-info-text-default);
}

.iconbutton_type_info:visited {
background-color: var(--click-button-iconButton-color-info-background-default);
}

.iconbutton_type_info:not([disabled]):hover {
border-color: var(--click-button-iconButton-color-info-stroke-hover);
background-color: var(--click-button-iconButton-color-info-background-hover);
color: var(--click-button-iconButton-color-info-text-hover);
}

.iconbutton_type_info:not([disabled]):focus,
.iconbutton_type_info:not([disabled]):active,
.iconbutton_type_info:not([disabled]):focus-within {
border-color: var(--click-button-iconButton-color-info-stroke-active);
background-color: var(--click-button-iconButton-color-info-background-active);
color: var(--click-button-iconButton-color-info-text-active);
}

.iconbutton[disabled] {
background-color: var(--click-button-iconButton-color-disabled-background-default);
color: var(--click-button-iconButton-color-disabled-text-default);
cursor: not-allowed;
}
42 changes: 42 additions & 0 deletions src/components/IconButton/IconButton.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,41 @@ export const Playground: Story = {
},
};

export const Primary: Story = {
args: {
type: 'primary',
icon: 'user',
},
};

export const Secondary: Story = {
args: {
type: 'secondary',
icon: 'user',
},
};

export const Ghost: Story = {
args: {
type: 'ghost',
icon: 'user',
},
};

export const Danger: Story = {
args: {
type: 'danger',
icon: 'user',
},
};

export const Info: Story = {
args: {
type: 'info',
icon: 'user',
},
};

export const Disabled: Story = {
args: {
disabled: true,
Expand All @@ -39,3 +74,10 @@ export const Small: Story = {
icon: 'user',
},
};

export const ExtraSmall: Story = {
args: {
size: 'xs',
icon: 'user',
},
};
81 changes: 27 additions & 54 deletions src/components/IconButton/IconButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,38 @@
import { forwardRef } from 'react';
import { styled } from 'styled-components';
import { Icon } from '@/components/Icon';
import { cn, cva } from '@/lib/cva';
import { IconButtonProps } from './IconButton.types';
import styles from './IconButton.module.css';

const iconButtonVariants = cva(styles.iconbutton, {
variants: {
type: {
primary: styles['iconbutton_type_primary'],
secondary: styles['iconbutton_type_secondary'],
ghost: styles['iconbutton_type_ghost'],
danger: styles['iconbutton_type_danger'],
info: styles['iconbutton_type_info'],
},
size: {
default: '',
sm: styles['iconbutton_size_sm'],
xs: styles['iconbutton_size_xs'],
},
},
defaultVariants: {
type: 'primary',
size: 'default',
},
});

export const IconButton = forwardRef<HTMLButtonElement, IconButtonProps>(
({ type = 'primary', icon, size, disabled, ...props }, ref) => {
({ type = 'primary', icon, size, disabled, className, ...props }, ref) => {
const iconName = icon ? icon.toString() : 'unknown icon';

return (
<Button
<button
{...props}
$styleType={type}
$size={size}
className={cn(iconButtonVariants({ type, size }), className)}
disabled={disabled}
ref={ref}
role="button"
Expand All @@ -21,57 +42,9 @@ export const IconButton = forwardRef<HTMLButtonElement, IconButtonProps>(
name={icon}
size="sm"
/>
</Button>
</button>
);
}
);

IconButton.displayName = 'IconButton';

const Button = styled.button<{
$styleType?: 'primary' | 'secondary' | 'ghost' | 'danger' | 'info';
$size?: 'default' | 'sm' | 'xs';
}>`
${({ theme, $size, $styleType = 'primary' }) => `
border-radius: ${theme.click.button.iconButton.radii.all};
border: ${theme.click.button.stroke} solid ${
theme.click.button.iconButton.color[$styleType].stroke.default
};
cursor: pointer;
padding: ${
$size
? `${theme.click.button.iconButton[$size].space.y} ${theme.click.button.iconButton[$size].space.x}`
: `${theme.click.button.iconButton.default.space.y} ${theme.click.button.iconButton.default.space.x}`
};

background-color: ${theme.click.button.iconButton.color[$styleType].background.default};

color: ${theme.click.button.iconButton.color[$styleType].text.default};
&:not([disabled]) {
&:hover {
background-color: ${theme.click.button.iconButton.color[$styleType].background.hover};
color: ${theme.click.button.iconButton.color[$styleType].text.hover};
border-color: ${theme.click.button.iconButton.color[$styleType].stroke.hover};
}

&:focus, &:active, &:focus-within {
background-color: ${
theme.click.button.iconButton.color[$styleType].background.active
};
color: ${theme.click.button.iconButton.color[$styleType].text.active};
border-color: ${theme.click.button.iconButton.color[$styleType].stroke.active};
}
}
&:visited {
background-color: ${
theme.click.button.iconButton.color[$styleType].background.default
};
}

&[disabled] {
background-color: ${theme.click.button.iconButton.color.disabled.background.default};
color: ${theme.click.button.iconButton.color.disabled.text.default};
cursor: not-allowed;
}
`}
`;
Loading
Loading