Blanket

A blanket covers the underlying UI for a layered component, such as a modal dialog or a tooltip.

16.4.4

Patch Changes

  • Updated dependencies

16.4.3

Patch Changes

  • Updated dependencies

16.4.2

Patch Changes

  • Updated dependencies

16.4.1

Patch Changes

  • Updated dependencies

16.4.0

Minor Changes

Patch Changes

  • Updated dependencies

16.3.1

Patch Changes

16.3.0

Minor Changes

  • d82e6f76528ab, (opens new window) - Add direct subpath package exports as part of the linking-platform, search, media, and design-system barrel-removal (de-barrel) migration.

    These packages now expose their individual modules via explicit package.json exports subpaths so that consumers can import directly from the leaf module (e.g. @atlaskit/pkg/thing) instead of the package barrel/index. This adds new public entry points without changing or removing any existing exports, so it is a backwards-compatible additive change.

    No runtime behaviour changes; this is an API-surface (entry-point) addition to support tree-shaking and to unblock removal of the barrel index files.

Patch Changes

  • Updated dependencies

16.2.3

Patch Changes

  • Updated dependencies

16.2.2

Patch Changes

  • Updated dependencies

16.2.1

Patch Changes

  • Updated dependencies

16.2.0

Minor Changes

16.1.0

Minor Changes

  • cd097a2111788, (opens new window) - Republish packages depending on @atlaskit/react-compiler-gating so their published dependency reference is updated to the renamed @atlaskit/react-compiler-gating scope.

    The earlier rename of @atlassian/react-compiler-gating to @atlaskit/react-compiler-gating only bumped the renamed package itself, so dependent packages were never republished and their published versions still referenced the old @atlassian/react-compiler-gating name, which is not available in the public npm registry. This minor bump republishes all affected packages with the corrected dependency.

Patch Changes

  • Updated dependencies

16.0.1

Patch Changes

16.0.0

Major Changes

  • f2dc9097319f0, (opens new window) - ### Dropped support for legacy Typescript 4 types. Typescript 5 is now the new minimum.

    Removes the typesVersions property and dist/types-ts4.5 directory from the dist.

    Types are now exclusively via the "types": "dist/types/index.d.ts" property.

    - "typesVersions": { - ">=4.5 <4.9": { - "*": [ - "dist/types-ts4.5/*", - "dist/types-ts4.5/index.d.ts" - ] - } - },

Patch Changes

  • Updated dependencies

15.0.34

Patch Changes

  • Updated dependencies

15.0.33

Patch Changes

  • Updated dependencies

15.0.32

Patch Changes

  • Updated dependencies

15.0.31

Patch Changes

  • Updated dependencies

15.0.30

Patch Changes

  • Updated dependencies

15.0.29

Patch Changes

15.0.28

Patch Changes

15.0.27

Patch Changes

15.0.26

Patch Changes

  • Updated dependencies

15.0.25

Patch Changes

  • Updated dependencies

15.0.24

Patch Changes

  • Updated dependencies

15.0.23

Patch Changes

15.0.22

Patch Changes

  • Updated dependencies

15.0.21

Patch Changes

  • Updated dependencies

15.0.20

Patch Changes

  • Updated dependencies

15.0.19

Patch Changes

  • Updated dependencies

15.0.18

Patch Changes

  • Updated dependencies

15.0.17

Patch Changes

  • Updated dependencies

15.0.16

Patch Changes

  • Updated dependencies

15.0.15

Patch Changes

  • Updated dependencies

15.0.14

Patch Changes

  • Updated dependencies

15.0.13

Patch Changes

  • Updated dependencies

15.0.12

Patch Changes

  • Updated dependencies

15.0.11

Patch Changes

15.0.10

Patch Changes

  • Updated dependencies

15.0.9

Patch Changes

  • Updated dependencies

15.0.8

Patch Changes

  • Updated dependencies

15.0.7

Patch Changes

  • Updated dependencies

15.0.6

Patch Changes

  • Updated dependencies

15.0.5

Patch Changes

  • Updated dependencies

15.0.4

Patch Changes

  • Updated dependencies

15.0.3

Patch Changes

15.0.2

Patch Changes

15.0.1

Patch Changes

  • Updated dependencies

15.0.0

Major Changes

Patch Changes

  • Updated dependencies

14.2.0

Minor Changes

Patch Changes

  • Updated dependencies

14.1.3

Patch Changes

  • Updated dependencies

14.1.2

Patch Changes

14.1.1

Patch Changes

  • Updated dependencies

14.1.0

Minor Changes

Patch Changes

  • Updated dependencies

14.0.3

Patch Changes

14.0.2

Patch Changes

14.0.1

Patch Changes

  • Updated dependencies

14.0.0

Major Changes

  • #176786, (opens new window) 30a4108a8fe56, (opens new window) - 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/blanket, 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, (opens new window).

13.3.5

Patch Changes

13.3.4

Patch Changes

  • Updated dependencies

13.3.3

Patch Changes

  • Updated dependencies

13.3.2

