Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@atlaskit/onboarding

atlassian61.5kApache-2.014.4.2TypeScript support: included

An onboarding spotlight introduces new features to users through focused messages or multi-step tours.

readme

Onboarding

Highlight elements of the UI to the user and display a complementary dialog.

Installation

yarn add @atlaskit/onboarding

Usage

Detailed docs and example usage can be found here.

changelog

@atlaskit/onboarding

14.4.2

Patch Changes

  • Updated dependencies

14.4.1

Patch Changes

  • Updated dependencies

14.4.0

Minor Changes

  • 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

  • 255837cfba315 - Internal changes to how border radius is applied.
  • Updated dependencies

14.3.7

Patch Changes

  • 23bcc5bbc9cee - Internal changes to how border radius is applied.
  • Updated dependencies

14.3.6

Patch Changes

  • cd70a377d007c - Internal changes to how border radius is applied.
  • Updated dependencies

14.3.5

Patch Changes

  • 2af42ad93c3e0 - Internal changes to use tokens for border radius.

14.3.4

Patch Changes

  • 8552692692a60 - Mark @atlaskit/onboarding as intent-to-deprecate.

14.3.3

Patch Changes

  • Updated dependencies

14.3.2

Patch Changes

  • Updated dependencies

14.3.1

Patch Changes

14.3.0

Minor Changes

  • #187608 b447e727a9968 - Cleans up the platform_dst_onboarding_react_transition_group feature gate. Animations are now done using @atlaskit/motion, and react-transition-group has been removed.

14.2.6

Patch Changes

14.2.5

Patch Changes

  • Updated dependencies

14.2.4

Patch Changes

  • Updated dependencies

14.2.3

Patch Changes

  • #169950 7437b3aef9373 - Inlined 'ScrollLogicalPosition' type to fix invalid import from 'scroll-into-view-if-needed/typings/types'

14.2.2

Patch Changes

  • Updated dependencies

14.2.1

Patch Changes

  • Updated dependencies

14.2.0

Minor Changes

  • #161229 37873d53dbc22 - Adds platform_dst_onboarding_react_transition_group feature gate. When enabled @atlaskit/motion will be used for transitions instead of react-transition-group.

Patch Changes

14.1.1

Patch Changes

14.1.0

Minor Changes

  • #154745 7618d9837e247 - Tidy up design-system-closed-all-when-click-outside and sibling-dropdown-close-issue to provide better keyboard navigation.

Patch Changes

  • Updated dependencies

14.0.3

Patch Changes

  • #148201 8e811f1840de7 - Either actively or pre-emptively fixes a bug with keyframe animations in CJS and ESM distribution targets for packages using Compiled CSS-in-JS. This may not affect this package, but the change was made so a future migration does not accidentally break it.

14.0.2

Patch Changes

  • #139445 0f13df85731d6 - the component state update causes React Streming to have Suspense boundary received update before hydrating finished error. Wrapping the state update in startTransition

14.0.1

Patch Changes

  • Updated dependencies

14.0.0

Major Changes

  • #132237 d48bdcf1a3dca - Migrated from @emotion/react to @compiled/react in order to improve performance, align with the rest of the Atlaskit techstack, and support React 18 Streaming SSR. Please note, in order to use this version of @atlaskit/onboarding, you will need to ensure that your bundler is configured to handle .css imports correctly.

    Most bundlers come with built-in support for .css imports, so you may not need to do anything. If you are using a different bundler, please refer to the documentation for that bundler to understand how to handle .css imports. For more information on the migration, please refer to RFC-73 Migrating our components to Compiled CSS-in-JS.

Patch Changes

  • Updated dependencies

13.0.5

Patch Changes

  • Updated dependencies

13.0.4

Patch Changes

  • Updated dependencies

13.0.3

Patch Changes

  • #123425 9d24a5a33ee9e - Add setTimeout to defer state update on cloned target to avoid content shifting issue when scrollbars are on the page

13.0.2

