shoelace/docs/components/visually-hidden.md

Visually Hidden

[component-header:sl-visually-hidden]

The visually hidden utility makes content accessible to assistive devices without displaying it on the screen.

According to The A11Y Project, "there are real world situations where visually hiding content may be appropriate, while the content should remain available to assistive technologies, such as screen readers. For instance, hiding a search field's label as a common magnifying glass icon is used in its stead."

Since visually hidden content can receive focus when tabbing, the element will become visible when something inside receives focus. This behavior is intentional, as sighted keyboards user won't be able to determine where the focus indicator is without it.

<div style="min-height: 100px;">
  <sl-visually-hidden>
    <a href="#">Skip to main content</a>
  </sl-visually-hidden>
</div>

Examples

Links That Open in New Windows

In this example, the link will open a new window. Screen readers will announce "opens in a new window" even though the text content isn't visible to sighted users.

<a href="https://example.com/" target="_blank">
  Visit External Page
  <sl-icon name="box-arrow-up-right"></sl-icon>
  <sl-visually-hidden>opens in a new window</sl-visually-hidden>
</a>

Content Conveyed By Context

Adding a title or label may seem redundant at times, but they're very helpful for unsighted users. Rather than omit them, you can provide context to unsighted users with visually hidden content.

<sl-card style="width: 100%; max-width: 360px;">
  <header>
    <sl-visually-hidden>Personal Info</sl-visually-hidden>
  </header>
  <sl-input label="Name" style="margin-bottom: .5rem;"></sl-input>
  <sl-input label="Email" type="email"></sl-input>
</sl-card>

[component-metadata:sl-visually-hidden]