Button github location npm version

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.

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 (exampe), 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 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": "a primary button",
  "theme": "primary"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
<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">a 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 (exampe), 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": "an outline style",
  "theme": "primary",
  "style": [
    "outline"
  ]
}
 %}
{% 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": "an outline style",
  "theme": "primary",
  "style": [
    "outline"
  ]
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
<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--outline">an outline style</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 (exampe), 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 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": "a tertiary button",
  "theme": "tertiary"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
<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">a 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 (exampe), 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 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": "a small button",
  "theme": "primary",
  "size": "sm"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
<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 ">a 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 (exampe), 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": "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": "a link variant",
  "button_href": "JavaScript:Void(0);",
  "theme": "primary"
} %}
                
React syntax (pre-alpha)

import { VfButton } from "@visual-framework/vf-button/vf-button.react.js";
<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--primary">a link variant</a>
              

Usage

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

When To Use

A site visitor generally would expect a button to submit data or take action, and if used as a link to navigate to another page.

Each form on a page should only have one primary button, any remaining buttons should use the secondary (outline primary) button.

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

Alignment

As a general rule, the vf-button should be left aligned on the page and when used inside as part of a larger component. When used in conjuction with a single form input, like a search input, 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 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. This is where something like the vf-link-list component should be used.

Label

The button text should be short and clear. Depending on the action of the button it should use agreed microcopy*.

*to be done.

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.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.