Patch Changes

  • Updated dependencies

13.0.1

Patch Changes

  • Updated dependencies

13.0.0

Major Changes

Patch Changes

  • Updated dependencies

12.3.6

Patch Changes

  • Updated dependencies

12.3.5

Patch Changes

  • Updated dependencies

12.3.4

Patch Changes

12.3.3

Patch Changes

  • Updated dependencies

12.3.2

Patch Changes

  • Updated dependencies

12.3.1

Patch Changes

  • Updated dependencies

12.3.0

Minor Changes

Patch Changes

  • Updated dependencies

12.2.3

Patch Changes

  • Updated dependencies

12.2.2

Patch Changes

  • #180301 16990dd2ac6e5 - Internal changes to typography styles. There may be some minor visual changes to align with modernized typography styles.

12.2.1

Patch Changes

  • Updated dependencies

12.2.0

Minor Changes

  • #176005 a7f4659856234 - Adds optional render prop API to SpotlightTarget component. You can now use a function as the children of SpotlightTarget and explicitly connect the targetRef to your component. This provides fine-grained control over which element is cloned and avoids the need for a wrapping div element.

Patch Changes

12.1.9

Patch Changes

  • Updated dependencies

12.1.8

Patch Changes

  • #167574 30792384f2240 - Removed feature flag to switch useElementBox to the 'polling' ResizeMethod. Now only props should be used to control this.

12.1.7

Patch Changes

12.1.6

Patch Changes

  • #166087 3ab7d7da348ab - Adds side-effect config to support Compiled css extraction in third-party apps

12.1.5

Patch Changes

  • Updated dependencies

12.1.4

Patch Changes

  • Updated dependencies

12.1.3

Patch Changes

  • #161637 6d8bd88d4f892 - [ux] Add default id to heading and reference it to spotlight dialog as accessible name if heading exists.

12.1.2

Patch Changes

12.1.1

Patch Changes

  • #161203 65b24f1c77e69 - Make spread props more explicit and types more accurate throughout all components.

12.1.0

Minor Changes

  • #159268 960359d2e994c - Updated logic for node-resolver-spotlight-target to remove extra span from document

Patch Changes

  • Updated dependencies

12.0.0

Major Changes

11.17.0

Minor Changes

  • #158301 71f646cbd1ba6 - [ux] Fixes issue where focus moved beyond spotlight container in screen reader mode. Additionally spotlight dialog now supports props to add/reference label to it.

11.16.1

Patch Changes

  • Updated dependencies

11.16.0

Minor Changes

  • #154699 fddbc0849871c - DSP-21285 replacing platform-design-system-dsp-20687-transition-group with platform_design_system_team_transition_group_r18

11.15.8

Patch Changes

  • Updated dependencies

11.15.7

Patch Changes

11.15.6

Patch Changes

11.15.5

Patch Changes

11.15.4

Patch Changes

  • Updated dependencies

11.15.3

Patch Changes

11.15.2

Patch Changes

11.15.1

Patch Changes

  • Updated dependencies

11.15.0

Minor Changes

11.14.0

Minor Changes

  • 2d1da097bd763 - DSP-20687 removing usage of findDOMNode in react-transition-group behind ff

11.13.0

Minor Changes

11.12.3

Patch Changes

  • #134051 85b8f6cd01de0 - Removes redundant usage of analytics-next from the spotlight dialog. No functional or behavioural changes

11.12.2

Patch Changes

  • Updated dependencies

11.12.1

Patch Changes

  • Updated dependencies

11.12.0

Minor Changes

  • #127511 db30e29344013 - Widening range of react and react-dom peer dependencies from ^16.8.0 || ^17.0.0 || ~18.2.0 to the wider range of ^16.8.0 || ^17.0.0 || ^18.0.0` (where applicable).

    This change has been done to enable usage of `react@18.3as well as to have a consistent peer dependency range forreactandreact-domfor/platform` packages.

