@atlaskit/onboarding 11.6.0 → 11.7.0

package/package.json

@@ -1,104 +1,104 @@
 {
-  "name": "@atlaskit/onboarding",
-  "version": "11.6.0",
-  "description": "An onboarding spotlight introduces new features to users through focused messages or multi-step tours.",
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
-  "author": "Atlassian Pty Ltd",
-  "license": "Apache-2.0",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
-  "module:es2019": "dist/es2019/index.js",
-  "types": "dist/types/index.d.ts",
-  "typesVersions": {
-    ">=4.5 <4.9": {
-      "*": [
-        "dist/types-ts4.5/*",
-        "dist/types-ts4.5/index.d.ts"
-      ]
-    }
-  },
-  "sideEffects": false,
-  "atlaskit:src": "src/index.tsx",
-  "af:exports": {
-    ".": "./src/index.tsx",
-    "./types": "./src/types.tsx"
-  },
-  "homepage": "https://atlassian.design/components/onboarding/",
-  "atlassian": {
-    "team": "Design System Team",
-    "releaseModel": "continuous",
-    "productPushConsumption": [
-      "jira"
-    ],
-    "website": {
-      "name": "Onboarding (spotlight)",
-      "category": "Components"
-    },
-    "runReact18": true
-  },
-  "dependencies": {
-    "@atlaskit/analytics-next": "^9.3.0",
-    "@atlaskit/button": "^17.17.0",
-    "@atlaskit/ds-lib": "^2.3.0",
-    "@atlaskit/heading": "^2.3.0",
-    "@atlaskit/modal-dialog": "^12.13.0",
-    "@atlaskit/motion": "^1.6.0",
-    "@atlaskit/popper": "^6.0.0",
-    "@atlaskit/portal": "^4.5.0",
-    "@atlaskit/primitives": "^7.0.0",
-    "@atlaskit/theme": "^12.9.0",
-    "@atlaskit/tokens": "^1.49.0",
-    "@babel/runtime": "^7.0.0",
-    "@emotion/react": "^11.7.1",
-    "bind-event-listener": "^3.0.0",
-    "exenv": "^1.2.2",
-    "memoize-one": "^6.0.0",
-    "react-focus-lock": "^2.9.5",
-    "react-node-resolver": "^1.0.1",
-    "react-scrolllock": "^5.0.1",
-    "react-transition-group": "^4.4.1",
-    "scroll-into-view-if-needed": "^2.2.20"
-  },
-  "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0 || ~18.2.0",
-    "react-dom": "^16.8.0"
-  },
-  "devDependencies": {
-    "@af/accessibility-testing": "*",
-    "@af/integration-testing": "*",
-    "@af/visual-regression": "*",
-    "@atlaskit/ssr": "*",
-    "@atlaskit/visual-regression": "*",
-    "@testing-library/react": "^12.1.5",
-    "@testing-library/react-hooks": "^8.0.1",
-    "@types/exenv": "^1.2.0",
-    "@types/react-node-resolver": "^2.0.0",
-    "@types/react-transition-group": "^2.0.6",
-    "raf-stub": "^2.0.1",
-    "react-dom": "^16.8.0",
-    "react-lorem-component": "^0.13.0",
-    "typescript": "~5.4.2"
-  },
-  "techstack": {
-    "@atlassian/frontend": {
-      "import-structure": "atlassian-conventions"
-    },
-    "@repo/internal": {
-      "dom-events": "use-bind-event-listener",
-      "analytics": "analytics-next",
-      "design-tokens": [
-        "color",
-        "spacing"
-      ],
-      "styling": [
-        "static",
-        "emotion"
-      ],
-      "design-system": "v1",
-      "deprecation": "no-deprecated-imports"
-    }
-  }
-}
+	"name": "@atlaskit/onboarding",
+	"version": "11.7.0",
+	"description": "An onboarding spotlight introduces new features to users through focused messages or multi-step tours.",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.tsx",
+	"af:exports": {
+		".": "./src/index.tsx",
+		"./types": "./src/types.tsx"
+	},
+	"homepage": "https://atlassian.design/components/onboarding/",
+	"atlassian": {
+		"team": "Design System Team",
+		"releaseModel": "continuous",
+		"productPushConsumption": [
+			"jira"
+		],
+		"website": {
+			"name": "Onboarding (spotlight)",
+			"category": "Components"
+		},
+		"runReact18": true
+	},
+	"dependencies": {
+		"@atlaskit/analytics-next": "^9.3.0",
+		"@atlaskit/button": "^17.17.0",
+		"@atlaskit/ds-lib": "^2.3.0",
+		"@atlaskit/heading": "^2.4.0",
+		"@atlaskit/modal-dialog": "^12.14.0",
+		"@atlaskit/motion": "^1.7.0",
+		"@atlaskit/popper": "^6.1.0",
+		"@atlaskit/portal": "^4.6.0",
+		"@atlaskit/primitives": "^7.4.0",
+		"@atlaskit/theme": "^12.10.0",
+		"@atlaskit/tokens": "^1.51.0",
+		"@babel/runtime": "^7.0.0",
+		"@emotion/react": "^11.7.1",
+		"bind-event-listener": "^3.0.0",
+		"exenv": "^1.2.2",
+		"memoize-one": "^6.0.0",
+		"react-focus-lock": "^2.9.5",
+		"react-node-resolver": "^1.0.1",
+		"react-scrolllock": "^5.0.1",
+		"react-transition-group": "^4.4.1",
+		"scroll-into-view-if-needed": "^2.2.20"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0 || ^17.0.0 || ~18.2.0",
+		"react-dom": "^16.8.0"
+	},
+	"devDependencies": {
+		"@af/accessibility-testing": "*",
+		"@af/integration-testing": "*",
+		"@af/visual-regression": "*",
+		"@atlaskit/ssr": "*",
+		"@atlaskit/visual-regression": "*",
+		"@testing-library/react": "^12.1.5",
+		"@testing-library/react-hooks": "^8.0.1",
+		"@types/exenv": "^1.2.0",
+		"@types/react-node-resolver": "^2.0.0",
+		"@types/react-transition-group": "^2.0.6",
+		"raf-stub": "^2.0.1",
+		"react-dom": "^16.8.0",
+		"react-lorem-component": "^0.13.0",
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"import-structure": "atlassian-conventions"
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": "analytics-next",
+			"design-tokens": [
+				"color",
+				"spacing"
+			],
+			"styling": [
+				"static",
+				"emotion"
+			],
+			"design-system": "v1",
+			"deprecation": "no-deprecated-imports"
+		}
+	}
+}

