@atlaskit/visually-hidden 1.1.2 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/visually-hidden
 
+## 1.2.0
+
+### Minor Changes
+
+- [`56507598609`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56507598609) - Skip minor dependency bump
+
 ## 1.1.2
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # Visually hidden
 
-A composable element that hides elements from the screen while keeping them accessible.
+A utility that hides content from the screen while retaining readability by screen readers for accessibility.
 
 ## Installation
 
@@ -10,13 +10,4 @@ yarn add @atlaskit/visually-hidden
 
 ## Usage
 
-```jsx
-import VisuallyHidden from '@atlaskit/visually-hidden';
-
-export default () => (
-  <div style={{ border: '1px solid black' }}>
-    There is text hidden between the brackets [
-    <VisuallyHidden>Can't see me!</VisuallyHidden>]
-  </div>
-);
-```
+[View documentation](https://atlassian.design/components/visually-hidden/).

package/dist/cjs/index.js

@@ -1,7 +1,6 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -11,5 +10,4 @@ Object.defineProperty(exports, "default", {
     return _visuallyHidden.default;
   }
 });
-
 var _visuallyHidden = _interopRequireDefault(require("./visually-hidden"));

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/visually-hidden",
-	"version": "1.1.2",
+	"version": "1.2.0",
 	"sideEffects": false
 }

package/dist/cjs/visually-hidden.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _react = require("@emotion/react");
-
 /** @jsx jsx */