Patch Changes

  • Updated dependencies

11.11.1

Patch Changes

  • Updated dependencies

11.11.0

Minor Changes

  • 8b8090800a35d - Bump peer dependency for react-dom to include version 17 and 18.

Patch Changes

  • Updated dependencies

11.10.5

Patch Changes

  • Updated dependencies

11.10.4

Patch Changes

  • #125754 aa57c66a5b798 - Migrating ipm-choreographer out of post-office and into platform. Fixing tests and lint checks for ipm-choreographer, and adding a bugfix for Engagekit. Also, a minor change to @atlaskit/onboarding to export the SpotlightProps interface.

11.10.3

Patch Changes

  • Updated dependencies

11.10.2

Patch Changes

11.10.1

Patch Changes

  • Updated dependencies

11.10.0

Minor Changes

11.9.0

Minor Changes

  • 393f732d5423f - [ux] Adding an optional prop to Spotlight, so it can used for scrollIntoView 'block' parameter. This is to fix the unnecessary scroll of the non-portalled popup targets.

Patch Changes

  • Updated dependencies

11.8.2

Patch Changes

  • Updated dependencies

11.8.1

Patch Changes

  • Updated dependencies

11.8.0

Minor Changes

  • #114901 61f6a496bcddf - Added a possible fix (behind a feature flag) for a positioning bug with the Spotlight component.

11.7.2

Patch Changes

  • Updated dependencies

11.7.1

Patch Changes

  • Updated dependencies

11.7.0

Minor Changes

  • #110670 c733254a2dd6e - Explicitly set jsxRuntime to classic via pragma comments in order to avoid issues where jsxRuntime is implicitly set to automatic.

Patch Changes

  • Updated dependencies

11.6.0

Minor Changes

  • #109747 abd5924f09fbd - Internal change to manually set Heading colour to avoid potential context issues. This should resolve issues where the Heading colour may have been incorrectly set.

11.5.8

Patch Changes

  • Updated dependencies

11.5.7

Patch Changes

  • Updated dependencies

11.5.6

Patch Changes

  • #100605 f12f3d4764e2 - Reverts an attempted bug fix in 11.5.2 that re-added a theme provider to spotlight card to prevent custom theme buttons inheriting other themes

11.5.5

Patch Changes

11.5.4

Patch Changes

11.5.3

Patch Changes

  • Updated dependencies

11.5.2

Patch Changes

  • #96747 3fdc807b70fb - Re-add custom theme wrapper to prevent buttons accidentally inheriting themes. To be removed when component is updated to use new buttons.

11.5.1

Patch Changes

11.5.0

Minor Changes

11.4.0

Minor Changes

  • #94745 a0e6d0465080 - [ux] Internal changes to typography + small visual change to background color.

Patch Changes

  • Updated dependencies

11.3.2

Patch Changes

11.3.1

Patch Changes

11.3.0

Minor Changes

  • #84838 e3dc0b4099fe - [ux] Now the pulsing animations in both the standard Spotlight and the dedicated Pulse component respect prefers-reduced-motion user preferences. If a user sets their system preferences to reduce motion, instead of a pulsing animation we will show a static 'discovery' outline.

11.2.7

Patch Changes

  • #85076 3032fb024382 - Associates the heading prop with the accessible label for the benefits modal.

11.2.6

Patch Changes

11.2.5

Patch Changes

11.2.4

Patch Changes

  • Updated dependencies

11.2.3

Patch Changes

11.2.2

Patch Changes

11.2.1

Patch Changes

  • #67032 038e62a39d23 - [ux] Ensure spotlight dialog always uses heading level 2. This will eventually become heading level 1 once the dialog becomes a true modal.

11.2.0

Minor Changes

  • #64059 d69cb4f14309 - [ux] Adds headingLevel to the SpotlightCard component. This will allow the usage of the correct heading level depending on context.

11.1.3

Patch Changes

  • Updated dependencies

11.1.2

