Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

terra-visually-hidden-text

cerner8kApache-2.02.39.0

Text that is designed to only be read by a screen reader.

Cerner, Terra, terra-visually-hidden-text, UI, VisuallyHiddenText

readme

Terra Visually Hidden Text

NPM version Build Status

Text that is designed to only be read by a screen reader.

Getting Started

  • Install from npmjs: npm install terra-visually-hidden-text

Peer Dependencies

This component requires the following peer dependencies be installed in your app for the component to properly function.

Peer Dependency Version
react ^16.8.5
react-dom ^16.8.5

LICENSE

Copyright 2018 - 2019 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

changelog

Changelog

Unreleased

2.39.0 - (May 24, 2024)

  • Changed
    • Minor dependency version bump.

2.38.0 - (February 15, 2024)

  • Changed
    • Minor dependency version bump.

2.37.0 - (November 13, 2023)

  • Changed
    • Minor dependency version bump

2.36.0 - (December 7, 2022)

  • Changed
    • Minor dependency version bump

2.35.0 - (February 2, 2022)

  • Added
    • Migrate docs to terra core docs.

2.34.0 - (September 21, 2021)

  • Changed
    • Updated WDIO Screenshots due to webpack-config-terra sass upgrade.

2.33.0 - (August 25, 2021)

  • Changed
    • Updated WDIO snapshots due to terra-functional-testing v2 upgrade.

2.32.0 - (April 6, 2021)

  • Changed
    • Removed unnecessary wdio.conf.js file
    • Upgrade to terra-functional-testing
    • Updated Jest command

2.31.0 - (December 8, 2020)

  • Changed
    • Update wdio tests to remove deprecated Terra.it helpers

2.30.0 - (August 4, 2020)

  • Changed
    • Minor dependency version bump

2.29.0 - (July 29, 2020)

  • Changed
    • Update changelog formatting

3.38.0 - (June 23, 2020)

  • Changed
    • Update Usage Section in dev-site doc page

2.27.0 - (June 9, 2020)

  • Changed
    • Minor file changes to comply with eslint rules
    • Update wdio test configuration to use root wdio config

2.26.0 - (April 28, 2020)

  • Changed

    • Removed "View Component Source Code" from docs in favour of source code badge
  • Added

    • Added clinical-lowlight-theme wdio screenshots

2.25.0 - (April 22, 2020)

  • Changed
    • Updated documentation link in README

2.24.0 - (March 10, 2020)

  • Changed
    • Update docs to use mdx syntax.

2.23.0 - (February 18, 2020)

  • Added
    • Added generated-themes to .npmignore

2.22.0 - (January 7, 2020)

  • Changed
    • Minor dependency version bump

2.21.0 - (December 3, 2019)

  • Added
    • Added reference wdio screenshots for "orion-fusion-theme".

2.20.0 - (October 30, 2019)

  • Fixed
    • Fixed lint warnings for multiple empty lines

2.19.0 - (October 3, 2019)

  • Changed
    • Minor dependency version bump

2.18.0 - (September 19, 2019)

  • Changed
    • Removed details tag from doc-site.

2.17.0 - (September 6, 2019)

  • Added
    • Props table markdown file import added to doc site page

2.16.0 - (August 21, 2019)

  • Changed
    • Import for package version from package.json added to doc page
    • Cleaned up imports in examples and test files

2.15.0 - (August 14, 2019)

  • Changed
    • updated package.json test scripts

2.14.0 - (July 30, 2019)

  • Changed
    • Minor dependency version bump

2.13.0 - (July 24, 2019)

  • Changed
    • Minor dependency version bump

2.12.0 - (July 16, 2019)

  • Added
    • Added documentation on required peerDependencies

2.11.0 - (July 11, 2019)

  • Changed
    • Update tests to use Terra.describeViewports for setting viewports and use Terra.it.validatesElement

2.10.0 - (July 9, 2019)

  • Added
    • Added refCallback prop. This is useful when using terra-visually-hidden-text as an aria-live container

2.9.0 - (June 28, 2019)

  • Changed
    • Minor dependency version bump

2.8.0 - (June 11, 2019)

  • Removed

    • Removed node_modules from .npmignore
  • Changed

    • Made required updates to consume terra-toolkit v5 and terra-dev-site v5

2.7.0 - (May 1, 2019)

  • Changed
    • Minor dependency version bump

2.6.0 - (April 16, 2019)

  • Changed
    • Minor dependency version bump

2.5.0 - (March 26, 2019)

  • Changed

    • Update react/react-dom peer-dependency to latest stable minor release
  • Removed

    • Removed peer dependency on terra-base
    • Removed baseStyles import from terra-base

2.4.0 - (March 21, 2019)

  • Changed
    • Minor dependency version bump

2.3.0 - (February 26, 2019)

  • Changed
    • Minor dependency version bump

2.2.0 - (February 12, 2019)

  • Changed
    • Minor dependency version bump

2.1.0 - (February 5, 2019)

  • Changed
    • Minor dependency version bump

2.0.0 - (January 22, 2019)

  • Changed
    • Updated theme variables

1.10.0 - (January 22, 2019)

  • Changed
    • Updated dependencies to fix major version bump issues

1.9.0 - (January 8, 2019)

  • Changed
    • Minor dependency version bump

1.8.0 - (January 2, 2019)

  • Changed
    • Minor dependency version bump

1.7.0 - (November 19, 2018)

  • Changed
    • Minor dependency version bump

1.6.0 - (November 13, 2018)

  • Changed
    • Minor dependency version bump

1.5.0 - (November 9, 2018)

  • Changed
    • Minor dependency version bump

1.4.0 - (October 30, 2018)

  • Changed
    • Prevented text from reading one word at a time on screen readers

1.3.0 - (October 24, 2018)

  • Changed
    • Minor dependency version bump

1.2.0 - (October 16, 2018)

  • Changed
    • Minor dependency version bump

1.1.0 - (October 8, 2018)

  • Changed
    • Minor dependency version bump

1.0.0 - (September 25, 2018)

  • Initial stable release