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(Button): mark disable usage as invalid #1977

Merged
merged 1 commit into from
Jun 6, 2024
Merged

fix(Button): mark disable usage as invalid #1977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 47 additions & 39 deletions src/components/Button/Button-v2.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,57 +259,65 @@
/**
* Disabled
*/
.button--disabled {
&.button--primary.button--variant-default,
&.button--primary.button--variant-critical,
&.button--primary.button--variant-neutral {
color: var(--eds-theme-color-text-utility-disabled-primary);
border-color: var(--eds-theme-color-background-utility-disabled-medium-emphasis);
background-color: var(--eds-theme-color-background-utility-disabled-medium-emphasis);

pointer-events: none;
}

.button--primary.button--variant-default.button--disabled,
.button--primary.button--variant-critical.button--disabled,
.button--primary.button--variant-neutral.button--disabled {
color: var(--eds-theme-color-text-utility-disabled-primary);
border-color: var(--eds-theme-color-background-utility-disabled-medium-emphasis);
background-color: var(--eds-theme-color-background-utility-disabled-medium-emphasis);
&.button--primary.button--variant-inverse {
color: var(--eds-theme-color-text-utility-inverse-disabled);
/* Using transparent for border color to avoid blending opacity of border and background */
border-color: transparent;
background-color: var(--eds-theme-color-background-utility-inverse-disabled);

pointer-events: none;
}
pointer-events: none;
}

.button--primary.button--variant-inverse.button--disabled {
color: var(--eds-theme-color-text-utility-inverse-disabled);
/* Using transparent for border color to avoid blending opacity of border and background */
border-color: transparent;
background-color: var(--eds-theme-color-background-utility-inverse-disabled);
&.button--secondary.button--variant-default,
&.button--secondary.button--variant-critical,
&.button--secondary.button--variant-neutral {
color: var(--eds-theme-color-text-utility-disabled-primary);
border-color: var(--eds-theme-color-border-disabled);
background-color: var(--eds-theme-color-background-utility-default-no-emphasis);

pointer-events: none;
}
pointer-events: none;
}

.button--secondary.button--variant-default.button--disabled,
.button--secondary.button--variant-critical.button--disabled,
.button--secondary.button--variant-neutral.button--disabled {
color: var(--eds-theme-color-text-utility-disabled-primary);
border-color: var(--eds-theme-color-border-disabled);
background-color: var(--eds-theme-color-background-utility-default-no-emphasis);
&.button--secondary.button--variant-inverse {
color: var(--eds-theme-color-text-utility-inverse-disabled);
border-color: var(--eds-theme-color-border-utility-inverse-disabled);

pointer-events: none;
}
pointer-events: none;
}

.button--secondary.button--variant-inverse.button--disabled {
color: var(--eds-theme-color-text-utility-inverse-disabled);
border-color: var(--eds-theme-color-border-utility-inverse-disabled);
&.button--tertiary.button--variant-default,
&.button--tertiary.button--variant-critical,
&.button--tertiary.button--variant-neutral {
color: var(--eds-theme-color-text-utility-disabled-primary);
background-color: var(--eds-theme-color-background-utility-default-no-emphasis);

pointer-events: none;
}
pointer-events: none;
}

.button--tertiary.button--variant-default.button--disabled,
.button--tertiary.button--variant-critical.button--disabled,
.button--tertiary.button--variant-neutral.button--disabled {
color: var(--eds-theme-color-text-utility-disabled-primary);
background-color: var(--eds-theme-color-background-utility-default-no-emphasis);
&.button--tertiary.button--variant-inverse {
color: var(--eds-theme-color-text-utility-disabled-primary);
border-color: transparent;

pointer-events: none;
pointer-events: none;
}
}

.button--tertiary.button--variant-inverse.button--disabled {
color: var(--eds-theme-color-text-utility-disabled-primary);
border-color: transparent;

pointer-events: none;
/**
* Flag usages of just :disabled as erroneous
*/
.button:disabled:not(.button--disabled) {
outline: 2px dashed var(--eds-theme-color-border-utility-critical);
}

/**
Expand Down
16 changes: 14 additions & 2 deletions src/components/Button/Button-v2.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ type Args = React.ComponentProps<typeof Button>;

export const Default: StoryObj<Args> = {
args: {
children: 'Default',
children: 'Button',
},
};

Expand Down Expand Up @@ -65,7 +65,7 @@ export const DefaultRanks: StoryObj<Args> = {
};

/**
* Buttons can be disabled for each rank
* Buttons can be disabled for each rank using `isDisabled`
*/
export const Disabled: StoryObj<Args> = {
args: {
Expand All @@ -75,6 +75,18 @@ export const Disabled: StoryObj<Args> = {
render: DefaultRanks.render,
};

/**
* Since `isDisabled` will set the form's proper disabled state, don't use just `disabled`. This will show a visual error.
*/
export const JustDisabledProp: StoryObj<Args> = {
args: {
...DefaultRanks.args,
disabled: true,
},
render: DefaultRanks.render,
decorators: [(Story) => <div className="p-1">{Story()}</div>],
};

/**
* Tertiary buttons can have an additional level of emphasis when stood by themselves. Use this case sparingly.
*/
Expand Down
2 changes: 2 additions & 0 deletions src/components/Button/Button-v2.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ export type ButtonV2Props<ExtendedElement = unknown> =

/**
* Whether `Button` is set to disabled state (disables interaction and updates appearance).
*
* Note: this will set the internal field to `disabled` as well. Prefer this to just setting `disabled`.
*/
isDisabled?: boolean;

Expand Down
46 changes: 45 additions & 1 deletion src/components/Button/__snapshots__/Button-v2.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ exports[`<Button /> (v2) Default story renders snapshot 1`] = `
<span
class="button__text"
>
Default
Button
</span>
</button>
`;
Expand Down Expand Up @@ -328,6 +328,50 @@ exports[`<Button /> (v2) InverseRanks story renders snapshot 1`] = `
</div>
`;

exports[`<Button /> (v2) JustDisabledProp story renders snapshot 1`] = `
<div
class="p-1"
>
<div
class="flex gap-1"
>
<button
class="button button--layout-none button--primary button--lg button--variant-default"
disabled=""
type="button"
>
<span
class="button__text"
>
Primary
</span>
</button>
<button
class="button button--layout-none button--secondary button--lg button--variant-default"
disabled=""
type="button"
>
<span
class="button__text"
>
Secondary
</span>
</button>
<button
class="button button--layout-none button--tertiary button--lg button--variant-default"
disabled=""
type="button"
>
<span
class="button__text"
>
Tertiary
</span>
</button>
</div>
</div>
`;

exports[`<Button /> (v2) LoadingStates story renders snapshot 1`] = `
<div
class="flex items-center gap-1"
Expand Down
Loading