Patch Changes

  • #59147 f12e489f23b0 - Re-build and deploy packages to NPM to resolve React/Compiled not found error (HOT-106483).

11.1.1

Patch Changes

  • #58458 536478cdcf0b - Tweaked ModalBody left and right padding to better align to the spacing scale.

11.1.0

Minor Changes

11.0.0

Major Changes

  • #54210 524ec7b6505d - Removed all remaining legacy theming logic from the Onboarding component.

10.8.12

Patch Changes

  • #43073 2d760e89b53 - headingId is the id of heading in spotlightCard, which is used as the value of aria-labelledby attribute of <div> element containing the modal dialog heading for screen reader recognising the dialog

10.8.11

Patch Changes

  • #41764 77fd34690e9 - Add missing dependencies to fix typechecking under local consumption

10.8.10

Patch Changes

  • #41644 35821e3b157 - Wrap ReactElement in React.Fragment to fix typechecking under local consumption

10.8.9

Patch Changes

10.8.8

Patch Changes

  • #39128 3c114ea4257 - Update type definitions to conform to inherited changes from @types/react@16.14.15.

10.8.7

Patch Changes

10.8.6

Patch Changes

  • #38215 36e3e86da5d - SpotlightCard width prop now accepts either a number or the string '100%' and refactors how our range of 160px – 600px works via css min-width and max-width instead of raw math.

10.8.5

Patch Changes

  • #35441 599bfe90ee3 - Internal change to use shape tokens. There is no expected visual change.

10.8.4

Patch Changes

  • #35716 df6aac8c5a6 - When providing an image path to SpotlightCard, there is no longer an additional space that appears between the image and content padding.
  • Updated dependencies

10.8.3

Patch Changes

  • #33652 e7ea6832ad2 - Bans the use of React.FC/React.FunctionComponent type in ADS components as part of the React 18 migration work. The change is internal only and should not introduce any changes for the component consumers.

10.8.2

Patch Changes

10.8.1

Patch Changes

10.8.0

Minor Changes

Patch Changes

  • Updated dependencies

10.7.2

Patch Changes

10.7.1

Patch Changes

10.7.0

Minor Changes

  • #31299 e3fa4437cf5 - [ux] Updates focus appearance of components using buttons and custom buttons. These states now use an offset outline which is consistent with other applications of focus in Atlassian components.

Patch Changes

  • Updated dependencies

10.6.12

Patch Changes

  • #31206 261420360ec - Upgrades component types to support React 18.
  • Updated dependencies

10.6.11

Patch Changes

10.6.10

Patch Changes

  • Updated dependencies

10.6.9

Patch Changes

  • Updated dependencies

10.6.8

Patch Changes

  • #29390 18aeca8c199 - Internal change to update token references. There is no expected behaviour or visual change.

10.6.7

Patch Changes

  • #29227 4ee60bafc6d - ED-16603: Remove tooltips from VR tests and make them opt in. To opt-in, add allowedSideEffects when loading the page.

10.6.6

Patch Changes

  • #28159 716af1d3387 - Bump @atlaskit/heading from 1.0.0 to 1.0.1 to avoid resolving to poison dependency version

10.6.5

Patch Changes

  • Updated dependencies

10.6.4

Patch Changes

  • Updated dependencies

10.6.3

Patch Changes

  • Updated dependencies

10.6.2

Patch Changes

  • Updated dependencies

10.6.1

Patch Changes

  • #26408 9de88fa1e1e - Internal changes to include spacing tokens in component implementations.

10.6.0

Minor Changes

  • #24710 e0015d4e201 - Updates @emotion/core to @emotion/react; v10 to v11. There is no expected behavior change.

Patch Changes

  • 05efb20bca8 - Fixes an issue with the Spotlight target element height when this is determined by a parent element.
  • Updated dependencies

10.5.4

Patch Changes

10.5.3

