Button element

Buttons are clickable elements that trigger an action. They can communicate calls to action, are visually prominent, and allow users to interact with the pages in various ways.

github location npm version

Usage

The vf-button component can be used with forms on a page and as a prominent 'call to action' link that goes to another page.

When To Use

A button can be used to submit data or take action and as a link to navigate to another page.

Use the primary button for the principal call to action on a page or form. Avoid having multiple primary buttons on the same page or form.

Use secondary buttons for secondary calls to action. Pages with too many prominent calls to action make it hard for users to know what to do next. Before adding lots of secondary buttons, try to simplify the page or break the content down across multiple pages.

Tertiary buttons can be used for less prominent actions. Consider using a link instead of a button to send users to another page, if this action is not very important.

As the vf-button is relatively large, depending on the context, you may wish to use the vf-button--small variant instead.

Alignment

As a general rule, the vf-button should be left aligned on the page and when used inside a larger component.

When used in conjunction with a single form input, as in the vf-search component, the vf-button needs to be inline with the input and to the right of it.

When a vf-button is used in a banner (e.g. to accept cookies) it needs to follow the content and be right aligned.

When Not To Use

If using the vf-button as a link do not use it to link to content on the same page. Use the vf-link-list component instead.

Label

Write button text in sentence case, describing the action it performs. For example:

  • ‘Apply now’ to apply for a job.
  • ‘Create account’ to create an account.
  • ‘Sign in’ to an account that a user has already created.
  • ‘Save and continue’ when pressing the button will save the information that the user has entered.

Try to keep the text on the button short and clear.

Related documentation

The guidelines on buttons in the GOV.UK Design System and the Carbon Design System include additional advice on when and how to use buttons.

Angular

As of vf-button v2.0.0-alpha.2 vf-button has experimental Angular support.

  1. install yarn add @visual-framework/vf-button
  2. import in your app.module
    import { VfButton } from "@visual-framework/vf-button/vf-button.angular.component.ts";
    
    @NgModule({
      declarations: [VfButton, YourOtherComponents],
      ...
    })
    
  3. use
    <a vf-button href="//embl.org" primary="true" small="true">Hello world</a>
    
  4. add to your styles.scss
    @import '~@visual-framework/vf-button/vf-button.scss';
    
    (you should also make use of vf-sass-starter)

Depending on the success of this method, we plan to add standardized guidance to the component library and component generator.

Usage:

<a vf-button href="//embl.org" primary="true" small="true">Hello</a>

