Skip to content

Latest commit

 

History

History
601 lines (495 loc) · 29 KB

buttons.md

File metadata and controls

601 lines (495 loc) · 29 KB
layout title description group aliases toc
docs
Buttons
Use OUDS Web's custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.
components
/docs/components/buttons/
true

{{< callout info >}} You can find here the OUDS Button design guidelines. {{< /callout >}}

Base class

OUDS Web has a base .btn class that sets up basic styles such as padding and content alignment. By default, .btn controls have a transparent border and background color, but still defines basic focus and hover styles.

{{< example >}} Base class {{< /example >}}

The .btn class is intended to be used in conjunction with our button variants, or to serve as a basis for your own custom styles.

Standard variants

OUDS Web includes several button variants, each serving its own semantic purpose, with a few extras thrown in for more control. Please follow the Button design specifications to choose the right button for the right action.

{{< example >}} Default Strong Minimal Negative {{< /example >}}

{{< bootstrap-compatibility false >}} {{< example >}} {{< buttons.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }} {{- end -}} {{< /buttons.inline >}}

{{< /example >}} {{< /bootstrap-compatibility >}}

Variants on colored background

OUDS Web offers a few variations to use on [colored backgrounds]({{< docsref "/utilities/background#colored-background" >}}). Their accessibility (readability) is ensured by suitable semi-opaque backgrounds.

{{< callout warning >}} Heads up!

  • Background utilities used to make colored backgrounds, should always be used with the appropriate color theme (see an example below). Please refer to [colored backgrounds documentation]({{< docsref "/utilities/background/#colored-backgrounds" >}})
  • Negative buttons should never be used on colored background. {{< /callout >}}

{{< example class="p-none">}}

Default Strong Minimal
Default Strong Minimal
{{< /example >}}

With icon

Text and icon

{{< callout info >}} The recommended way of using an icon in a button is through an [SVG sprite file]({{< docsref "/extend/icons/#svg-sprite" >}}). You need to:

  • set its dimensions to default 1rem size, the icon will adapt automatically,
  • fill it using currentColor to respect the button color scheme (can be set directly inside the SVG sprite). {{< /callout >}}

You don't need to apply any spacing utility on the icon to get consistent spacing, as the margin is already handled by OUDS Web.

Please note that if you experience a problem with a cropped SVG, we recommend using the .overflow-visible utility on the SVG to fix its rendering.

If really needed, you can use a font icon associated to the .icon class to set correct parameters for the font-size and line-height.

We strongly advise not using an <img>, in particular because the icon will not benefit from dynamic color changes on states (hover, focus, active) and the color mode system won't work.

{{< example class="p-none">}}

Default Strong Minimal Negative Default
Default Strong Minimal 
<button type="button" class="btn btn-default btn-on-colored-bg">
  <span class="icon si si-settings" aria-hidden="true"></span>
  Default
</button>
{{< /example >}}

Icon only

Add .btn-icon to get a squared button, meant to only contain an icon. Make sure to provide an accessible name to your button, either using a .visually-hidden content or an aria-label attribute.

{{< example class="p-none">}}

Default Strong Minimal Negative Default
Default Strong Minimal 
<button type="button" class="btn btn-icon btn-default btn-on-colored-bg">
  <span class="icon si si-settings" aria-hidden="true"></span>
  <span class="visually-hidden">Default</span>
</button>
{{< /example >}}

Disable text wrapping

If you don't want the button text to wrap, you can add the .text-nowrap class to the button. In Sass, you can set $btn-white-space: nowrap to disable text wrapping for each button.

Button tags

The .btn classes are designed to be used with the <button> element. However, you can also use these classes on <a> or <input> elements (though some browsers may apply a slightly different rendering).

When using button classes on <a> elements that are used to trigger in-page functionality (like collapsing content), rather than linking to new pages or sections within the current page, these links should be given a role="button" to appropriately convey their purpose to assistive technologies such as screen readers.

{{< example >}} Link Button {{< /example >}}

Outline buttons

{{< bootstrap-compatibility false >}}

{{< markdown >}} In need of a button, but not the hefty background colors they bring? Replace the default modifier classes with the .btn-outline-* ones to remove all background images and colors on any button. {{< /markdown >}}

{{< example >}} {{< buttons.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }} {{- end -}} {{< /buttons.inline >}} {{< /example >}}

{{< /bootstrap-compatibility >}}

Disabled state

Make buttons look inactive by adding the disabled boolean attribute to any <button> element. Disabled buttons have pointer-events: none applied to, preventing hover and active states from triggering.

{{< example class="p-none" >}}

Default Strong Minimal Negative
Default Strong Minimal
{{< /example >}}

