vue-visually-hidden

Vue.js visually hidden component (Vue 3 Only)

What is visually-hidden component ?

In the case of visual content, users using assistive technologies (e.g. screen readers) may not always know what the content means.

In most cases, accessible content can be provided by semantic markup, but there is currently no markup that can provide content that is not visually visible but can be read out loud.

For example, when a button is displayed with only pictograms, the description of the button may be visually discernible, but the screen reader may not know what it means.

<button type="submit">
  <span>
    📧
  </span>
</button>

In such cases, <VisuallyHidden> is a good choice.

<button type="submit">
  <span aria-hidden="true">
    📧
  </span>
  <VisuallyHidden>
    Send email
  </VisuallyHidden>
</button>

Use aria-hidden="true" to prevent screen readers from emoji.

It used to be used in Bootstrap in the form of sr-only.

Reference

WebAIM: CSS in Action - Invisible Content Just for Screen Reader Users

Demo

https://vue-visually-hidden.vercel.app/

Installation

npm install -D vue-visually-hidden

yarn add -D vue-visually-hidden

Usage

<template>
  <div>
    <VisuallyHidden>
      Visually Hidden Text
    </VisuallyHidden>
    <VisuallyHidden :isFocusable="true">
      <a href="http://example.com">example</a>
    </VisuallyHidden>
  </div>
</template>

<script setup>
  import { VisuallyHidden } from 'vue-visually-hidden'
</script>

style setting (vue-cli)

import 'vue-visually-hidden/dist/style.css'

style setting (vite)

import 'vue-visually-hidden/style'

isFocusable

prop	type	default
isFocusable	Boolean	false

Inspired by Bootstrap visually-hidden helper

.visually-hidden-focusable can be show by any child element of the container receives focus.

<template>
  <VisuallyHidden :isFocusable="true">
    <a href="http://example.com">example</a>
  </VisuallyHidden>
</template>

This can be used primarily for a feature called skip link. A skip link is link that allow keyboard users to quickly access the main content, and the links are visible upon focus.

Reference

• Basics | Vue.js
• vue-a11y/vue-skip-to

Resolve Setting

If you get the error Invalid VNode type: Symbol(Fragment) (symbol), try setting resolve in the configuration file as follows.

See: vuejs/core#2064

vue.config.js

const path = require('path')

module.exports = {
  configureWebpack: {
    resolve: {
      symlinks: false,
      alias: {
        vue: path.resolve('./node_modules/vue')
      }
    }
  }
}

vite.config.js

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [vue()],
  resolve: {
    dedupe: ['vue']
  }
})