@atlaskit/visually-hidden 1.1.0 → 1.1.2
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 +12 -0
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/dist/types-ts4.0/index.d.ts +2 -0
- package/dist/types-ts4.0/types.d.ts +22 -0
- package/dist/types-ts4.0/visually-hidden.d.ts +23 -0
- package/package.json +12 -3
- package/report.api.md +4 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/visually-hidden
|
|
2
2
|
|
|
3
|
+
## 1.1.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components.
|
|
8
|
+
|
|
9
|
+
## 1.1.1
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
|
|
14
|
+
|
|
3
15
|
## 1.1.0
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { ReactNode } from 'react';
|
|
2
|
+
export declare type VisuallyHiddenProps = {
|
|
3
|
+
/**
|
|
4
|
+
* A `testId` prop is provided for specified elements, which is a unique
|
|
5
|
+
* string that appears as a data attribute `data-testid` in the rendered code,
|
|
6
|
+
* serving as a hook for automated tests
|
|
7
|
+
*/
|
|
8
|
+
testId?: string;
|
|
9
|
+
/**
|
|
10
|
+
* The element or elements that should be hidden.
|
|
11
|
+
*/
|
|
12
|
+
children: ReactNode;
|
|
13
|
+
/**
|
|
14
|
+
* Role attribute is passed on to the span to aid screen readers.
|
|
15
|
+
*/
|
|
16
|
+
role?: string;
|
|
17
|
+
/**
|
|
18
|
+
* An id may be appropriate for this component if used in conjunction with `aria-describedby`
|
|
19
|
+
* on a paired element.
|
|
20
|
+
*/
|
|
21
|
+
id?: 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.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "A composable element that hides elements from the screen while keeping them accessible.",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"registry": "https://registry.npmjs.org/"
|
|
9
9
|
},
|
|
10
10
|
"atlassian": {
|
|
11
|
+
"disableProductCI": true,
|
|
11
12
|
"team": "Design System Team",
|
|
12
13
|
"inPublicMirror": true,
|
|
13
14
|
"releaseModel": "scheduled",
|
|
@@ -21,6 +22,14 @@
|
|
|
21
22
|
"module": "dist/esm/index.js",
|
|
22
23
|
"module:es2019": "dist/es2019/index.js",
|
|
23
24
|
"types": "dist/types/index.d.ts",
|
|
25
|
+
"typesVersions": {
|
|
26
|
+
">=4.0 <4.5": {
|
|
27
|
+
"*": [
|
|
28
|
+
"dist/types-ts4.0/*",
|
|
29
|
+
"dist/types-ts4.0/index.d.ts"
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
},
|
|
24
33
|
"sideEffects": false,
|
|
25
34
|
"atlaskit:src": "src/index.tsx",
|
|
26
35
|
"af:exports": {
|
|
@@ -40,9 +49,9 @@
|
|
|
40
49
|
"@atlaskit/visual-regression": "^0.8.0",
|
|
41
50
|
"@atlaskit/webdriver-runner": "*",
|
|
42
51
|
"@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
|
|
43
|
-
"@testing-library/react": "^
|
|
52
|
+
"@testing-library/react": "^12.1.5",
|
|
44
53
|
"react-dom": "^16.8.0",
|
|
45
|
-
"typescript": "4.
|
|
54
|
+
"typescript": "4.5.5",
|
|
46
55
|
"wait-for-expect": "^1.2.0"
|
|
47
56
|
},
|
|
48
57
|
"techstack": {
|
package/report.api.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/visually-hidden"
|
|
1
|
+
## API Report File for "@atlaskit/visually-hidden".
|
|
2
2
|
|
|
3
|
-
> Do not edit this file.
|
|
3
|
+
> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
4
6
|
|
|
5
7
|
````ts
|
|
6
8
|
import { FC } from 'react';
|