Patch Changes

  • #25075 7ca0e5a0c31 - Update "subtle" action in Onboarding component to use correct tokens
  • #25074 0e5102ee5ab - Update "subtle-link" action in Onboarding component to use correct tokens

10.5.2

Patch Changes

10.5.1

Patch Changes

  • #24237 994508770f7 - Bumps the @atlaskit/heading dependency forward to a higher minimum version.

10.5.0

Minor Changes

Patch Changes

  • a3241bd63a3 - Updates jsdoc for all exported outputs of onboarding.
  • Updated dependencies

10.4.2

Patch Changes

  • #22614 8a5bdb3c844 - Upgrading internal dependency (bind-event-listener) for improved internal types

10.4.1

Patch Changes

  • #22029 e4b612d1c48 - Internal migration to bind-event-listener for safer DOM Event cleanup

10.4.0

Minor Changes

  • #21570 3124aa6ae24 - The onboarding package now exports a ModalTransition component for use with the benefits modal. This resolves an issue that can occur when using ModalTransition from a different version of @atlaskit/modal-dialog than the one that Onboarding is bringing in.

Patch Changes

  • e7ad64befa5 - [ux] Updated input tokens within @atlaskit/onboarding.

10.3.11

Patch Changes

10.3.10

Patch Changes

  • Updated dependencies

10.3.9

Patch Changes

10.3.8

Patch Changes

  • Updated dependencies

10.3.7

Patch Changes

  • #19618 ac9343c3ed4 - Replaces usage of deprecated design tokens. No visual or functional changes
  • dcd92130cc4 - Migrate deleted background accent tokens to replacements
  • 62edf20ab1e - Migrates all usage of brand tokens to either selected or information tokens. This change is purely for semantic reasons, there are no visual or behavioural changes.
  • Updated dependencies

10.3.6

Patch Changes

  • #19019 bd38851d12f - [ux] Fixed the missing Spotlight button border by updating the token usages.
  • Updated dependencies

10.3.5

Patch Changes

10.3.4

Patch Changes

  • 19d72473dfb - The no-unsafe-design-token-usage eslint rule now respects the new token naming conventions when auto-fixing by correctly formatting token ids.
  • 19d72473dfb - The no-unsafe-design-token-usage eslint rule now respects the new token naming conventions when auto-fixing by correctly formatting token ids.
  • Updated dependencies

10.3.3

Patch Changes

  • Updated dependencies

10.3.2

Patch Changes

  • #17672 9a5740d1ec3 - [ux] The pulse prop now works correctly for <SpotlightPulse />. Previously, it was applying the pulse to the SpotlightPulse target regardless of the pulse value. Now it checks the value of pulse and applies the animation accordingly.

10.3.1

Patch Changes

  • #15998 3fced6aa641 - Bumped react-focus-lock to version ^2.2.1.
  • f460cc7c411 - Builds for this package now pass through a tokens babel plugin, removing runtime invocations of the tokens() function and improving bundle size.
  • Updated dependencies

10.3.0

Minor Changes

  • #14777 50081f13de7 - Instrumented @atlaskit/onboarding with the new theming package, @atlaskit/tokens.

    New tokens will be visible only in applications configured to use the new Tokens API (currently in alpha). These changes are intended to be interoperable with the legacy theme implementation. Legacy dark mode users should expect no visual or breaking changes.

Patch Changes

  • Updated dependencies

10.2.6

Patch Changes

10.2.5

Patch Changes

10.2.4

Patch Changes

  • #14319 d77725f926f - Replaced usage of styled-components with @emotion/core.
  • cf853e39278 - Internal changes to remove @atlaskit/theme/math usage.
  • Updated dependencies

10.2.3

Patch Changes

10.2.2

Patch Changes

  • Updated dependencies

10.2.1

Patch Changes

10.2.0

Minor Changes

  • #8644 1b1cb960767 - The headingAfterElement prop has been added to the spotlight component which can be used to add a supplementary action.

Patch Changes

  • 79c23df6340 - Use injected package name and version for analytics instead of version.json.