+
 // eslint-disable-next-line @atlaskit/design-system/use-visually-hidden
 var visuallyHiddenStyles = (0, _react.css)({
   width: '1px',
@@ -19,6 +18,7 @@ var visuallyHiddenStyles = (0, _react.css)({
   overflow: 'hidden',
   whiteSpace: 'nowrap'
 });
+
 /**
  * __Visually hidden__
  *
@@ -37,12 +37,11 @@ var visuallyHiddenStyles = (0, _react.css)({
  * );
  * ```
  */
-
 var VisuallyHidden = function VisuallyHidden(_ref) {
   var children = _ref.children,
-      testId = _ref.testId,
-      role = _ref.role,
-      id = _ref.id;
+    testId = _ref.testId,
+    role = _ref.role,
+    id = _ref.id;
   return (0, _react.jsx)("span", {
     id: id,
     "data-testid": testId,
@@ -50,6 +49,5 @@ var VisuallyHidden = function VisuallyHidden(_ref) {
     role: role
   }, children);
 };
-
 var _default = VisuallyHidden;
 exports.default = _default;

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/visually-hidden",
-	"version": "1.1.2",
+	"version": "1.2.0",
 	"sideEffects": false
 }

package/dist/es2019/visually-hidden.js

@@ -1,4 +1,5 @@
 /** @jsx jsx */
+
 import { css, jsx } from '@emotion/react';
 // eslint-disable-next-line @atlaskit/design-system/use-visually-hidden
 const visuallyHiddenStyles = css({
@@ -11,6 +12,7 @@ const visuallyHiddenStyles = css({
   overflow: 'hidden',
   whiteSpace: 'nowrap'
 });
+
 /**
  * __Visually hidden__
  *
@@ -29,7 +31,6 @@ const visuallyHiddenStyles = css({
  * );
  * ```
  */
-
 const VisuallyHidden = ({
   children,
   testId,
@@ -43,5 +44,4 @@ const VisuallyHidden = ({
     role: role
   }, children);
 };
-
 export default VisuallyHidden;

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/visually-hidden",
-	"version": "1.1.2",
+	"version": "1.2.0",
 	"sideEffects": false
 }

package/dist/esm/visually-hidden.js

@@ -1,4 +1,5 @@
 /** @jsx jsx */
+
 import { css, jsx } from '@emotion/react';
 // eslint-disable-next-line @atlaskit/design-system/use-visually-hidden
 var visuallyHiddenStyles = css({
@@ -11,6 +12,7 @@ var visuallyHiddenStyles = css({
   overflow: 'hidden',
   whiteSpace: 'nowrap'
 });
+
 /**
  * __Visually hidden__
  *
@@ -29,12 +31,11 @@ var visuallyHiddenStyles = css({
  * );
  * ```
  */
-
 var VisuallyHidden = function VisuallyHidden(_ref) {
   var children = _ref.children,
-      testId = _ref.testId,
-      role = _ref.role,
-      id = _ref.id;
+    testId = _ref.testId,
+    role = _ref.role,
+    id = _ref.id;
   return jsx("span", {
     id: id,
     "data-testid": testId,
@@ -42,5 +43,4 @@ var VisuallyHidden = function VisuallyHidden(_ref) {
     role: role
   }, children);
 };
-
 export default VisuallyHidden;

package/dist/types/types.d.ts

@@ -1,17 +1,11 @@
 import { ReactNode } from 'react';
 export declare type VisuallyHiddenProps = {
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique
-     * string that appears as a data attribute `data-testid` in the rendered code,
-     * serving as a hook for automated tests
-     */
-    testId?: string;
     /**
      * The element or elements that should be hidden.
      */
     children: ReactNode;
     /**
-     * Role attribute is passed on to the span to aid screen readers.
+     * An ARIA role attribute to aid screen readers.
      */
     role?: string;
     /**
@@ -19,4 +13,10 @@ export declare type VisuallyHiddenProps = {
      * on a paired element.
      */
     id?: string;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+     */
+    testId?: string;
 };

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@atlaskit/visually-hidden",
-  "version": "1.1.2",
-  "description": "A composable element that hides elements from the screen while keeping them accessible.",
+  "version": "1.2.0",
+  "description": "A utility that hides content from the screen while retaining readability by screen readers for accessibility.",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
   "atlassian": {
-    "disableProductCI": true,
     "team": "Design System Team",
     "inPublicMirror": true,
     "releaseModel": "scheduled",
@@ -22,14 +21,6 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.0 <4.5": {
-      "*": [
-        "dist/types-ts4.0/*",
-        "dist/types-ts4.0/index.d.ts"
-      ]
-    }
-  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "af:exports": {
@@ -43,9 +34,13 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
+    "@atlaskit/button": "^16.7.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/ds-lib": "^2.0.1",
+    "@atlaskit/ds-lib": "^2.2.0",
+    "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/ssr": "*",
+    "@atlaskit/toggle": "^12.6.0",
+    "@atlaskit/tokens": "^1.3.0",
     "@atlaskit/visual-regression": "^0.8.0",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
@@ -68,10 +63,12 @@
       ],
       "ui-components": "lite-mode",
       "analytics": "analytics-next",
-      "theming": "tokens",
+      "design-tokens": [
+        "color"
+      ],
       "deprecation": "no-deprecated-imports"
     }
   },
-  "homepage": "https://atlaskit.atlassian.com/packages/design-system/visually-hidden",
+  "homepage": "https://atlassian.design/components/visually-hidden/",
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
 }

package/report.api.md

@@ -1,55 +1,35 @@
-## API Report File for "@atlaskit/visually-hidden".
+<!-- API Report Version: 2.3 -->
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+## API Report File for "@atlaskit/visually-hidden"
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
-````ts
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
 import { FC } from 'react';
 import { ReactNode } from 'react';
 
-/**
- * __Visually hidden__
- *
- * A composable element to apply a visually hidden effect to children.
- * Useful for accessibility compliance.
- *
- * @example
- * ```jsx
- * import VisuallyHidden from '@atlaskit/visually-hidden';
- *
- * export default () => (
- *   <div style={{ border: '1px solid black' }}>
- *      There is text hidden between the brackets [
- *      <VisuallyHidden>Can't see me!</VisuallyHidden>]
- *   </div>
- * );
- * ```
- */
-declare const VisuallyHidden: FC<VisuallyHiddenProps>;
+// @public
+const VisuallyHidden: FC<VisuallyHiddenProps>;
 export default VisuallyHidden;
 
-export declare type VisuallyHiddenProps = {
-  /**
-   * A `testId` prop is provided for specified elements, which is a unique
-   * string that appears as a data attribute `data-testid` in the rendered code,
-   * serving as a hook for automated tests
-   */
+// @public (undocumented)
+export type VisuallyHiddenProps = {
   testId?: string;
-  /**
-   * The element or elements that should be hidden.
-   */
   children: ReactNode;
-  /**
-   * Role attribute is passed on to the span to aid screen readers.
-   */
   role?: string;
-  /**
-   * An id may be appropriate for this component if used in conjunction with `aria-describedby`
-   * on a paired element.
-   */
   id?: string;
 };
 
-export {};
-````
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->

package/dist/types-ts4.0/index.d.ts

@@ -1,2 +0,0 @@
-export { default } from './visually-hidden';
-export type { VisuallyHiddenProps } from './types';

package/dist/types-ts4.0/types.d.ts

@@ -1,22 +0,0 @@
-import { ReactNode } from 'react';
-export declare type VisuallyHiddenProps = {
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique
-     * string that appears as a data attribute `data-testid` in the rendered code,
-     * serving as a hook for automated tests
-     */
-    testId?: string;
-    /**
-     * The element or elements that should be hidden.
-     */
-    children: ReactNode;
-    /**
-     * Role attribute is passed on to the span to aid screen readers.
-     */
-    role?: string;
-    /**
-     * An id may be appropriate for this component if used in conjunction with `aria-describedby`
-     * on a paired element.
-     */
-    id?: string;
-};

package/dist/types-ts4.0/visually-hidden.d.ts

@@ -1,23 +0,0 @@
-/** @jsx jsx */
-import { FC } from 'react';
-import type { VisuallyHiddenProps } from './types';
-/**
- * __Visually hidden__
- *
- * A composable element to apply a visually hidden effect to children.
- * Useful for accessibility compliance.
- *
- * @example
- * ```jsx
- * import VisuallyHidden from '@atlaskit/visually-hidden';
- *
- * export default () => (
- *   <div style={{ border: '1px solid black' }}>
- *      There is text hidden between the brackets [
- *      <VisuallyHidden>Can't see me!</VisuallyHidden>]
- *   </div>
- * );
- * ```
- */
-declare const VisuallyHidden: FC<VisuallyHiddenProps>;
-export default VisuallyHidden;