Skip to content

Commit

Permalink
Revert "components: Promote VisuallyHidden from ui into full componen…
Browse files Browse the repository at this point in the history
…ts (WordPress#31244)" (WordPress#31882)

This reverts commit fda8d09.
  • Loading branch information
youknowriad committed May 17, 2021
1 parent c6337eb commit 4dbd9e0
Show file tree
Hide file tree
Showing 20 changed files with 241 additions and 84 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Basic rendering should render 1`] = `"<div tabindex=\\"-1\\" class=\\"block-editor-link-control\\"><div class=\\"block-editor-link-control__search-input-wrapper\\"><form><div class=\\"components-base-control block-editor-url-input block-editor-link-control__search-input css-wdf2ti-Wrapper e1puf3u0\\"><div class=\\"components-base-control__field css-11vcxb9-StyledField e1puf3u1\\"><input required=\\"\\" class=\\"block-editor-url-input__input\\" type=\\"text\\" placeholder=\\"Search or type url\\" role=\\"combobox\\" aria-label=\\"URL\\" aria-expanded=\\"false\\" aria-autocomplete=\\"list\\" aria-owns=\\"block-editor-url-input-suggestions-0\\" value=\\"\\"></div></div><div class=\\"block-editor-link-control__search-actions\\"><button type=\\"submit\\" class=\\"components-button block-editor-link-control__search-submit has-icon\\" aria-label=\\"Submit\\"><svg width=\\"24\\" height=\\"24\\" xmlns=\\"http://www.w3.org/2000/svg\\" viewBox=\\"-2 -2 24 24\\" role=\\"img\\" aria-hidden=\\"true\\" focusable=\\"false\\"><path d=\\"M6.734 16.106l2.176-2.38-1.093-1.028-3.846 4.158 3.846 4.157 1.093-1.027-2.176-2.38h2.811c1.125 0 2.25.03 3.374 0 1.428-.001 3.362-.25 4.963-1.277 1.66-1.065 2.868-2.906 2.868-5.859 0-2.479-1.327-4.896-3.65-5.93-1.82-.813-3.044-.8-4.806-.788l-.567.002v1.5c.184 0 .368 0 .553-.002 1.82-.007 2.704-.014 4.21.657 1.854.827 2.76 2.657 2.76 4.561 0 2.472-.973 3.824-2.178 4.596-1.258.807-2.864 1.04-4.163 1.04h-.02c-1.115.03-2.229 0-3.344 0H6.734z\\"></path></svg></button></div></form></div><fieldset class=\\"block-editor-link-control__settings\\"><legend class=\\"components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0\\">Currently selected link settings</legend><div class=\\"components-base-control components-toggle-control block-editor-link-control__setting css-wdf2ti-Wrapper e1puf3u0\\"><div class=\\"components-base-control__field css-11vcxb9-StyledField e1puf3u1\\"><span class=\\"components-form-toggle\\"><input class=\\"components-form-toggle__input\\" id=\\"inspector-toggle-control-0\\" type=\\"checkbox\\"><span class=\\"components-form-toggle__track\\"></span><span class=\\"components-form-toggle__thumb\\"></span></span><label for=\\"inspector-toggle-control-0\\" class=\\"components-toggle-control__label\\">Open in new tab</label></div></div></fieldset></div>"`;
exports[`Basic rendering should render 1`] = `"<div tabindex=\\"-1\\" class=\\"block-editor-link-control\\"><div class=\\"block-editor-link-control__search-input-wrapper\\"><form><div class=\\"components-base-control block-editor-url-input block-editor-link-control__search-input css-wdf2ti-Wrapper e1puf3u0\\"><div class=\\"components-base-control__field css-11vcxb9-StyledField e1puf3u1\\"><input required=\\"\\" class=\\"block-editor-url-input__input\\" type=\\"text\\" placeholder=\\"Search or type url\\" role=\\"combobox\\" aria-label=\\"URL\\" aria-expanded=\\"false\\" aria-autocomplete=\\"list\\" aria-owns=\\"block-editor-url-input-suggestions-0\\" value=\\"\\"></div></div><div class=\\"block-editor-link-control__search-actions\\"><button type=\\"submit\\" class=\\"components-button block-editor-link-control__search-submit has-icon\\" aria-label=\\"Submit\\"><svg width=\\"24\\" height=\\"24\\" xmlns=\\"http://www.w3.org/2000/svg\\" viewBox=\\"-2 -2 24 24\\" role=\\"img\\" aria-hidden=\\"true\\" focusable=\\"false\\"><path d=\\"M6.734 16.106l2.176-2.38-1.093-1.028-3.846 4.158 3.846 4.157 1.093-1.027-2.176-2.38h2.811c1.125 0 2.25.03 3.374 0 1.428-.001 3.362-.25 4.963-1.277 1.66-1.065 2.868-2.906 2.868-5.859 0-2.479-1.327-4.896-3.65-5.93-1.82-.813-3.044-.8-4.806-.788l-.567.002v1.5c.184 0 .368 0 .553-.002 1.82-.007 2.704-.014 4.21.657 1.854.827 2.76 2.657 2.76 4.561 0 2.472-.973 3.824-2.178 4.596-1.258.807-2.864 1.04-4.163 1.04h-.02c-1.115.03-2.229 0-3.344 0H6.734z\\"></path></svg></button></div></form></div><fieldset class=\\"block-editor-link-control__settings\\"><legend class=\\"components-visually-hidden\\">Currently selected link settings</legend><div class=\\"components-base-control components-toggle-control block-editor-link-control__setting css-wdf2ti-Wrapper e1puf3u0\\"><div class=\\"components-base-control__field css-11vcxb9-StyledField e1puf3u1\\"><span class=\\"components-form-toggle\\"><input class=\\"components-form-toggle__input\\" id=\\"inspector-toggle-control-0\\" type=\\"checkbox\\"><span class=\\"components-form-toggle__track\\"></span><span class=\\"components-form-toggle__thumb\\"></span></span><label for=\\"inspector-toggle-control-0\\" class=\\"components-toggle-control__label\\">Open in new tab</label></div></div></fieldset></div>"`;
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Snapshot Diff:
type="button"
/>
<div
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="color-picker-saturation-4"
+ id="color-picker-saturation-3"
>
Expand Down Expand Up @@ -86,7 +86,7 @@ Snapshot Diff:
tabIndex="0"
/>
<p
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="components-color-picker__hue-description-4"
+ id="components-color-picker__hue-description-3"
>
Expand Down Expand Up @@ -161,7 +161,7 @@ Snapshot Diff:
type="button"
/>
<div
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="color-picker-saturation-8"
+ id="color-picker-saturation-7"
>
Expand Down Expand Up @@ -208,7 +208,7 @@ Snapshot Diff:
tabIndex="0"
/>
<p
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="components-color-picker__hue-description-8"
+ id="components-color-picker__hue-description-7"
>
Expand Down Expand Up @@ -283,7 +283,7 @@ Snapshot Diff:
type="button"
/>
<div
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="color-picker-saturation-10"
+ id="color-picker-saturation-9"
>
Expand Down Expand Up @@ -330,7 +330,7 @@ Snapshot Diff:
tabIndex="0"
/>
<p
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="components-color-picker__hue-description-10"
+ id="components-color-picker__hue-description-9"
>
Expand Down Expand Up @@ -405,7 +405,7 @@ Snapshot Diff:
type="button"
/>
<div
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="color-picker-saturation-6"
+ id="color-picker-saturation-5"
>
Expand Down Expand Up @@ -452,7 +452,7 @@ Snapshot Diff:
tabIndex="0"
/>
<p
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="components-color-picker__hue-description-6"
+ id="components-color-picker__hue-description-5"
>
Expand Down Expand Up @@ -511,7 +511,7 @@ Snapshot Diff:
type="button"
/>
<div
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="color-picker-saturation-2"
+ id="color-picker-saturation-1"
>
Expand All @@ -537,7 +537,7 @@ Snapshot Diff:
tabIndex="0"
/>
<p
className="components-visually-hidden css-1r162ic-VisuallyHidden css-1mm2cvy-View egi4jkx0"
className="components-visually-hidden"
- id="components-color-picker__hue-description-2"
+ id="components-color-picker__hue-description-1"
>
Expand Down Expand Up @@ -574,56 +574,20 @@ Snapshot Diff:
`;
exports[`ColorPicker should render color picker 1`] = `
.emotion-0 {
border: 0;
-webkit-clip: rect( 1px,1px,1px,1px );
clip: rect( 1px,1px,1px,1px );
-webkit-clip-path: inset( 50% );
-webkit-clip-path: inset( 50% );
clip-path: inset( 50% );
height: 1px;
margin: -1px;
overflow: hidden;
padding: 0;
position: absolute;
width: 1px;
word-wrap: normal !important;
}
.emotion-0:focus {
background-color: #edeff0;
-webkit-clip: auto !important;
clip: auto !important;
-webkit-clip-path: none;
clip-path: none;
color: #444;
display: block;
font-size: 1em;
height: auto;
left: 5px;
line-height: normal;
padding: 15px 23px 14px;
-webkit-text-decoration: none;
text-decoration: none;
top: 5px;
width: auto;
z-index: 100000;
}
.emotion-10 {
.emotion-4 {
font-family: -apple-system,BlinkMacSystemFont,'Segoe UI',Roboto,Oxygen-Sans,Ubuntu,Cantarell,'Helvetica Neue',sans-serif;
font-size: 13px;
}
.emotion-8 {
.emotion-2 {
margin-bottom: 8px;
}
.components-panel__row .emotion-8 {
.components-panel__row .emotion-2 {
margin-bottom: inherit;
}
.emotion-6 {
.emotion-0 {
display: inline-block;
margin-bottom: 8px;
}
Expand Down Expand Up @@ -667,7 +631,7 @@ exports[`ColorPicker should render color picker 1`] = `
type="button"
/>
<div
className="components-visually-hidden emotion-0 emotion-1 emotion-2"
className="components-visually-hidden"
id="color-picker-saturation-0"
>
Use your arrow keys to change the base color. Move up to lighten the color, down to darken, left to decrease saturation, and right to increase saturation.
Expand Down Expand Up @@ -727,7 +691,7 @@ exports[`ColorPicker should render color picker 1`] = `
tabIndex="0"
/>
<p
className="components-visually-hidden emotion-0 emotion-1 emotion-2"
className="components-visually-hidden"
id="components-color-picker__hue-description-0"
>
Move the arrow left or right to change hue.
Expand All @@ -744,13 +708,13 @@ exports[`ColorPicker should render color picker 1`] = `
className="components-color-picker__inputs-fields"
>
<div
className="components-base-control components-color-picker__inputs-field emotion-10 emotion-11"
className="components-base-control components-color-picker__inputs-field emotion-4 emotion-5"
>
<div
className="components-base-control__field emotion-8 emotion-9"
className="components-base-control__field emotion-2 emotion-3"
>
<label
className="components-base-control__label emotion-6 emotion-7"
className="components-base-control__label emotion-0 emotion-1"
htmlFor="inspector-text-control-0"
>
Color value in hexadecimal
Expand Down
1 change: 1 addition & 0 deletions packages/components/src/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@
@import "./toolbar-button/style.scss";
@import "./toolbar-group/style.scss";
@import "./tooltip/style.scss";
@import "./visually-hidden/style.scss";
2 changes: 1 addition & 1 deletion packages/components/src/ui/form-group/form-group-label.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function FormGroupLabel( { children, id, labelHidden = false, ...props } ) {

if ( labelHidden ) {
return (
<VisuallyHidden as="label" htmlFor={ id?.toString() }>
<VisuallyHidden as="label" htmlFor={ id }>
{ children }
</VisuallyHidden>
);
Expand Down
1 change: 1 addition & 0 deletions packages/components/src/ui/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ export * from './shortcut';
export * from './spinner';
export * from './v-stack';
export * from './view';
export * from './visually-hidden';
17 changes: 17 additions & 0 deletions packages/components/src/ui/visually-hidden/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# VisuallyHidden

`VisuallyHidden` is a component used to render text intended to be visually hidden, but will show for alternate devices, for example a screen reader.

## Usage

```jsx
import { View, VisuallyHidden } from '@wordpress/components/ui';

function Example() {
return (
<VisuallyHidden>
<View as="label">Code is Poetry</View>
</VisuallyHidden>
);
}
```
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Internal dependencies
*/
import { createComponent } from '../ui/utils';
import { createComponent } from '../utils';
import { useVisuallyHidden } from './hook';

/**
Expand All @@ -10,12 +10,12 @@ import { useVisuallyHidden } from './hook';
*
* @example
* ```jsx
* import { VisuallyHidden } from `@wordpress/components`;
* import { View, VisuallyHidden } from `@wordpress/components/ui`;
*
* function Example() {
* return (
* <VisuallyHidden>
* <label>Code is Poetry</label>
* <View as="label">Code is Poetry</View>
* </VisuallyHidden>
* );
* }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ import { cx } from 'emotion';
*/
import * as styles from './styles';

// duplicate this for the sake of being able to export it, it'll be removed when we replace VisuallyHidden in components/src anyway
/** @typedef {import('../context').ViewOwnProps<{}, 'div'>} Props */

/**
* @param {import('../ui/context').ViewOwnProps<{}, 'div'>} props
* @param {import('../context').ViewOwnProps<{}, 'div'>} props
*/
export function useVisuallyHidden( { className, ...props } ) {
// circumvent the context system and write the classnames ourselves
const classes = cx(
'components-visually-hidden',
'components-visually-hidden wp-components-visually-hidden',
className,
styles.VisuallyHidden
);
Expand Down
2 changes: 2 additions & 0 deletions packages/components/src/ui/visually-hidden/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { default as VisuallyHidden } from './component';
export * from './hook';
42 changes: 42 additions & 0 deletions packages/components/src/ui/visually-hidden/stories/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* Internal dependencies
*/
import { VisuallyHidden } from '..';

export default {
title: 'G2 Components (Experimental)/VisuallyHidden',
component: VisuallyHidden,
};

export const _default = () => (
<>
<VisuallyHidden>This should not show.</VisuallyHidden>
<div>
This text will{ ' ' }
<VisuallyHidden as="span">but not inline </VisuallyHidden> always
show.
</div>
</>
);

export const withForwardedProps = () => (
<>
Additional props can be passed to VisuallyHidden and are forwarded to
the rendered element.{ ' ' }
<VisuallyHidden as="span" data-id="test">
Check out my data attribute!{ ' ' }
</VisuallyHidden>
Inspect the HTML to see!
</>
);

export const withAdditionalClassNames = () => (
<>
Additional class names passed to VisuallyHidden extend the component
class name.{ ' ' }
<VisuallyHidden as="label" className="test-input">
Check out my class!{ ' ' }
</VisuallyHidden>
Inspect the HTML to see!
</>
);
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@
* External dependencies
*/
import { css } from 'emotion';

/**
* Internal dependencies
*/
import { COLORS } from '../utils/colors-values';
import { COLORS } from '../../utils/colors-values';

export const VisuallyHidden = css`
border: 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ exports[`VisuallyHidden should render correctly 1`] = `
}
<div
class="components-visually-hidden emotion-0 emotion-1 emotion-2"
class="components-visually-hidden wp-components-visually-hidden emotion-0 emotion-1 emotion-2"
>
This is hidden
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { render } from '@testing-library/react';
/**
* Internal dependencies
*/
import VisuallyHidden, { useVisuallyHidden } from '..';
import { VisuallyHidden, useVisuallyHidden } from '..';

describe( 'useVisuallyHidden', () => {
it( 'should apply the expected classnames', () => {
Expand Down
14 changes: 3 additions & 11 deletions packages/components/src/visually-hidden/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
# VisuallyHidden

`VisuallyHidden` is a component used to render text intended to be visually hidden, but will show for alternate devices, for example a screen reader.
A component used to render text intended to be visually hidden, but will show for alternate devices, for example a screen reader.

## Usage
### Usage

```jsx
import { VisuallyHidden } from '@wordpress/components';

function Example() {
return (
<VisuallyHidden>
<label>Code is Poetry</label>
</VisuallyHidden>
);
}
<VisuallyHidden> Show text for screenreader. </VisuallyHidden>
```
Loading

0 comments on commit 4dbd9e0

Please sign in to comment.