Patch Changes

  • Updated dependencies

13.3.1

Patch Changes

  • Updated dependencies

13.3.0

Minor Changes

  • #127511, (opens new window) db30e29344013, (opens new window) - 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.3 as well as to have a consistent peer dependency range for react and react-dom for /platform packages.

Patch Changes

  • Updated dependencies

13.2.1

Patch Changes

  • Updated dependencies

13.2.0

Minor Changes

13.1.0

Minor Changes

13.0.1

Patch Changes

13.0.0

Major Changes

12.4.5

Patch Changes

12.4.4

Patch Changes

12.4.3

Patch Changes

12.4.2

Patch Changes

12.4.1

Patch Changes

12.4.0

Minor Changes

Patch Changes

  • Updated dependencies

12.3.8

Patch Changes

12.3.7

Patch Changes

  • Updated dependencies

12.3.6

Patch Changes

12.3.5

Patch Changes

  • Updated dependencies

12.3.4

Patch Changes

  • Updated dependencies

12.3.3

Patch Changes

  • Updated dependencies

12.3.2

Patch Changes

  • Updated dependencies

12.3.1

Patch Changes

12.3.0

Minor Changes

12.2.16

Patch Changes

12.2.15

Patch Changes

12.2.14

Patch Changes

  • Updated dependencies

12.2.13

Patch Changes

  • Updated dependencies

12.2.12

Patch Changes

12.2.11

Patch Changes

  • Updated dependencies

12.2.10

Patch Changes

12.2.9

Patch Changes

12.2.8

Patch Changes

  • Updated dependencies

12.2.7

Patch Changes

12.2.6

Patch Changes

  • Updated dependencies

12.2.5

Patch Changes

12.2.4

Patch Changes

  • Updated dependencies

12.2.3

Patch Changes

12.2.2

Patch Changes

  • Updated dependencies

12.2.1

Patch Changes

  • Updated dependencies

12.2.0

Minor Changes

Patch Changes

12.1.1

Patch Changes

  • Updated dependencies

12.1.0

Minor Changes

Patch Changes

12.0.1

Patch Changes

12.0.0

Major Changes

  • #12328, (opens new window) f166f5398b2, (opens new window) - In this version we made Blanket faster and lighter

    • General performance improvements

    • BREAKING Blanket now accepts a children prop whose value is of type ReactElement.

    • BREAKING canClickThrough prop is now renamed to shouldAllowClickThrough.

    Running the codemod cli

    To run the codemod: You first need to have the latest version installed

    yarn upgrade @atlaskit/blanket@^12.0.0

    Once upgraded, use @atlaskit/codemod-cli:

    npx @atlaskit/codemod-cli --parser babel --extensions ts,tsx,js [relativePath]

    The CLI will show a list of components and versions so select @atlaskit/blanket@^12.0.0 and you will automatically be upgraded.

    What will be changed:

    • It will rename the canClickThrough prop to shouldAllowClickThrough.

    Run npx @atlaskit/codemod-cli -h for more details on usage.

    For Atlassians, refer to the documentation, (opens new window) for more details on the codemod CLI.

Patch Changes

11.4.1

Patch Changes

11.4.0

Minor Changes

11.3.1

Patch Changes

11.3.0

Minor Changes

11.2.1

Patch Changes

11.2.0

Minor Changes

Patch Changes

  • Updated dependencies

11.1.1

Patch Changes

11.1.0

Minor Changes

  • #7170, (opens new window) 4f9e6e2db5, (opens new window) - These packages now have defined entry points -- this means that you cannot access internal files in the packages that are not meant to be public. Sub-components in these packages have been explicitly defined, aiding tree-shaking and reducing bundle size.

11.0.4

Patch Changes

11.0.3

Patch Changes

11.0.2

Patch Changes

  • Updated dependencies

11.0.1

Patch Changes

11.0.0

Major Changes

Patch Changes

  • Updated dependencies

10.0.19

Patch Changes

10.0.18

Patch Changes

10.0.17

Patch Changes

10.0.16

Patch Changes

10.0.15

Patch Changes

  • [patch]d222c2b987, (opens new window):

    Theme has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided.

    Breaking

    ** getTokens props changes ** When defining the value function passed into a ThemeProvider, the getTokens parameter cannot be called without props; if no props are provided an empty object {} must be passed in:

    <CustomTheme.Provider value={t => ({ ...t(), backgroundColor: '#333'})} >

    becomes:

    <CustomTheme.Provider value={t => ({ ...t({}), backgroundColor: '#333'})} >

    ** Color palette changes ** Color palettes have been moved into their own file. Users will need to update imports from this:

    import { colors } from '@atlaskit/theme'; colors.colorPalette('8');

    to this:

    import { colorPalette } from '@atlaskit/theme'; colorPalette.colorPalette('8');

    or for multi entry-point users:

    import * as colors from '@atlaskit/theme/colors'; colors.colorPalette('8');

    to this:

    import * as colorPalettes from '@atlaskit/theme/color-palette'; colorPalettes.colorPalette('8');