Disabled buttons using the <a> element behave a bit different:

  • Disabled buttons using <a> must include the aria-disabled="true" attribute to indicate the state of the element to assistive technologies and to make it visually appear disabled.
  • Disabled buttons using <a> should not include the href attribute. In case you need to keep the href, please refer to [disabled link accessibility warning](/docs/{{< param docs_version >}}/components/links#disabled-link-accessibility-warning).
  • Some future-friendly styles are included to disable all pointer-events on anchor buttons.

{{< example class="p-none" >}}

Default link Strong link
Default link Strong link
{{< /example >}}

Loading state

The loading state of a button indicates that an action is currently processing or taking place. This state provides feedback to users, enhancing user experience.

To make an animated loading state button, you will add in your standard button:

  • An animated <svg>: the animation will differ whether the loading time is known or not.
  • A status message <span>: the message must be updated regularly in order to be vocalized by screen readers; if the loading time is defined, you should indicate the progression.

For example, before loading, your button could be like this:

{{< example >}} Download file {{< /example >}}

When the loading starts, you will have to:

  • Add the class .loading-indeterminate (for an unknown loading time) or .loading-determinate (for a known loading time) to the button to provide the appropriate styles and animation.
  • For a known loading time, provide a CSS variable --bs-btn-loading-time to set the loading time. For example, add style="--bs-btn-loading-time: 5s;" to the button, for a 5 seconds loading.
  • Set the disabled state on the button to avoid any unwanted interactions (in case you use a <a> tag, this can be done by setting aria-disabled="true" and removing the href attribute).
  • Remove the .d-none from the status message <span>.
  • Update regularly the status message <span> containing the loading message.

At the end of the loading, you should:

  • Remove the disabled state on the button to restore its interactivity.
  • Remove the class .loading-indeterminate or .loading-determinate to restore the button's look.
  • Set a final status message in <span>, indicating the loading has ended (so we don't add again .d-none on this status message).
  • Put the focus back on the button to ensure similar behavior across browsers and not lose the user after changes.

You can see it live and find a JavaScript example on our [loading buttons live example]({{< docsref "/examples/loading-buttons" >}}).

{{< example class="p-none" >}}

Download file 1 Downloading file 1 Download file 2 Downloading file 2 Download file 3 Downloading file 3 Download file 4 Downloading file 4
Download file 5 Downloading file 5: xx% Download file 6 Downloading file 6: xx% Download file 7 Downloading file 7: xx% Download file 8 Downloading file 8: xx%
Download file 9 Downloading file 9 Download file 10 Downloading file 10 Download file 11 Downloading file 11
Download file 12 Downloading file 12: xx% Download file 13 Downloading file 13: xx% Download file 14 Downloading file 14: xx%
{{< /example >}}

Loading state can also be combined with all kind of buttons, including icons.

{{< example >}}

Downloading file 15 Downloading file 15 Downloading file 16 Downloading file 16: xx% Download file 17 Downloading file 17 Download file 18 Downloading file 18

{{< /example >}}

Block buttons

Create responsive stacks of full-width, "block buttons" with a mix of our display and gap utilities. By using utilities instead of button-specific classes, we have much greater control over spacing, alignment, and responsive behaviors.

Please note that these full-width buttons should not be used on desktop screens.

{{< example >}}

Button Button
{{< /example >}}

Here we create a responsive variation, starting with vertically stacked buttons until the md breakpoint, where .d-md-block replaces the .d-grid class, thus nullifying the gap-short utility. Resize your browser to see them change.

{{< example >}}

Button Button
{{< /example >}}

You can adjust the width of your block buttons with grid column width classes. For example, for a half-width "block button", use .col-6. Center it horizontally with .mx-auto, too.

{{< example >}}

Button Button
{{< /example >}}

Additional utilities can be used to adjust the alignment of buttons when horizontal. Here we've taken our previous responsive example and added some flex utilities and a margin utility on the button to right-align the buttons when they're no longer stacked.

{{< example >}}

Button Button
{{< /example >}}

CSS

Variables

As part of OUDS Web's evolving CSS variables approach, buttons use local CSS variables on .btn for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

{{< scss-docs name="btn-css-vars" file="scss/_buttons.scss" >}}

Each .btn-* modifier class updates the appropriate CSS variables to minimize additional CSS rules with our button-variant() mixin.

Sass variables

{{< scss-docs name="btn-variables" file="scss/_variables.scss" >}}

Sass mixins

There are one mixin for button colors: button variant mixin.

{{< scss-docs name="btn-variant-mixin" file="scss/mixins/_buttons.scss" >}}

{{< bootstrap-compatibility false >}}

{{< scss-docs name="btn-outline-variant-mixin" file="scss/mixins/_buttons.scss" >}}

{{< scss-docs name="btn-size-mixin" file="scss/mixins/_buttons.scss" >}}

{{< /bootstrap-compatibility >}}

Button variants use their respective mixin to generate the modifier classes in scss/_buttons.scss. Here are the way we define the OUDS Buttons.

{{< scss-docs name="btn-variant-loops" file="scss/_buttons.scss" >}}

Component tokens

{{< scss-docs name="ouds-component-button" file="scss/tokens/_component.scss" >}}