Get help Color blind mode Low vision mode

Caption Ready

Captions are used as brief explanations accompanying an illustration, form element, or similar. Caption text is smaller than the recommended size for general reading.

Examples #

Open in new window 
<duet-caption>Medium caption text</duet-caption>
<duet-caption size="small">Small caption text</duet-caption>
Open in new window 
<duet-input label="Tooltip usage with caption" accessible-described-by="caption-for-input"> </duet-input>
<duet-caption id="caption-for-input">
  The caption is associated with the input via its ID and the input's accessible-described-by attribute. By doing this,
  screen readers are able to understand the association and will read the caption when the input receives focus.
</duet-caption>

Properties #

Property Attribute Description Type Default
margin margin Controls the margin of the component. "auto" | "none" "auto"
selected selected Selected state of the caption. Used inside Choice component. boolean false
size size Controls the size of the caption. "medium" | "small" "medium"
theme theme Theme of the caption. "" | "default" | "turva" ""

Usage #

This section includes guidelines for designers and developers about the usage of this component in different contexts.

When to use #

  • As brief explanations accompanying an illustration, form element, or similar.

When not to use #

  • For long paragraphs or main content. Use Paragraph component instead.
  • On backgrounds other than white as caption won’t provide enough contrast to pass WCAG 2.1 AA requirements.

Accessibility #

This component has been validated to meet the WCAG 2.1 AA accessibility guidelines. You can find additional information regarding accessibility of this component below.

Integration

For integration, event and theming guidelines, please see Using Components. This documentation explains how to implement and use Duet’s components across different technologies like Angular, React or Vanilla JavaScript.

Integration guidelines

Tutorials

Follow these practical tutorials to learn how to build simple page layouts using Duet’s CSS Framework, Web Components and other features:

Tutorials

Building Layouts

 Tutorials

Using CLI Tools

 Tutorials

Creating Custom Patterns

 Tutorials

Server Side Rendering

 Tutorials

Sharing Prototypes

 Tutorials

Usage With Markdown

Troubleshooting

If you experience any issues while using a component, please head over to the Support page for more guidelines and help.