10.1.9

Patch Changes

10.1.8

Patch Changes

  • #5497 5f58283e1f - Export types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules compiler option. This requires version 3.8 of Typescript, read more about how we handle Typescript versions here: https://atlaskit.atlassian.com/get-started Also add typescript to devDependencies to denote version that the package was built with.

10.1.7

Patch Changes

  • Updated dependencies

10.1.6

Patch Changes

  • #5164 2ac834240e - Undo analytics-next file restructure to allow external ts definitions to continue working

10.1.5

Patch Changes

  • Updated dependencies

10.1.4

Patch Changes

10.1.3

Patch Changes

  • #3885 6c525a8229 - Upgraded to TypeScript 3.9.6 and tslib to 2.0.0

    Since tslib is a dependency for all our packages we recommend that products also follow this tslib upgrade to prevent duplicates of tslib being bundled.

10.1.2

Patch Changes

10.1.1

Patch Changes

  • Updated dependencies

10.1.0

Minor Changes

  • #3428 5d6c324306 - Expose useSpotlight hook which returns #isTargetRendered function. We can use this function to check whether target is rendered or not.

Patch Changes

  • db053b24d8 - Update all the theme imports to be tree-shakable

10.0.0

Major Changes

Patch Changes

  • Updated dependencies

9.2.0

Minor Changes

  • #2763 2c8d296246 - Adds support for the subtle button appearance in the Spotlight dialog theme to align more closely with ADG guidelines. Also visually re-orders action items so that the primary item in the actions list appears on the right hand side, but still recieves focus first.

9.1.10

Patch Changes

  • #2866 54a9514fcf - Build and supporting files will no longer be published to npm

9.1.9

Patch Changes

9.1.8

Patch Changes

  • Updated dependencies

9.1.7

Patch Changes

  • #1868 6faa22760b - Add modalButtonTheme, spotlightButtonTheme,- Updated dependencies

9.1.6

Patch Changes

9.1.5

Patch Changes

9.1.4

Patch Changes

9.1.3

Patch Changes

9.1.2

Patch Changes

9.1.1

Patch Changes

  • [patch]728f19e563:

    Fixes a rendering bug where a spotlight would not be updated

9.1.0

Minor Changes

  • [minor]aa70b257d3:

    Introduce new prop experimental_shouldShowPrimaryButtonOnRight which positions the primary button in a onboarding modal-dialog on the right (ADG approved).

9.0.10

Patch Changes

  • [patch]b0d1348c83:

    Change the type definition for interface to extend ButtonProps- [patch]62dc057049:

    Allowing benefits modal buttons to stack vertically rather than overflow the modal when buttons contain lengthy text.- Updated dependencies 0603860c07:

9.0.9

Patch Changes

9.0.8

Patch Changes

9.0.7

Patch Changes

9.0.6

Patch Changes

9.0.5

Patch Changes

  • [patch]1ed27f5f85:

    Adds prop types for Header / Footer render props.

9.0.4

Patch Changes

  • [patch]f86839ca4e:

    @atlaskit/portal had an issue in IE11 and this is fixed in 3.1.2

9.0.3

Patch Changes

  • [patch]35d2229b2a:

    Adding missing license to packages and update to Copyright 2019 Atlassian Pty Ltd.

9.0.2

Patch Changes

  • [patch]a2d0043716:

    Updated version of analytics-next to fix potential incompatibilities with TS 3.6

9.0.1

Patch Changes

  • [patch]2b158873d1:

    Add linting rule to prevent unsafe usage of setTimeout within React components.

9.0.0

Major Changes

  • [major]a75dfaad67:

    @atlaskit/onboarding has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No API or behavioural changes.

8.0.17

Patch Changes

  • [patch]097b696613:

    Components now depend on TS 3.6 internally, in order to fix an issue with TS resolving non-relative imports as relative imports

8.0.16

Patch Changes

8.0.15