package/report.api.md

@@ -2,7 +2,8 @@
 
 ## API Report File for "@atlaskit/onboarding"
 
-> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> 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)
 
 ### Table of contents
@@ -35,10 +36,10 @@ import { ThemeProp } from '@atlaskit/theme/components';
 
 // @public (undocumented)
 interface Action extends Omit<CustomThemeButtonProps, 'children'> {
-  // (undocumented)
-  key?: string;
-  // (undocumented)
-  text?: ReactNode;
+	// (undocumented)
+	key?: string;
+	// (undocumented)
+	text?: ReactNode;
 }
 
 // @public (undocumented)
@@ -46,244 +47,227 @@ type Actions = Action[];
 
 // @public (undocumented)
 type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
-  bgColor?: string;
-  radius?: number;
-  className?: string;
-  testId?: string;
-  children?: ReactNode;
+	bgColor?: string;
+	radius?: number;
+	className?: string;
+	testId?: string;
+	children?: ReactNode;
 };
 
 // @public @deprecated (undocumented)
 interface CardTokens {
-  // @deprecated (undocumented)
-  container: Record<string, string | undefined>;
+	// @deprecated (undocumented)
+	container: Record<string, string | undefined>;
 }
 
 // @public
 export class Modal extends Component<ModalProps> {
-  // (undocumented)
-  footerComponent: (
-    props: ModalProps,
-  ) => (() => jsx.JSX.Element | null) | ElementType<ModalFooterProps>;
-  // (undocumented)
-  headerComponent: (
-    props: ModalProps,
-  ) => (() => jsx.JSX.Element) | ElementType<ModalHeaderProps>;
-  // (undocumented)
-  render(): jsx.JSX.Element;
+	// (undocumented)
+	footerComponent: (
+		props: ModalProps,
+	) => (() => jsx.JSX.Element | null) | ElementType<ModalFooterProps>;
+	// (undocumented)
+	headerComponent: (props: ModalProps) => (() => jsx.JSX.Element) | ElementType<ModalHeaderProps>;
+	// (undocumented)
+	render(): jsx.JSX.Element;
 }
 
 // @public @deprecated (undocumented)
-export const modalButtonTheme: (
-  current: any,
-  themeProps: Record<string, any>,
-) => any;
+export const modalButtonTheme: (current: any, themeProps: Record<string, any>) => any;
 
 // @public (undocumented)
 type ModalProps = {
-  actions?: Actions;
-  children: ReactNode;
-  image?: string;
-  header?: ElementType<ModalHeaderProps>;
-  footer?: ElementType<ModalFooterProps>;
-  heading?: string;
-  experimental_shouldShowPrimaryButtonOnRight?: boolean;
+	actions?: Actions;
+	children: ReactNode;
+	image?: string;
+	header?: ElementType<ModalHeaderProps>;
+	footer?: ElementType<ModalFooterProps>;
+	heading?: string;
+	experimental_shouldShowPrimaryButtonOnRight?: boolean;
 };
 
 export { ModalTransition };
 
 // @public
 export const Spotlight: ({
-  dialogWidth,
-  pulse,
-  testId,
-  targetNode,
-  target,
-  ...rest
+	dialogWidth,
+	pulse,
+	testId,
+	targetNode,
+	target,
+	...rest
 }: SpotlightProps) => JSX.Element;
 
 // @public @deprecated (undocumented)
