Component

Tag

Use the tag component to show users the status of something. For example, the server environment the page is being rendered from.

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

Hello world!

How to call this component

<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!"
} %>

GOV.UK Design System

This component incorporates components from the GOV.UK Design System:

Accessibility acceptance criteria

  • should have a text colour contrast ratio of more than 4.5:1 with its background to be visually distinct
  • does not use colour alone to convey information
  • should not be used within a link, as a button, or for interactivity

Other examples

Standard options

This component uses the component wrapper helper. It accepts the following options and applies them to the parent element of the component. See the component wrapper helper documentation for more detail.

  • id - accepts a string for the element ID attribute
  • data_attributes - accepts a hash of data attributes
  • aria - accepts a hash of aria attributes
  • classes - accepts a space separated string of classes, these should not be used for styling and must be prefixed with js-
  • margin_bottom - accepts a number from 0 to 9 (0px to 60px) using the GOV.UK Frontend spacing scale
  • role - accepts a space separated string of roles
  • lang - accepts a language attribute value
  • open - accepts an open attribute value (true or false)
  • hidden - accepts an empty string, ‘hidden’, or ‘until-found’
  • tabindex - accepts an integer. The integer can also be passed as a string
  • dir - accepts ‘rtl’, ‘ltr’, or ‘auto’
  • type - accepts any valid type attribute e.g. ‘button’, ‘submit’, ‘text’
  • rel - accepts any valid rel attribute e.g. ‘nofollow’
  • target - accepts a valid target attribute e.g. ‘_blank’
  • title - accepts any string
  • draggable - accepts a draggable attribute value (“true” or “false”)

Sentence case conversion (preview)

The component automatically converts text to sentence case as shown.

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "HELLO WORLD!"
} %>

Grey (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "grey"
} %>

Green (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "green"
} %>

Turquoise (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "turquoise"
} %>

Blue (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "blue"
} %>

Light blue (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "light-blue"
} %>

Purple (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "purple"
} %>

Pink (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "pink"
} %>

Red (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "red"
} %>

Orange (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "orange"
} %>

Yellow (preview)

Hello world! 
<%= render "govuk_publishing_components/components/tag", {
  text: "Hello world!",
  colour: "yellow"
} %>