Patch Changes

  • [patch]708028db86:

    Change all the imports to theme in Core to use multi entry points

8.0.14

Patch Changes

  • [patch]abee1a5f4f:

    Bumping internal dependency (memoize-one) to latest version (5.1.0). memoize-one@5.1.0 has full typescript support so it is recommended that typescript consumers use it also.

8.0.13

Patch Changes

  • [patch]de35ce8c67:

    Updates component maintainers

8.0.12

8.0.11

Patch Changes

  • [patch]678b2407a1:

    Fix spotlight highlight issue when the offset parent has "fixed" position.

8.0.10

Patch Changes

  • [patch]d905cbc0ac:

    Spotlight target highlight is out of position if the the target element or any of its parent has a "fixed" position. Fix the issue by checking for fixed position before setting the position values for target highlight. Adding a condition to check if the component are referenced in tests running in CI. It reduces the noise and help reading the CI log.

8.0.9

  • BROKEN RELEASE. DO NOT USE.

Patch Changes

8.0.8

8.0.7

Patch Changes

  • [patch]9f8ab1084b:

    Consume analytics-next ts type definitions as an ambient declaration.

8.0.6

8.0.5

Patch Changes

  • [patch]4615439434:

    index.ts will now be ignored when publishing to npm

8.0.4

8.0.3

  • [patch]b0ef06c685:

    • This is just a safety release in case anything strange happened in in the previous one. See Pull Request #5942 for details

8.0.2

8.0.1

  • [patch]21854842b5:

    • Clean couple of TODO's that were already done

8.0.0

  • [major]7c17b35107:

    • Updates react and react-dom peer dependencies to react@^16.8.0 and react-dom@^16.8.0. To use this package, please ensure you use at least this version of react and react-dom.

7.0.5

7.0.4

7.0.3

7.0.2

7.0.1

7.0.0

  • [major]76299208e6:

    • Drop ES5 from all the flow modules

    Dropping CJS support in all @atlaskit packages

    As a breaking change, all @atlaskit packages will be dropping cjs distributions and will only distribute esm. This means all distributed code will be transpiled, but will still contain import and export declarations.

    The major reason for doing this is to allow us to support multiple entry points in packages, e.g:

    import colors from `@atlaskit/theme/colors`;

    Previously this was sort of possible for consumers by doing something like:

    import colors from `@atlaskit/theme/dist/esm/colors`;

    This has a couple of issues. 1, it treats the file system as API making internal refactors harder, we have to worry about how consumers might be using things that aren't actually supposed to be used. 2. We are unable to do this internally in @atlaskit packages. This leads to lots of packages bundling all of theme, just to use a single color, especially in situations where tree shaking fails.

    To support being able to use multiple entrypoints internally, we unfortunately cannot have multiple distributions as they would need to have very different imports from of their own internal dependencies.

    ES Modules are widely supported by all modern bundlers and can be worked around in node environments.

    We may choose to revisit this solution in the future if we find any unintended condequences, but we see this as a pretty sane path forward which should lead to some major bundle size decreases, saner API's and simpler package architecture.

    Please reach out to #fabric-build (if in Atlassian) or create an issue in Design System Support (for external) if you have any questions or queries about this.

6.2.0

  • [minor]eb81a2de65:

    • Spotlight footer and header props will now only accept React components

6.1.17

6.1.16

6.1.15

  • [patch]6855bec:

    • Updated internal use of ModalDialog to use new composition API

6.1.14

6.1.13

  • [patch]e59562a:

    • Fix for visual bug in SpotlightCard component

6.1.12

  • [patch]d13242d:

    • Change API to experimental theming API to namespace component themes into separate contexts and make theming simpler. Update all dependant components.

6.1.11

6.1.10

6.1.9

6.1.8

6.1.7

6.1.6

  • [patch]a637f5e:

    • Refine and fix some flow type errors found by fixing @atlaskit/analytics-next HOCs to allow flow to type check properly