10.0.14

Patch Changes

10.0.13

Patch Changes

10.0.12

Patch Changes

  • [patch]097b696613, (opens new window):

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

10.0.11

Patch Changes

10.0.10

Patch Changes

10.0.9

Patch Changes

10.0.8

Patch Changes

  • [patch]926b43142b, (opens new window):

    Analytics-next has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No behavioural changes.

    Breaking changes

    • withAnalyticsForSumTypeProps alias has been removed, please use withAnalyticsEvents
    • AnalyticsContextWrappedComp alias has been removed, please use withAnalyticsContext

    Breaking changes to TypeScript annotations

    • withAnalyticsEvents now infers proptypes automatically, consumers no longer need to provide props as a generic type.
    • withAnalyticsContext now infers proptypes automatically, consumers no longer need to provide props as a generic type.
    • Type WithAnalyticsEventProps has been renamed to WithAnalyticsEventsProps to match source code
    • Type CreateUIAnalyticsEventSignature has been renamed to CreateUIAnalyticsEvent to match source code
    • Type UIAnalyticsEventHandlerSignature has been renamed to UIAnalyticsEventHandler to match source code
    • Type AnalyticsEventsPayload has been renamed to AnalyticsEventPayload
    • Type ObjectType has been removed, please use Record<string, any> or [key: string]: any
    • Type UIAnalyticsEventInterface has been removed, please use UIAnalyticsEvent
    • Type AnalyticsEventInterface has been removed, please use AnalyticsEvent
    • Type CreateAndFireEventFunction removed and should now be inferred by TypeScript
    • Type AnalyticsEventUpdater removed and should now be inferred by TypeScript

10.0.7

Patch Changes

10.0.6

Patch Changes

10.0.5

Patch Changes

10.0.4

Patch Changes

  • [patch]d0db01b410, (opens new window):

    TypeScript users of withAnalyticsEvents and withAnalyticsContext are now required to provide props as a generic type. This is so that TypeScript can correctly calculate the props and defaultProps of the returned component.

    Before:

    withAnalyticsEvents()(Button) as ComponentClass<Props>;

    After:

    withAnalyticsEvents<Props>()(Button);

10.0.3

Patch Changes

10.0.2

Patch Changes

10.0.1

10.0.0

  • [major]7c17b35107, (opens new window):
    • 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.

9.0.0

8.0.3

8.0.2

8.0.1

8.0.0

  • [major]76299208e6, (opens new window):

    • 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, (opens new window) (for external) if you have any questions or queries about this.

7.0.12

  • Updated dependencies 58b84fa, (opens new window):
    • @atlaskit/analytics-next@3.1.2
    • @atlaskit/button@10.1.1
    • @atlaskit/theme@7.0.1
    • @atlaskit/docs@6.0.0

7.0.11

7.0.10

  • Updated dependencies 6998f11, (opens new window):
    • @atlaskit/docs@5.2.1
    • @atlaskit/analytics-next@3.1.1
    • @atlaskit/theme@6.2.1
    • @atlaskit/button@10.0.0

7.0.9

  • [patch]a637f5e, (opens new window):
    • Refine and fix some flow type errors found by fixing @atlaskit/analytics-next HOCs to allow flow to type check properly

7.0.8

7.0.7

7.0.5

7.0.4

7.0.3

  • [patch] Updated dependencies acd86a1, (opens new window)
    • @atlaskit/button@9.0.4
    • @atlaskit/theme@5.1.2
    • @atlaskit/analytics-next@3.0.3
    • @atlaskit/docs@5.0.2

7.0.2

7.0.1

7.0.0

6.0.3

6.0.2

6.0.1

6.0.0

5.0.2

5.0.0

4.1.1

4.1.0

4.0.9

4.0.8

4.0.7

4.0.6

4.0.5

4.0.4

4.0.3 (2017-12-21)

4.0.2 (2017-11-27)

4.0.1 (2017-11-15)

4.0.0 (2017-11-14)

3.0.3 (2017-10-26)

3.0.2 (2017-10-22)

3.0.1 (2017-10-13)

3.0.0 (2017-08-31)

2.4.3 (2017-08-09)

2.4.2 (2017-07-27)

2.4.1 (2017-07-25)

2.1.0 (2017-07-17)

2.1.0 (2017-07-17)

2.0.5 (2017-07-13)

2.0.4 (2017-04-27)

2.0.3 (2017-04-26)

2.0.2 (2017-03-29)

2.0.1 (2017-03-28)

2.0.0 (2017-03-27)

  • refactor the blanket component to use styled-components (62dc8f2, (opens new window))
  • breaking; removed dependency "classnames", added peerDependency "styled-components"

1.2.4 (2017-03-23)

1.2.2 (2017-03-21)

1.2.0 (2017-02-27)

1.1.0 (2017-02-22)

1.0.2 (2017-02-10)

1.0.1 (2017-02-06)

Was this page helpful?
We use this feedback to improve our documentation.
© 2026 AtlassianTrademark, (opens new window)Privacy, (opens new window)License