Variants

Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "text": "Primary button",
  "theme": "primary"
}
 %}
{% include "../path_to/vf-button/vf-button.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-button', {
  "component-type": "element",
  "text": "Primary button",
  "theme": "primary"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
// or
import { VfButton } from "@visual-framework/vf-button/vf-button.jsx";
<VfButton parameter="value" />
                

For individual parameter names and options, see the Nunjucks syntax example. Also follow the React setup guide. Note: React support is in its early pre-alpha stage and not all component are yet supported.

HTML
<button class="vf-button vf-button--primary">Primary button</button>
              
Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "text": "Secondary button",
  "theme": "secondary"
}
 %}
{% include "../path_to/vf-button/vf-button.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-button', {
  "component-type": "element",
  "text": "Secondary button",
  "theme": "secondary"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
// or
import { VfButton } from "@visual-framework/vf-button/vf-button.jsx";
<VfButton parameter="value" />
                

For individual parameter names and options, see the Nunjucks syntax example. Also follow the React setup guide. Note: React support is in its early pre-alpha stage and not all component are yet supported.

HTML
<button class="vf-button vf-button--secondary">Secondary button</button>
              
Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "text": "Tertiary button",
  "theme": "tertiary"
}
 %}
{% include "../path_to/vf-button/vf-button.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-button', {
  "component-type": "element",
  "text": "Tertiary button",
  "theme": "tertiary"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
// or
import { VfButton } from "@visual-framework/vf-button/vf-button.jsx";
<VfButton parameter="value" />
                

For individual parameter names and options, see the Nunjucks syntax example. Also follow the React setup guide. Note: React support is in its early pre-alpha stage and not all component are yet supported.

HTML
<button class="vf-button vf-button--tertiary">Tertiary button</button>
              
Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "text": "Small button",
  "theme": "primary",
  "size": "sm"
}
 %}
{% include "../path_to/vf-button/vf-button.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-button', {
  "component-type": "element",
  "text": "Small button",
  "theme": "primary",
  "size": "sm"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
// or
import { VfButton } from "@visual-framework/vf-button/vf-button.jsx";
<VfButton parameter="value" />
                

For individual parameter names and options, see the Nunjucks syntax example. Also follow the React setup guide. Note: React support is in its early pre-alpha stage and not all component are yet supported.

HTML
<button class="vf-button vf-button--primary vf-button--sm ">Small button</button>
              
Nunjucks syntax

Depending on your environment you'll want to use render or include. As a rule of thumb: server-side use include, precompiled browser use render. If you're using vf-eleventy you should use include.

Using include

You'll need to pass a context object from your code or Yaml file (example), as well as the path to the Nunjucks template. Nunjucks' include is an abstraction of render and provides some additional portability.


{% set context fromYourYamlFile %}
- or -
{% set context = {
  "component-type": "element",
  "text": "a link variant",
  "button_href": "JavaScript:Void(0);",
  "theme": "link"
}
 %}
{% include "../path_to/vf-button/vf-button.njk" %}
                

Using render

This approach is best for bare-bones Nunjucks environments, such as precompiled templates with the Nunjucks slim runtime where include is not be available.

{% render '@vf-button', {
  "component-type": "element",
  "text": "a link variant",
  "button_href": "JavaScript:Void(0);",
  "theme": "link"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
// or
import { VfButton } from "@visual-framework/vf-button/vf-button.jsx";
<VfButton parameter="value" />
                

For individual parameter names and options, see the Nunjucks syntax example. Also follow the React setup guide. Note: React support is in its early pre-alpha stage and not all component are yet supported.

HTML
<a href="JavaScript:Void(0);" class="vf-button vf-button--link">a link variant</a>
              

Examples

Installation info

This component is distributed with npm. After installing npm, you can install the vf-button with this command.

$ yarn add --dev @visual-framework/vf-button

Sass/CSS

The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-button/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Changelog

Changelog

1.2.3

  • Updated changelog

1.2.2

  • Documentation upgrade

1.2.1

  • New release

1.2.0

  • Update node-html-parser to 5.1.0
  • Use eleventy v1.0.0-beta.8
  • https://github.com/visual-framework/vf-core/pull/1257

1.1.16

  • Utilise new vf-navigation--on-this-page.
  • Update project boilerplate links at https://stable.visual-framework.dev/building/

1.1.13

  • Documentation updates
  • New release

1.1.12

  • Update milestones and roadmap.

1.1.11

  • Add ELIXIR banner to example EMBL-EBI page.
  • https://stable.visual-framework.dev/patterns/boilerplate-generic-embl-ebi/
  • https://github.com/visual-framework/vf-core/pull/1615

1.1.7

  • Fixed issue of overlapping menu on VF components site
  • https://github.com/visual-framework/vf-core/issues/1518

1.1.6

  • dependency bump

1.1.2

  • Implements updated vf-search markup.
  • Changes a few pages on how it works with nunjucks and markdown.

1.1.0

  • updates Design Tokens homepage.
  • adds neutral colour tokens
  • adds 'status banners' for components in the documentation page.
  • Adds the form options as their own set of components in the list.
  • https://github.com/visual-framework/vf-core/pull/1390/files
  • Updates to use 11ty 0.12.1
  • https://github.com/visual-framework/vf-core/pull/1435

1.0.24

  • changes the vf-intro so it's a white background, removes the padding.
  • changes the links in vf-intro to be the 'correct' buttons.

1.0.23

  • small change to cards on homepage

1.0.18

  • dependency bump

1.0.17

  • dependency bump

1.0.16

  • dependency bump

1.0.13

  • dependency bump
  • adds roamap and consultation docs

1.0.12

  • design token documenation now lives in the component libary

1.0.7

  • adds updates blog

1.0.6

  • begin to make more pattern/boilerplate guidance
  • minor templating updates

1.0.5

  • dependency bump

1.0.4

  • uses vf-favicon
  • adds meta attributes

1.0.3

  • run vf-component-assets:everything on local dev
  • remove reference to removed /css/app.css

1.0.2

  • Add 404
  • Fix component CSS generation

1.0.1

  • Also generate per-component CSS with vf-css:generate-component-css

1.0.0

  • Initial release to be used with vf-core 2.2.0

Assets



File system location: components/vf-button

Find an issue on this page? Propose a change or discuss it.