This repository was archived by the owner on Jan 22, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Add show prop to VisuallyHidden.
#116
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,50 @@ | ||
| import React from 'react'; | ||
| import React, { useState } from 'react'; | ||
| import styled from 'styled-components'; | ||
| import { CodeExample } from './story-utils'; | ||
| import { Button } from './button'; | ||
| import { CodeExample, Prop, PropsDefinition } from './story-utils'; | ||
|
|
||
| export const VisuallyHidden = styled.span.attrs(() => ({ 'data-module': 'VisuallyHidden' }))` | ||
| border: 0; | ||
| height: 1px; | ||
| width: 1px; | ||
| margin: -1px; | ||
| overflow: hidden; | ||
| padding: 0; | ||
| position: absolute; | ||
| white-space: nowrap; | ||
| clip: rect(1px, 1px, 1px, 1px); | ||
| clip-path: inset(50%); | ||
| -webkit-clip-path: inset(50%); | ||
| ${props => !props.show && ` | ||
| border: 0; | ||
| height: 1px; | ||
| width: 1px; | ||
| margin: -1px; | ||
| overflow: hidden; | ||
| padding: 0; | ||
| position: absolute; | ||
| white-space: nowrap; | ||
| clip: rect(1px, 1px, 1px, 1px); | ||
| clip-path: inset(50%); | ||
| -webkit-clip-path: inset(50%); | ||
| `} | ||
| `; | ||
|
|
||
| export const StoryVisuallyHidden = () => ( | ||
| <> | ||
| <p> | ||
| The VisuallyHidden component renders content for screen readers that is not visible on screen, but is visible to screen readers and text | ||
| selection. | ||
| </p> | ||
| <CodeExample>{`<VisuallyHidden>hidden text</VisuallyHidden>`}</CodeExample> | ||
| <div> | ||
| export const StoryVisuallyHidden = () => { | ||
| const [show, setShow] = useState(false); | ||
| return ( | ||
| <> | ||
| <p> | ||
| This paragraph contains <VisuallyHidden>(Bruce Willis was dead the whole time)</VisuallyHidden> a secret message. | ||
| The VisuallyHidden component renders content for screen readers that is not visible on screen, but is visible to screen readers and text | ||
| selection. | ||
| </p> | ||
| </div> | ||
| </> | ||
| ); | ||
| <PropsDefinition> | ||
| <Prop name="show"> | ||
| If true, do not hide the content. Useful for content that is sometimes visually hidden but always available to screen readers. | ||
| </Prop> | ||
| </PropsDefinition> | ||
| <CodeExample>{`<VisuallyHidden>hidden text</VisuallyHidden>`}</CodeExample> | ||
| <div> | ||
| <p> | ||
| This paragraph contains <VisuallyHidden>(Bruce Willis was dead the whole time)</VisuallyHidden> a secret message. | ||
| </p> | ||
| </div> | ||
| <CodeExample>{`<VisuallyHidden show={toggleValue}>hidden text</VisuallyHidden>`}</CodeExample> | ||
| <div> | ||
| <p> | ||
| This paragraph contains <VisuallyHidden show={show}>(The alien planet was actually Earth)</VisuallyHidden> a secret message too. | ||
| </p> | ||
| <Button onClick={() => setShow((show) => !show)}>Toggle secret</Button> | ||
| </div> | ||
| </> | ||
| ); | ||
| }; | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lol, nice