Skip to content
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
1 change: 1 addition & 0 deletions packages/govuk-frontend/src/govuk/_base.import.scss
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
@import "helpers";
@import "custom-properties";
@import "components/button/settings";
@import "components/button/helpers";
1 change: 1 addition & 0 deletions packages/govuk-frontend/src/govuk/_base.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
@forward "tools";
@forward "helpers";
@forward "components/button/settings";
@forward "components/button/helpers";
29 changes: 29 additions & 0 deletions packages/govuk-frontend/src/govuk/components/button/_helpers.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
////
/// @group components/button
////

@use "sass:list";

/// List of the button variants available in GOV.UK Frontend
$_available-variants: (secondary, warning, inverse);

/// Configure colours of the Button component for the given variant
///
/// Use:
/// - to create modifiers of the `.govuk-button` class to apply a specific variant to a single button
/// - inside a component to update the default style of all buttons with only the `.govuk-button` class
///
/// It configures the `--_govuk-button-<COLOUR_NAME>` custom properties that apply colours to the button
/// with the appropriate `--_govuk-<VARIANT>-button-<COLOUR_NAME>` properties that define colours for a given variant.
///
/// @access private
@mixin govuk-button-style($variant-name) {
@if not list.index($_available-variants, $variant-name) {
@error "Unknown button variant `#{$variant-name}` (available variants: #{$_available-variants})";
}

--_govuk-button-background-colour: var(--_govuk-#{$variant-name}-button-background-colour);
--_govuk-button-shadow-colour: var(--_govuk-#{$variant-name}-button-shadow-colour);
--_govuk-button-text-colour: var(--_govuk-#{$variant-name}-button-text-colour);
--_govuk-button-hover-background-colour: var(--_govuk-#{$variant-name}-button-hover-background-colour);
}
120 changes: 36 additions & 84 deletions packages/govuk-frontend/src/govuk/components/button/_mixin.scss
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,37 @@

/// @access private
@mixin styles($background-colour, $text-colour, $inverse-background-colour, $inverse-text-colour) {
$govuk-button-colour: $background-colour;
$text-colour: $text-colour;
$govuk-button-hover-colour: base.govuk-colour("green", $variant: "shade-25");
$govuk-button-shadow-colour: base.govuk-colour("green", $variant: "shade-50");

// Secondary button variables
$govuk-secondary-button-colour: base.govuk-colour("black", $variant: "tint-95");
$govuk-secondary-button-text-colour: base.govuk-colour("black");
$govuk-secondary-button-hover-colour: base.govuk-colour("black", $variant: "tint-80");
$govuk-secondary-button-shadow-colour: base.govuk-colour("black", $variant: "tint-50");

// Warning button variables
$govuk-warning-button-colour: base.govuk-colour("red");
$govuk-warning-button-text-colour: base.govuk-colour("white");
$govuk-warning-button-hover-colour: base.govuk-colour("red", $variant: "shade-25");
$govuk-warning-button-shadow-colour: base.govuk-colour("red", $variant: "shade-50");

// Inverse button variables
$govuk-inverse-button-colour: $inverse-background-colour;
$inverse-text-colour: $inverse-text-colour;
$govuk-inverse-button-hover-colour: base.govuk-colour("blue", $variant: "tint-95");
$govuk-inverse-button-shadow-colour: base.govuk-colour("blue", $variant: "shade-50");

// Because the shadow (s0) is visually 'part of' the button, we need to reduce
// the height of the button to compensate by adjusting its padding (s1) and
// increase the bottom margin to include it (s2).
$button-shadow-size: base.$govuk-border-width-form-element;

:root {
// Default button colours
--_govuk-button-background-colour: #{$background-colour};
--_govuk-button-text-colour: #{$text-colour};
--_govuk-button-hover-background-colour: #{base.govuk-colour("green", $variant: "shade-25")};
--_govuk-button-shadow-colour: #{base.govuk-colour("green", $variant: "shade-50")};

// Secondary button colours
--_govuk-secondary-button-background-colour: #{base.govuk-colour("black", $variant: "tint-95")};
--_govuk-secondary-button-text-colour: #{base.govuk-colour("black")};
--_govuk-secondary-button-hover-background-colour: #{base.govuk-colour("black", $variant: "tint-80")};
--_govuk-secondary-button-shadow-colour: #{base.govuk-colour("black", $variant: "tint-50")};

// Warning button colours
--_govuk-warning-button-background-colour: #{base.govuk-colour("red")};
--_govuk-warning-button-text-colour: #{base.govuk-colour("white")};
--_govuk-warning-button-hover-background-colour: #{base.govuk-colour("red", $variant: "shade-25")};
--_govuk-warning-button-shadow-colour: #{base.govuk-colour("red", $variant: "shade-50")};

// Warning button colours
--_govuk-inverse-button-background-colour: #{$inverse-background-colour};
--_govuk-inverse-button-text-colour: #{$inverse-text-colour};
--_govuk-inverse-button-hover-background-colour: #{base.govuk-colour("blue", $variant: "tint-95")};
--_govuk-inverse-button-shadow-colour: #{base.govuk-colour("blue", $variant: "shade-50")};
}

.govuk-button {
@include base.govuk-font($size: 19, $line-height: 19px);

Expand All @@ -49,9 +52,9 @@
(base.govuk-spacing(2) - base.$govuk-border-width-form-element - ($button-shadow-size * 0.5)); // s1
border: base.$govuk-border-width-form-element solid transparent;
border-radius: 0;
color: $text-colour;
background-color: $govuk-button-colour;
box-shadow: 0 $button-shadow-size 0 $govuk-button-shadow-colour; // s0
color: var(--_govuk-button-text-colour);
background-color: var(--_govuk-button-background-colour);
box-shadow: 0 $button-shadow-size 0 var(--_govuk-button-shadow-colour); // s0
text-align: center;
vertical-align: top;
cursor: pointer;
Expand All @@ -66,7 +69,7 @@
&:visited,
&:active,
&:hover {
color: $text-colour;
color: var(--_govuk-button-text-colour);
text-decoration: none;
}

Expand All @@ -77,7 +80,7 @@
}

&:hover {
background-color: $govuk-button-hover-colour;
background-color: var(--_govuk-button-hover-background-colour);
}

&:active {
Expand Down Expand Up @@ -130,80 +133,29 @@
}

.govuk-button[disabled] {
--_govuk-button-hover-background-colour: var(--_govuk-button-background-colour);

opacity: (0.5);

&:hover {
background-color: $govuk-button-colour;
cursor: not-allowed;
}

&:active {
top: 0;
box-shadow: 0 $button-shadow-size 0 $govuk-button-shadow-colour; // s0
}
}

.govuk-button--secondary {
background-color: $govuk-secondary-button-colour;
box-shadow: 0 $button-shadow-size 0 $govuk-secondary-button-shadow-colour;

&,
&:link,
&:visited,
&:active,
&:hover {
color: $govuk-secondary-button-text-colour;
}

&:hover {
background-color: $govuk-secondary-button-hover-colour;

&[disabled] {
background-color: $govuk-secondary-button-colour;
}
}
@include base.govuk-button-style(secondary);
}

.govuk-button--warning {
background-color: $govuk-warning-button-colour;
box-shadow: 0 $button-shadow-size 0 $govuk-warning-button-shadow-colour;

&,
&:link,
&:visited,
&:active,
&:hover {
color: $govuk-warning-button-text-colour;
}

&:hover {
background-color: $govuk-warning-button-hover-colour;

&[disabled] {
background-color: $govuk-warning-button-colour;
}
}
@include base.govuk-button-style(warning);
}

.govuk-button--inverse {
background-color: $govuk-inverse-button-colour;
box-shadow: 0 $button-shadow-size 0 $govuk-inverse-button-shadow-colour;

&,
&:link,
&:visited,
&:active,
&:hover {
color: $inverse-text-colour;
}

&:hover {
background-color: $govuk-inverse-button-hover-colour;

&[disabled] {
background-color: $govuk-inverse-button-colour;
}
}
@include base.govuk-button-style(inverse);
}

.govuk-button--start {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { compileSassString } from '@govuk-frontend/helpers/tests'
import { outdent } from 'outdent'

describe('button/_helpers', () => {
describe('@mixin govuk-button-style', () => {
it('Applies the appropriate variant custom properties to the button custom properties', async () => {
const sass = `
@use "components/button/helpers" as *;

.app-component {
@include govuk-button-style(warning);
}
`

const { css } = await compileSassString(sass)

expect(css).toEqual(outdent`
.app-component {
--_govuk-button-background-colour: var(--_govuk-warning-button-background-colour);
--_govuk-button-shadow-colour: var(--_govuk-warning-button-shadow-colour);
--_govuk-button-text-colour: var(--_govuk-warning-button-text-colour);
--_govuk-button-hover-background-colour: var(--_govuk-warning-button-hover-background-colour);
}
`)
})

it('Throws an error if the variant does not exist', () => {
const sass = `
@use "components/button/helpers" as *;

.app-component {
@include govuk-button-style(unknown-button-variant);
}
`

expect(compileSassString(sass)).rejects.toThrow(
'Unknown button variant `unknown-button-variant` (available variants: secondary, warning, inverse)'
)
})
})
})
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,14 @@
border-color: base.govuk-functional-colour("error");
}

.govuk-file-upload-button__pseudo-button {
background-color: base.govuk-colour("black", $variant: "tint-95");
}
@include base.govuk-button-style(secondary);

&:hover {
--_govuk-button-background-colour: var(--_govuk-button-hover-background-colour);

border-style: dashed;
border-color: base.govuk-colour("black", $variant: "tint-50");

.govuk-file-upload-button__pseudo-button {
background-color: base.govuk-colour("black", $variant: "tint-80");
}

.govuk-file-upload-button__status {
background-color: base.govuk-colour("blue");
}
Expand All @@ -150,15 +146,13 @@
// here as it is already used for the yellow focus state.
box-shadow: inset 0 0 0 base.$govuk-border-width-form-element;

.govuk-file-upload-button__pseudo-button {
background-color: base.govuk-functional-colour(focus);
box-shadow: 0 2px 0 base.govuk-colour("black");
}
--_govuk-button-background-colour: #{base.govuk-functional-colour(focus)};
--_govuk-button-shadow-colour: #{base.govuk-functional-colour(focus-text)};

&:hover .govuk-file-upload-button__pseudo-button {
--_govuk-button-background-colour: var(--_govuk-button-hover-background-colour);
border-color: base.govuk-functional-colour(focus);
outline: 3px solid transparent;
background-color: base.govuk-colour("black", $variant: "tint-80");
box-shadow: inset 0 0 0 1px base.govuk-functional-colour(focus);
}
}
Expand All @@ -168,10 +162,6 @@
border-style: dashed;
background-color: $empty-button-background-colour;

.govuk-file-upload-button__pseudo-button {
background-color: $empty-pseudo-button-background-colour;
}

.govuk-file-upload-button__status {
color: base.govuk-colour("black");
background-color: $empty-status-background-colour;
Expand Down Expand Up @@ -205,10 +195,6 @@

background-color: $empty-button-background-colour;

.govuk-file-upload-button__pseudo-button {
background-color: $empty-pseudo-button-background-colour;
}

.govuk-file-upload-button__status {
background-color: $empty-status-background-colour;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ export class FileUpload extends ConfigurableComponent {

const buttonSpan = document.createElement('span')
buttonSpan.className =
'govuk-button govuk-button--secondary govuk-file-upload-button__pseudo-button'
'govuk-button govuk-file-upload-button__pseudo-button'
buttonSpan.innerText = this.i18n.t('chooseFilesButton')

containerSpan.appendChild(buttonSpan)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

text-align: center;

@include base.govuk-button-style(inverse);

@media #{base.govuk-until-breakpoint(tablet)} {
padding: base.govuk-spacing(4) - base.$govuk-border-width;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
{{ govukButton({
"text": action.text,
"type": action.type if action.type else "button",
"classes": "govuk-button--inverse" + (" " + action.classes if action.classes),
"classes": action.classes if action.classes,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

😎

"href": action.href,
"attributes": action.attributes
}) }}
Expand Down
Loading