6.1.5

  • [patch]b332c91:

    • upgrades verison of react-scrolllock to SSR safe version

6.1.4

  • [patch]9f91ea0:

    • Adds visual regression test for ie11

6.1.3

  • [patch]4872a19:

    • actions prop officially accepts Node type for text. Adds optional key to action type.

    Previously if you were using the actions prop like:

    <Spotlight
        actions={[
            {
                text: <FormattedMessage defaultMessage="Next" />,
            },
            {
                text: <FormattedMessage defaultMessage="Skip" />,
            },
        ]}
    >
        Look at this feature
    </Spotlight>

    React would complain about duplicate keys. Now you can pass in a key for the action like:

    <Spotlight
        actions={[
            {
                text: <FormattedMessage defaultMessage="Next" />,
                key: 'next',
            },
            {
                text: <FormattedMessage defaultMessage="Skip" />,
                key: 'skip',
            },
        ]}
    >
        Look at this feature
    </Spotlight>

6.1.2

6.1.1

6.1.0

  • [minor] Creates new SpotlightCard component. Internal refactor of Spotlight components. Spotlight state managed through context rather than local variable. f9ba552

6.0.4

6.0.3

  • [patch] Adds missing implicit @babel/runtime dependency b71751b

6.0.2

6.0.1

6.0.0

5.1.9

5.1.8

  • [patch] Adds sideEffects: false to allow proper tree shaking b5d6d04

5.1.6

5.1.5

5.1.4

5.1.3

5.1.2

5.1.1

  • [patch] onboarding spotlight: fix margin affecting target position 0e33c70
  • [none] Updated dependencies 0e33c70

5.1.0

  • [minor] round corners for onboarding modal image 785e99a
  • [none] Updated dependencies 785e99a

5.0.1

5.0.0

4.1.7

4.1.6

  • [patch] Fixes positioning issue when target is relatively positioned 11e8465
  • [none] Updated dependencies 11e8465

4.1.5

4.1.4

4.1.3

  • [patch] Adds autoFocus prop to FocusLock. Fixes scrolling bug in onboarding. c9d606b
  • [none] Updated dependencies c9d606b
  • Fixes scrolling problem when multiple spotlights are off-screen.

4.1.2

4.1.1

4.1.0

4.0.1

4.0.0

3.1.3

3.1.0

  • [minor] support new property "targetNode" on spotlight component 48397b6

3.0.0

  • [major] Bump to React 16.3. 4251858

2.4.2

  • [patch] Re-releasing due to potentially broken babel release 9ed0bba

2.4.0

  • [minor] Update styled-components dependency to support versions 1.4.6 - 3 ceccf30

2.3.4

2.3.2

  • [patch] Packages Flow types for elements components 3111e74

2.3.0

  • [minor] Replace scrollBy and add websdriver test 66e7a56

2.2.2

  • [patch] Migrate Navigation from Ak repo to ak mk 2 repo, Fixed flow typing inconsistencies in ak mk 2 bdeef5b

2.2.1

  • [patch] Resolved low hanging flow errors in field-base field-text comment icon item and website, $ 007de27

2.2.0

  • [minor] Add React 16 support. 12ea6e4

2.1.0

  • [minor] add subtle-link button appearance theme to spotlight 24d1fa2

2.0.8

  • [patch] Update dependencies 623f8ca

2.0.7

  • [patch] more robust implementation of FocusLock 64dd1d8

2.0.6

  • [patch] Refactor autoscroll logic in withScrollMeasurement HOC 2e90a74

2.0.4

  • [patch] Fix version ranges on button/layer-manager 7e7a211
  • [patch] update flow dep, fix flow errors 722ad83
  • [patch] Update Onboarding's Button usage to implement theming method. 5e6da46

2.0.2

  • [patch] Fix target regression from migration fa6f973
  • [patch] Updated docs to reflect the addition of the blanketIsTinted prop to SpotLightManager 11bb25f

1.0.0-beta (2017-09-19)

  • feature; initial release