-export const spotlightButtonTheme: (
-  current: any,
-  themeProps: Record<string, any>,
-) => any;
+export const spotlightButtonTheme: (current: any, themeProps: Record<string, any>) => any;
 
 // @public
 export const SpotlightCard: ForwardRefExoticComponent<
-  SpotlightCardProps & RefAttributes<HTMLDivElement>
+	SpotlightCardProps & RefAttributes<HTMLDivElement>
 >;
 
 // @public (undocumented)
 interface SpotlightCardProps {
-  actions?: Actions;
-  actionsBeforeElement?: ReactNode;
-  children?: ReactNode;
-  components?: {
-    Header?: ComponentType<any>;
-    Footer?: ComponentType<any>;
-  };
-  heading?: ReactNode;
-  headingAfterElement?: ReactNode;
-  headingId?: string;
-  image?: ReactNode | string;
-  // @deprecated (undocumented)
-  innerRef?: Ref<HTMLDivElement> | null;
-  isFlat?: boolean;
-  testId?: string;
-  // @deprecated (undocumented)
-  theme?: ThemeProp<CardTokens, {}>;
-  width?: '100%' | number;
+	actions?: Actions;
+	actionsBeforeElement?: ReactNode;
+	children?: ReactNode;
+	components?: {
+		Header?: ComponentType<any>;
+		Footer?: ComponentType<any>;
+	};
+	heading?: ReactNode;
+	headingAfterElement?: ReactNode;
+	headingId?: string;
+	image?: ReactNode | string;
+	// @deprecated (undocumented)
+	innerRef?: Ref<HTMLDivElement> | null;
+	isFlat?: boolean;
+	testId?: string;
+	// @deprecated (undocumented)
+	theme?: ThemeProp<CardTokens, {}>;
+	width?: '100%' | number;
 }
 
 // @public
 export class SpotlightManager extends PureComponent<
