@atlaskit/visually-hidden 1.0.1 → 1.0.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 +6 -0
- package/README.md +3 -3
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/package.json +8 -5
- package/report.api.md +53 -0
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Visually hidden
|
|
2
2
|
|
|
3
3
|
A composable element that hides elements from the screen while keeping them accessible.
|
|
4
4
|
|
|
@@ -15,8 +15,8 @@ import VisuallyHidden from '@atlaskit/visually-hidden';
|
|
|
15
15
|
|
|
16
16
|
export default () => (
|
|
17
17
|
<div style={{ border: '1px solid black' }}>
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
There is text hidden between the brackets [
|
|
19
|
+
<VisuallyHidden>Can't see me!</VisuallyHidden>]
|
|
20
20
|
</div>
|
|
21
21
|
);
|
|
22
22
|
```
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/visually-hidden",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.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",
|
|
@@ -12,10 +12,11 @@
|
|
|
12
12
|
"inPublicMirror": true,
|
|
13
13
|
"releaseModel": "scheduled",
|
|
14
14
|
"website": {
|
|
15
|
-
"name": "Visually hidden"
|
|
15
|
+
"name": "Visually hidden",
|
|
16
|
+
"category": "Components"
|
|
16
17
|
}
|
|
17
18
|
},
|
|
18
|
-
"repository": "https://bitbucket.org/atlassian/atlassian-frontend",
|
|
19
|
+
"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
|
|
19
20
|
"main": "dist/cjs/index.js",
|
|
20
21
|
"module": "dist/esm/index.js",
|
|
21
22
|
"module:es2019": "dist/es2019/index.js",
|
|
@@ -35,12 +36,12 @@
|
|
|
35
36
|
"devDependencies": {
|
|
36
37
|
"@atlaskit/docs": "*",
|
|
37
38
|
"@atlaskit/ssr": "*",
|
|
38
|
-
"@atlaskit/visual-regression": "^0.
|
|
39
|
+
"@atlaskit/visual-regression": "^0.8.0",
|
|
39
40
|
"@atlaskit/webdriver-runner": "*",
|
|
40
41
|
"@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
|
|
41
42
|
"@testing-library/react": "^8.0.1",
|
|
42
43
|
"react-dom": "^16.8.0",
|
|
43
|
-
"typescript": "4.
|
|
44
|
+
"typescript": "4.3.5",
|
|
44
45
|
"wait-for-expect": "^1.2.0"
|
|
45
46
|
},
|
|
46
47
|
"techstack": {
|
|
@@ -49,6 +50,7 @@
|
|
|
49
50
|
"circular-dependencies": "file-and-folder-level"
|
|
50
51
|
},
|
|
51
52
|
"@repo/internal": {
|
|
53
|
+
"dom-events": "use-bind-event-listener",
|
|
52
54
|
"design-system": "v1",
|
|
53
55
|
"styling": [
|
|
54
56
|
"static",
|
|
@@ -60,5 +62,6 @@
|
|
|
60
62
|
"deprecation": "no-deprecated-imports"
|
|
61
63
|
}
|
|
62
64
|
},
|
|
65
|
+
"homepage": "https://atlaskit.atlassian.com/packages/design-system/visually-hidden",
|
|
63
66
|
"prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
|
|
64
67
|
}
|
package/report.api.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/visually-hidden"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
````ts
|
|
6
|
+
import { FC } from 'react';
|
|
7
|
+
import { ReactNode } from 'react';
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* __Visually hidden__
|
|
11
|
+
*
|
|
12
|
+
* A composable element to apply a visually hidden effect to children.
|
|
13
|
+
* Useful for accessibility compliance.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```jsx
|
|
17
|
+
* import VisuallyHidden from '@atlaskit/visually-hidden';
|
|
18
|
+
*
|
|
19
|
+
* export default () => (
|
|
20
|
+
* <div style={{ border: '1px solid black' }}>
|
|
21
|
+
* There is text hidden between the brackets [
|
|
22
|
+
* <VisuallyHidden>Can't see me!</VisuallyHidden>]
|
|
23
|
+
* </div>
|
|
24
|
+
* );
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
declare const VisuallyHidden: FC<VisuallyHiddenProps>;
|
|
28
|
+
export default VisuallyHidden;
|
|
29
|
+
|
|
30
|
+
export declare type VisuallyHiddenProps = {
|
|
31
|
+
/**
|
|
32
|
+
* A `testId` prop is provided for specified elements, which is a unique
|
|
33
|
+
* string that appears as a data attribute `data-testid` in the rendered code,
|
|
34
|
+
* serving as a hook for automated tests
|
|
35
|
+
*/
|
|
36
|
+
testId?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The element or elements that should be hidden.
|
|
39
|
+
*/
|
|
40
|
+
children: ReactNode;
|
|
41
|
+
/**
|
|
42
|
+
* Role attribute is passed on to the span to aid screen readers.
|
|
43
|
+
*/
|
|
44
|
+
role?: string;
|
|
45
|
+
/**
|
|
46
|
+
* An id may be appropriate for this component if used in conjunction with `aria-describedby`
|
|
47
|
+
* on a paired element.
|
|
48
|
+
*/
|
|
49
|
+
id?: string;
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
export {};
|
|
53
|
+
````
|