@atlaskit/spotlight 0.0.12 → 0.0.14

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/spotlight
 
+## 0.0.14
+
+### Patch Changes
+
+- [`85a83a17c7d56`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/85a83a17c7d56) -
+  Tweak offset of caret positioning so as not to overlap the target component.
+- Updated dependencies
+
+## 0.0.13
+
+### Patch Changes
+
+- [`15963c2a4fb01`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/15963c2a4fb01) -
+  Create StepCount component.
+
 ## 0.0.12
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -93,6 +93,12 @@ Object.defineProperty(exports, "SpotlightShowMoreControl", {
     return _showMoreControl.SpotlightShowMoreControl;
   }
 });
+Object.defineProperty(exports, "SpotlightStepCount", {
+  enumerable: true,
+  get: function get() {
+    return _stepCount.SpotlightStepCount;
+  }
+});
 Object.defineProperty(exports, "TourContext", {
   enumerable: true,
   get: function get() {
@@ -111,6 +117,7 @@ var _header = require("./ui/header");
 var _headline = require("./ui/headline");
 var _footer = require("./ui/footer");
 var _actions = require("./ui/actions");
+var _stepCount = require("./ui/step-count");
 var _primaryAction = require("./ui/primary-action");
 var _secondaryAction = require("./ui/secondary-action");
 var _controls = require("./ui/controls");

package/dist/cjs/ui/popover-content/index.js

@@ -17,6 +17,16 @@ var styles = {
   visible: "_lcxv1wug _3um0ewfl",
   hidden: "_lcxvglyw _3um015vq"
 };
+
+/**
+ * The `transform: rotate(45deg);` styles used to rotate the `Caret` component result in the corners of
+ * the caret extending beyond the bounding box (by roughly 2px). So, apply an offset to ensure
+ * the caret points to the very edge of the target element.
+ *
+ * Note: `@atlaskit/popper` maps the offset to to the placement, so we only need to define `[0, 2]` and
+ * the offset will get correctly rotated depending on the placement.
+ */
+var offset = [0, 2];
 /**
  * The Spotlight card can be positioned in many different configurations, but the caret should always point to
  * the center of the target element. `@atlaskit/popper` uses `'top' | 'right' | 'bottom' | 'left'` values for
@@ -51,7 +61,7 @@ var PopoverContent = exports.PopoverContent = function PopoverContent(_ref) {
     setPlacement(placement);
   }, [placement, setPlacement]);
   return /*#__PURE__*/React.createElement(_popper.Popper, {
-    offset: [0, 0],
+    offset: offset,
     placement: popperPlacementMap[placement]
   }, function (_ref2) {
     var ref = _ref2.ref,

package/dist/cjs/ui/step-count/index.compiled.css

@@ -0,0 +1 @@
+._1ul91ris{min-width:max-content}

package/dist/cjs/ui/step-count/index.js

@@ -0,0 +1,32 @@
+/* index.tsx generated by @compiled/babel-plugin v0.36.1 */
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SpotlightStepCount = void 0;
+require("./index.compiled.css");
+var _runtime = require("@compiled/react/runtime");
+var _react = _interopRequireWildcard(require("react"));
+var _compiled = require("@atlaskit/primitives/compiled");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+var styles = {
+  root: "_1ul91ris"
+};
+/**
+ * __Spotlight StepCount__
+ *
+ * `SpotlightStepCount` groups `SpotlightAction` components.
+ *
+ */
+var SpotlightStepCount = exports.SpotlightStepCount = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
+  var children = _ref.children,
+    testId = _ref.testId;
+  return /*#__PURE__*/_react.default.createElement(_compiled.Flex, {
+    xcss: styles.root
+  }, /*#__PURE__*/_react.default.createElement(_compiled.Text, {
+    ref: ref,
+    testId: testId
+  }, children));
+});

package/dist/es2019/index.js

@@ -4,6 +4,7 @@ export { SpotlightHeader } from './ui/header';
 export { SpotlightHeadline } from './ui/headline';
 export { SpotlightFooter } from './ui/footer';
 export { SpotlightActions } from './ui/actions';
+export { SpotlightStepCount } from './ui/step-count';
 export { SpotlightPrimaryAction } from './ui/primary-action';
 export { SpotlightSecondaryAction } from './ui/secondary-action';
 export { SpotlightControls } from './ui/controls';

package/dist/es2019/ui/popover-content/index.js

@@ -9,6 +9,16 @@ const styles = {
   visible: "_lcxv1wug _3um0ewfl",
   hidden: "_lcxvglyw _3um015vq"
 };
+
+/**
+ * The `transform: rotate(45deg);` styles used to rotate the `Caret` component result in the corners of
+ * the caret extending beyond the bounding box (by roughly 2px). So, apply an offset to ensure
+ * the caret points to the very edge of the target element.
+ *
+ * Note: `@atlaskit/popper` maps the offset to to the placement, so we only need to define `[0, 2]` and
+ * the offset will get correctly rotated depending on the placement.
+ */
+const offset = [0, 2];
 /**
  * The Spotlight card can be positioned in many different configurations, but the caret should always point to
  * the center of the target element. `@atlaskit/popper` uses `'top' | 'right' | 'bottom' | 'left'` values for
@@ -44,7 +54,7 @@ export const PopoverContent = ({
     setPlacement(placement);
   }, [placement, setPlacement]);
   return /*#__PURE__*/React.createElement(Popper, {
-    offset: [0, 0],
+    offset: offset,
     placement: popperPlacementMap[placement]
   }, ({
     ref,

package/dist/es2019/ui/step-count/index.compiled.css

@@ -0,0 +1 @@
+._1ul91ris{min-width:max-content}

package/dist/es2019/ui/step-count/index.js

@@ -0,0 +1,25 @@
+/* index.tsx generated by @compiled/babel-plugin v0.36.1 */
+import "./index.compiled.css";
+import { ax, ix } from "@compiled/react/runtime";
+import React, { forwardRef } from 'react';
+import { Flex, Text } from '@atlaskit/primitives/compiled';
+const styles = {
+  root: "_1ul91ris"
+};
+/**
+ * __Spotlight StepCount__
+ *
+ * `SpotlightStepCount` groups `SpotlightAction` components.
+ *
+ */
+export const SpotlightStepCount = /*#__PURE__*/forwardRef(({
+  children,
+  testId
+}, ref) => {
+  return /*#__PURE__*/React.createElement(Flex, {
+    xcss: styles.root
+  }, /*#__PURE__*/React.createElement(Text, {
+    ref: ref,
+    testId: testId
+  }, children));
+});

package/dist/esm/index.js

@@ -4,6 +4,7 @@ export { SpotlightHeader } from './ui/header';
 export { SpotlightHeadline } from './ui/headline';
 export { SpotlightFooter } from './ui/footer';
 export { SpotlightActions } from './ui/actions';
+export { SpotlightStepCount } from './ui/step-count';
 export { SpotlightPrimaryAction } from './ui/primary-action';
 export { SpotlightSecondaryAction } from './ui/secondary-action';
 export { SpotlightControls } from './ui/controls';

package/dist/esm/ui/popover-content/index.js

@@ -9,6 +9,16 @@ var styles = {
   visible: "_lcxv1wug _3um0ewfl",
   hidden: "_lcxvglyw _3um015vq"
 };
+
+/**
+ * The `transform: rotate(45deg);` styles used to rotate the `Caret` component result in the corners of
+ * the caret extending beyond the bounding box (by roughly 2px). So, apply an offset to ensure
+ * the caret points to the very edge of the target element.
+ *
+ * Note: `@atlaskit/popper` maps the offset to to the placement, so we only need to define `[0, 2]` and
+ * the offset will get correctly rotated depending on the placement.
+ */
+var offset = [0, 2];
 /**
  * The Spotlight card can be positioned in many different configurations, but the caret should always point to
  * the center of the target element. `@atlaskit/popper` uses `'top' | 'right' | 'bottom' | 'left'` values for
@@ -43,7 +53,7 @@ export var PopoverContent = function PopoverContent(_ref) {
     setPlacement(placement);
   }, [placement, setPlacement]);
   return /*#__PURE__*/React.createElement(Popper, {
-    offset: [0, 0],
+    offset: offset,
     placement: popperPlacementMap[placement]
   }, function (_ref2) {
     var ref = _ref2.ref,

package/dist/esm/ui/step-count/index.compiled.css

@@ -0,0 +1 @@
+._1ul91ris{min-width:max-content}

package/dist/esm/ui/step-count/index.js

@@ -0,0 +1,24 @@
+/* index.tsx generated by @compiled/babel-plugin v0.36.1 */
+import "./index.compiled.css";
+import { ax, ix } from "@compiled/react/runtime";
+import React, { forwardRef } from 'react';
+import { Flex, Text } from '@atlaskit/primitives/compiled';
+var styles = {
+  root: "_1ul91ris"
+};
+/**
+ * __Spotlight StepCount__
+ *
+ * `SpotlightStepCount` groups `SpotlightAction` components.
+ *
+ */
+export var SpotlightStepCount = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    testId = _ref.testId;
+  return /*#__PURE__*/React.createElement(Flex, {
+    xcss: styles.root
+  }, /*#__PURE__*/React.createElement(Text, {
+    ref: ref,
+    testId: testId
+  }, children));
+});

package/dist/types/index.d.ts

@@ -4,11 +4,12 @@ export { SpotlightHeader, type SpotlightHeaderProps } from './ui/header';
 export { SpotlightHeadline, type SpotlightHeadlineProps } from './ui/headline';
 export { SpotlightFooter, type SpotlightFooterProps } from './ui/footer';
 export { SpotlightActions, type SpotlightActionsProps } from './ui/actions';
+export { SpotlightStepCount, type SpotlightStepCountProps } from './ui/step-count';
 export { SpotlightPrimaryAction, type SpotlightPrimaryActionProps } from './ui/primary-action';
 export { SpotlightSecondaryAction, type SpotlightSecondaryActionProps, } from './ui/secondary-action';
 export { SpotlightControls, type SpotlightControlsProps } from './ui/controls';
 export { SpotlightDismissControl, type SpotlightDismissControlProps } from './ui/dismiss-control';
-export { SpotlightShowMoreControl, type SpotlightShowMoreControlProps } from './ui/show-more-control';
+export { SpotlightShowMoreControl, type SpotlightShowMoreControlProps, } from './ui/show-more-control';
 export { SpotlightMedia, type SpotlightMediaProps } from './ui/media';
 export { PopoverProvider } from './ui/popover-provider';
 export { PopoverContent } from './ui/popover-content';

package/dist/types/ui/step-count/index.d.ts

@@ -0,0 +1,20 @@
+import React, { type ReactNode } from 'react';
+export interface SpotlightStepCountProps {
+    /**
+     * 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;
+    /**
+     * Elements to be rendered inside the `SpotlightStepCount`.
+     */
+    children?: ReactNode;
+}
+/**
+ * __Spotlight StepCount__
+ *
+ * `SpotlightStepCount` groups `SpotlightAction` components.
+ *
+ */
+export declare const SpotlightStepCount: React.ForwardRefExoticComponent<SpotlightStepCountProps & React.RefAttributes<HTMLSpanElement>>;

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

@@ -4,11 +4,12 @@ export { SpotlightHeader, type SpotlightHeaderProps } from './ui/header';
 export { SpotlightHeadline, type SpotlightHeadlineProps } from './ui/headline';
 export { SpotlightFooter, type SpotlightFooterProps } from './ui/footer';
 export { SpotlightActions, type SpotlightActionsProps } from './ui/actions';
+export { SpotlightStepCount, type SpotlightStepCountProps } from './ui/step-count';
 export { SpotlightPrimaryAction, type SpotlightPrimaryActionProps } from './ui/primary-action';
 export { SpotlightSecondaryAction, type SpotlightSecondaryActionProps, } from './ui/secondary-action';
 export { SpotlightControls, type SpotlightControlsProps } from './ui/controls';
 export { SpotlightDismissControl, type SpotlightDismissControlProps } from './ui/dismiss-control';
-export { SpotlightShowMoreControl, type SpotlightShowMoreControlProps } from './ui/show-more-control';
+export { SpotlightShowMoreControl, type SpotlightShowMoreControlProps, } from './ui/show-more-control';
 export { SpotlightMedia, type SpotlightMediaProps } from './ui/media';
 export { PopoverProvider } from './ui/popover-provider';
 export { PopoverContent } from './ui/popover-content';

package/dist/types-ts4.5/ui/step-count/index.d.ts

@@ -0,0 +1,20 @@
+import React, { type ReactNode } from 'react';
+export interface SpotlightStepCountProps {
+    /**
+     * 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;
+    /**
+     * Elements to be rendered inside the `SpotlightStepCount`.
+     */
+    children?: ReactNode;
+}
+/**
+ * __Spotlight StepCount__
+ *
+ * `SpotlightStepCount` groups `SpotlightAction` components.
+ *
+ */
+export declare const SpotlightStepCount: React.ForwardRefExoticComponent<SpotlightStepCountProps & React.RefAttributes<HTMLSpanElement>>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/spotlight",
-	"version": "0.0.12",
+	"version": "0.0.14",
 	"description": "A spotlight introduces users to various points of interest across Atlassian through focused messages or multi-step tours.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,7 +29,7 @@
 		".": "./src/index.tsx"
 	},
 	"dependencies": {
-		"@atlaskit/button": "^23.3.0",
+		"@atlaskit/button": "^23.4.0",
 		"@atlaskit/css": "^0.12.0",
 		"@atlaskit/heading": "^5.2.0",
 		"@atlaskit/icon": "^27.12.0",