-  SpotlightManagerProps,
-  {
-    spotlightCount: number;
-    targets: {
-      [key: string]: HTMLElement | void;
-    };
-  }
+	SpotlightManagerProps,
+	{
+		spotlightCount: number;
+		targets: {
+			[key: string]: HTMLElement | void;
+		};
+	}
 > {
-  // (undocumented)
-  componentDidMount(): void;
-  // (undocumented)
-  static defaultProps: {
-    blanketIsTinted: boolean;
-  };
-  // (undocumented)
-  getStateProviderValue: MemoizedFn<
-    (
-      this: any,
-      targets: any,
-    ) => {
-      opened: () => void;
-      closed: () => void;
-      targets: any;
-    }
-  >;
-  // (undocumented)
-  render(): JSX.Element;
-  // (undocumented)
-  spotlightClose: () => void;
-  // (undocumented)
-  spotlightOpen: () => void;
-  // (undocumented)
-  state: {
-    spotlightCount: number;
-    targets: {};
-  };
-  // (undocumented)
-  targetRef: (name: string) => (element: HTMLElement | void) => void;
+	// (undocumented)
+	componentDidMount(): void;
+	// (undocumented)
+	static defaultProps: {
+		blanketIsTinted: boolean;
+	};
+	// (undocumented)
+	getStateProviderValue: MemoizedFn<
+		(
+			this: any,
+			targets: any,
+		) => {
+			opened: () => void;
+			closed: () => void;
+			targets: any;
+		}
+	>;
+	// (undocumented)
+	render(): JSX.Element;
+	// (undocumented)
+	spotlightClose: () => void;
+	// (undocumented)
+	spotlightOpen: () => void;
+	// (undocumented)
+	state: {
+		spotlightCount: number;
+		targets: {};
+	};
+	// (undocumented)
+	targetRef: (name: string) => (element: HTMLElement | void) => void;
 }
 
 // @public (undocumented)
 interface SpotlightManagerProps {
-  blanketIsTinted?: boolean;
-  children: ReactNode;
-  // @deprecated (undocumented)
-  component?: ElementType;
+	blanketIsTinted?: boolean;
+	children: ReactNode;
+	// @deprecated (undocumented)
+	component?: ElementType;
 }
 
 // @public (undocumented)
 interface SpotlightProps {
-  actions?: Actions;
-  actionsBeforeElement?: ReactNode;
-  children?: ReactNode;
-  dialogPlacement?:
-    | 'bottom center'
-    | 'bottom left'
-    | 'bottom right'
-    | 'left bottom'
-    | 'left middle'
-    | 'left top'
-    | 'right bottom'
-    | 'right middle'
-    | 'right top'
-    | 'top center'
-    | 'top left'
-    | 'top right';
-  dialogWidth?: number;
-  footer?: ComponentType<any>;
-  header?: ComponentType<any>;
-  heading?: string;
-  headingAfterElement?: ReactNode;
-  image?: string;
-  pulse?: boolean;
-  target?: string;
-  targetBgColor?: string;
-  targetNode?: HTMLElement;
-  targetOnClick?: (eventData: {
-    event: MouseEvent_2<HTMLElement>;
-    target?: string;
-  }) => void;
-  targetRadius?: number;
-  targetReplacement?: ComponentType<any>;
-  testId?: string;
+	actions?: Actions;
+	actionsBeforeElement?: ReactNode;
+	children?: ReactNode;
+	dialogPlacement?:
+		| 'bottom center'
+		| 'bottom left'
+		| 'bottom right'
+		| 'left bottom'
+		| 'left middle'
+		| 'left top'
+		| 'right bottom'
+		| 'right middle'
+		| 'right top'
+		| 'top center'
+		| 'top left'
+		| 'top right';
+	dialogWidth?: number;
+	footer?: ComponentType<any>;
+	header?: ComponentType<any>;
+	heading?: string;
+	headingAfterElement?: ReactNode;
+	image?: string;
+	pulse?: boolean;
+	target?: string;
+	targetBgColor?: string;
+	targetNode?: HTMLElement;
+	targetOnClick?: (eventData: { event: MouseEvent_2<HTMLElement>; target?: string }) => void;
+	targetRadius?: number;
+	targetReplacement?: ComponentType<any>;
+	testId?: string;
 }
 
 // @public
 export const SpotlightPulse: ({
-  children,
-  pulse,
-  testId,
-  ...props
+	children,
+	pulse,
+	testId,
+	...props
 }: TargetProps) => jsx.JSX.Element;
 
 // @public
-export const SpotlightTarget: ({
-  children,
-  name,
-}: SpotlightTargetProps) => JSX.Element;
+export const SpotlightTarget: ({ children, name }: SpotlightTargetProps) => JSX.Element;
 
 // @public (undocumented)
 interface SpotlightTargetProps {
-  children: ReactNode;
-  name: string;
+	children: ReactNode;
+	name: string;
 }
 
 // @public
-export class SpotlightTransition extends React_2.Component<
-  SpotlightTransitionProps,
-  State
-> {
-  // (undocumented)
-  static getDerivedStateFromProps(
-    props: SpotlightTransitionProps,
-    state: State,
-  ): {
-    currentChildren: React_2.ReactNode;
-  };
-  // (undocumented)
-  onExited: () => void;
-  // (undocumented)
-  render(): JSX.Element;
-  // (undocumented)
-  state: {
-    currentChildren: undefined;
-  };
+export class SpotlightTransition extends React_2.Component<SpotlightTransitionProps, State> {
+	// (undocumented)
+	static getDerivedStateFromProps(
+		props: SpotlightTransitionProps,
+		state: State,
+	): {
+		currentChildren: React_2.ReactNode;
+	};
+	// (undocumented)
+	onExited: () => void;
+	// (undocumented)
+	render(): JSX.Element;
+	// (undocumented)
+	state: {
+		currentChildren: undefined;
+	};
 }
 
 // @public (undocumented)
 interface SpotlightTransitionProps {
-  children?: ReactNode;
+	children?: ReactNode;
 }
 
 // @public (undocumented)
 interface State {
-  // (undocumented)
-  currentChildren: ReactNode;
+	// (undocumented)
+	currentChildren: ReactNode;
 }
 
 // @public (undocumented)
 type TargetProps = Omit<BaseProps, 'css'> & {
-  pulse?: boolean;
-  testId?: string;
+	pulse?: boolean;
+	testId?: string;
 };
 
 // @public
 export function useSpotlight(): {
-  isTargetRendered: (target: string) => boolean;
+	isTargetRendered: (target: string) => boolean;
 };
 
 // (No @packageDocumentation comment for this package)
@@ -297,8 +281,8 @@ export function useSpotlight(): {
 
 ```json
 {
-  "react": "^16.8.0",
-  "react-dom": "^16.8.0"
+	"react": "^16.8.0",
+	"react-dom": "^16.8.0"
 }
 ```