@atlaskit/visually-hidden 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/visually-hidden
2
2
 
3
+ ## 1.2.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [`b1bdec7cce2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b1bdec7cce2) - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change.
8
+
9
+ ## 1.2.2
10
+
11
+ ### Patch Changes
12
+
13
+ - [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
14
+
3
15
  ## 1.2.1
4
16
 
5
17
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/visually-hidden",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/visually-hidden",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/visually-hidden",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,2 @@
1
+ export { default } from './visually-hidden';
2
+ export type { VisuallyHiddenProps } from './types';
@@ -0,0 +1,22 @@
1
+ import { ReactNode } from 'react';
2
+ export type VisuallyHiddenProps = {
3
+ /**
4
+ * The element or elements that should be hidden.
5
+ */
6
+ children: ReactNode;
7
+ /**
8
+ * An ARIA role attribute to aid screen readers.
9
+ */
10
+ role?: string;
11
+ /**
12
+ * An id may be appropriate for this component if used in conjunction with `aria-describedby`
13
+ * on a paired element.
14
+ */
15
+ id?: string;
16
+ /**
17
+ * A `testId` prop is provided for specified elements, which is a unique
18
+ * string that appears as a data attribute `data-testid` in the rendered code,
19
+ * serving as a hook for automated tests.
20
+ */
21
+ testId?: string;
22
+ };
@@ -0,0 +1,23 @@
1
+ /** @jsx jsx */
2
+ import { FC } from 'react';
3
+ import type { VisuallyHiddenProps } from './types';
4
+ /**
5
+ * __Visually hidden__
6
+ *
7
+ * A composable element to apply a visually hidden effect to children.
8
+ * Useful for accessibility compliance.
9
+ *
10
+ * @example
11
+ * ```jsx
12
+ * import VisuallyHidden from '@atlaskit/visually-hidden';
13
+ *
14
+ * export default () => (
15
+ * <div style={{ border: '1px solid black' }}>
16
+ * There is text hidden between the brackets [
17
+ * <VisuallyHidden>Can't see me!</VisuallyHidden>]
18
+ * </div>
19
+ * );
20
+ * ```
21
+ */
22
+ declare const VisuallyHidden: FC<VisuallyHiddenProps>;
23
+ export default VisuallyHidden;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/visually-hidden",
3
- "version": "1.2.1",
3
+ "version": "1.2.3",
4
4
  "description": "A utility that hides content from the screen while retaining readability by screen readers for accessibility.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -72,7 +72,8 @@
72
72
  "ui-components": "lite-mode",
73
73
  "analytics": "analytics-next",
74
74
  "design-tokens": [
75
- "color"
75
+ "color",
76
+ "spacing"
76
77
  ],
77
78
  "deprecation": "no-deprecated-imports"
78
79
  }