@atlaskit/focus-ring 1.0.6 → 1.0.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/focus-ring
 
+## 1.0.7
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 1.0.6
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/focus-ring",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/focus-ring",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/focus-ring",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"sideEffects": false
 }

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

@@ -0,0 +1,23 @@
+/** @jsx jsx */
+import { FC } from 'react';
+import type { FocusRingProps } from './types';
+/**
+ * __Focus ring__
+ *
+ * A focus ring is used indicate the currently focused item.
+ *
+ * - [Code](https://atlaskit.atlassian.com/packages/design-system/focus-ring)
+ *
+ * @example
+ * ```jsx
+ * import FocusRing from '@atlaskit/focus-ring';
+ *
+ * const InteractiveComponent = () => (
+ *   <FocusRing>
+ *     <button type="button">Hello</button>
+ *   </FocusRing>
+ * )
+ * ```
+ */
+declare const FocusRing: FC<FocusRingProps>;
+export default FocusRing;

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

@@ -0,0 +1,3 @@
+export { default } from './focus-ring';
+export { default as useFocusRing } from './use-focus-ring';
+export type { FocusRingProps, FocusEventHandlers, FocusState } from './types';

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

@@ -0,0 +1,22 @@
+import type { FocusEventHandler, ReactElement } from 'react';
+export interface FocusEventHandlers {
+    onFocus: FocusEventHandler;
+    onBlur: FocusEventHandler;
+}
+export declare type FocusState = 'on' | 'off';
+export interface FocusRingProps {
+    /**
+     * Makes the `FocusRing` a controlled component (opting out of native focus behavior). The focus ring
+     * will apply the visual focus indicator when the `focus` prop is set to `on`. This prop should be used
+     * in conjunction with `useFocusRing`.
+     */
+    focus?: FocusState;
+    /**
+     * Controls whether the focus ring should be applied around or within the composed element.
+     */
+    isInset?: boolean;
+    /**
+     * The focusable element to be rendered within the `FocusRing`.
+     */
+    children: ReactElement;
+}

package/dist/types-ts4.0/use-focus-ring.d.ts

@@ -0,0 +1,34 @@
+import type { FocusEventHandlers, FocusState } from './types';
+/**
+ * __Use focus ring__
+ *
+ * The `useFocusRing` hook is designed to manage focus for the `FocusRing` in cases where the `FocusRing`'s visual application
+ * and the element that takes focus, differ. See the `focus` prop of `FocusRing` for more information.
+ *
+ * @example
+ * ```jsx
+ * import VisuallyHidden from '@atlaskit/visuall-hidden';
+ * import FocusRing, { useFocusRing } from '@atlaskit/focus-ring';
+ *
+ * const InteractiveComponent = () => {
+ *  const { focusState, focusProps } = useFocusRing();
+ *
+ *  return (
+ *    <div>
+ *      <VisuallHidden>
+ *        <input {...focusProps} />
+ *      </VisuallyHidden>
+ *      <FocusRing focus={focusState}>
+ *        <div role="button">Hello</div>
+ *      </FocusRing>
+ *    </div>
+ *  );
+ *
+ * }
+ * ```
+ */
+declare const useFocusRing: (initialState?: FocusState) => {
+    readonly focusState: "on" | "off";
+    readonly focusProps: FocusEventHandlers;
+};
+export default useFocusRing;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/focus-ring",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "A focus ring is used to indicate the currently focused item.",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -20,13 +20,20 @@
   "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/*"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "af:exports": {
     ".": "./src/index.tsx"
   },
   "dependencies": {
-    "@atlaskit/theme": "^12.1.0",
+    "@atlaskit/theme": "^12.2.0",
     "@atlaskit/tokens": "^0.10.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/core": "^10.0.9"
@@ -37,16 +44,16 @@
   "devDependencies": {
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/progress-indicator": "^9.2.0",
+    "@atlaskit/progress-indicator": "^9.3.0",
     "@atlaskit/ssr": "*",
-    "@atlaskit/textfield": "^5.1.2",
+    "@atlaskit/textfield": "^5.2.0",
     "@atlaskit/visual-regression": "*",
-    "@atlaskit/visually-hidden": "^1.0.0",
+    "@atlaskit/visually-hidden": "^1.1.0",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
-    "@testing-library/react": "^8.0.1",
+    "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",
-    "typescript": "4.3.5",
+    "typescript": "4.5.5",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {