@atlaskit/onboarding 14.3.8 → 14.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/onboarding
 
+## 14.4.0
+
+### Minor Changes
+
+- [`098c92cc2bdcd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/098c92cc2bdcd) -
+  Add `checkVisibility` to `useSpotlight` return value, allowing consumers to determine whether a
+  spotlight target is visible as determined by `checkVisibility`
+
 ## 14.3.8
 
 ### Patch Changes

package/dist/cjs/components/use-spotlight.js

@@ -19,9 +19,16 @@ function useSpotlight() {
   var isTargetRendered = (0, _react.useCallback)(function (target) {
     return !!targetRef.current[target];
   }, []);
+  var checkVisibility = (0, _react.useCallback)(function (target) {
+    var _targetRef$current$ta;
+    return ((_targetRef$current$ta = targetRef.current[target]) === null || _targetRef$current$ta === void 0 ? void 0 : _targetRef$current$ta.checkVisibility) || function () {
+      return false;
+    };
+  }, []);
   return (0, _react.useMemo)(function () {
     return {
-      isTargetRendered: isTargetRendered
+      isTargetRendered: isTargetRendered,
+      checkVisibility: checkVisibility
     };
-  }, [isTargetRendered]);
+  }, [isTargetRendered, checkVisibility]);
 }

package/dist/es2019/components/use-spotlight.js

@@ -13,7 +13,12 @@ export default function useSpotlight() {
     targetRef.current = targets;
   }, [targets]);
   const isTargetRendered = useCallback(target => !!targetRef.current[target], []);
+  const checkVisibility = useCallback(target => {
+    var _targetRef$current$ta;
+    return ((_targetRef$current$ta = targetRef.current[target]) === null || _targetRef$current$ta === void 0 ? void 0 : _targetRef$current$ta.checkVisibility) || (() => false);
+  }, []);
   return useMemo(() => ({
-    isTargetRendered
-  }), [isTargetRendered]);
+    isTargetRendered,
+    checkVisibility
+  }), [isTargetRendered, checkVisibility]);
 }

package/dist/esm/components/use-spotlight.js

@@ -14,9 +14,16 @@ export default function useSpotlight() {
   var isTargetRendered = useCallback(function (target) {
     return !!targetRef.current[target];
   }, []);
+  var checkVisibility = useCallback(function (target) {
+    var _targetRef$current$ta;
+    return ((_targetRef$current$ta = targetRef.current[target]) === null || _targetRef$current$ta === void 0 ? void 0 : _targetRef$current$ta.checkVisibility) || function () {
+      return false;
+    };
+  }, []);
   return useMemo(function () {
     return {
-      isTargetRendered: isTargetRendered
+      isTargetRendered: isTargetRendered,
+      checkVisibility: checkVisibility
     };
-  }, [isTargetRendered]);
+  }, [isTargetRendered, checkVisibility]);
 }

package/dist/types/components/use-spotlight.d.ts

@@ -3,4 +3,5 @@
  */
 export default function useSpotlight(): {
     isTargetRendered: (target: string) => boolean;
+    checkVisibility: (target: string) => (options?: CheckVisibilityOptions) => boolean;
 };

package/dist/types-ts4.5/components/use-spotlight.d.ts

@@ -3,4 +3,5 @@
  */
 export default function useSpotlight(): {
     isTargetRendered: (target: string) => boolean;
+    checkVisibility: (target: string) => (options?: CheckVisibilityOptions) => boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/onboarding",
-	"version": "14.3.8",
+	"version": "14.4.0",
 	"description": "An onboarding spotlight introduces new features to users through focused messages or multi-step tours.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"