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

Package detail

@kalamazoo/blanket

stevenselcuk13Apache-2.01.0.2TypeScript support: included

A React component that covers the underlying UI for a layered component.

atlaskit, react, ui

readme

Blanket

The main purpose of the blanket component is to provide the overlay layer for components such as a modal dialog or a tooltip.

Installation

yarn add @kalamazoo/blanket

Usage

Detailed docs and example usage can be found here.

changelog

@kalamazoo/blanket

10.0.15

Patch Changes

  • [patch]d222c2b987:

    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 '@kalamazoo/theme';

colors.colorPalette('8');

    to this:

    import { colorPalette } from '@kalamazoo/theme';

colorPalette.colorPalette('8');

    or for multi entry-point users:

    import * as colors from '@kalamazoo/theme/colors';

colors.colorPalette('8');

    to this:

    import * as colorPalettes from '@kalamazoo/theme/color-palette';

colorPalettes.colorPalette('8');

10.0.14

Patch Changes

  • [patch]35d2229b2a:

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

10.0.13

Patch Changes

  • [patch]a2d0043716:

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

10.0.12

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

10.0.11

Patch Changes

10.0.10

Patch Changes

  • [patch]708028db86:

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

10.0.9

Patch Changes

  • [patch]de35ce8c67:

    Updates component maintainers

10.0.8

Patch Changes

  • [patch]926b43142b:

    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

  • [patch]9f8ab1084b:

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

10.0.6

Patch Changes

  • [patch]bbff8a7d87:

    Fixes bug, missing version.json file

10.0.5

Patch Changes

  • [patch]18dfac7332:

    In this PR, we are:

    • Re-introducing dist build folders
    • Adding back cjs
    • Replacing es5 by cjs and es2015 by esm
    • Creating folders at the root for entry-points
    • Removing the generation of the entry-points at the root Please see this ticket or this page for further details

10.0.4

Patch Changes

  • [patch]d0db01b410:

    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

  • [patch]29a1f158c1:

    Use default react import in typescript files.

10.0.2

Patch Changes

10.0.1

  • [patch]27cf35ca9d:

    • Updated event type for onBlanketClicked prop

10.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.

9.0.0

  • [major]38dab947e6:

    • Updated Blanket to TypeScript. Flow types are no longer exported.

8.0.3

8.0.2

8.0.1

8.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 `@kalamazoo/theme/colors`;

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

    import colors from `@kalamazoo/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.

7.0.12

7.0.11

7.0.10

7.0.9

  • [patch]a637f5e:

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

7.0.8

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

7.0.7

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

7.0.5

7.0.4

7.0.3

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

  • [major] Bump to React 16.3. 4251858

4.1.1

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

4.1.0

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

4.0.9

4.0.8

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

4.0.7

  • [patch] Minor documentation fixes f0e96bd

4.0.6

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

4.0.5

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

4.0.4

  • [patch] Migration of Blanket to mk2 repo 1c55d97

4.0.3 (2017-12-21)

  • bug fix; Minor change to storybook to test new s3 bucket (97cbb7d)

4.0.2 (2017-11-27)

  • bug fix; bump theme dependency to 2.2.0 (issues closed: nav-27) (2b71345)

4.0.1 (2017-11-15)

  • bug fix; bumping internal dependencies to latest major versions (288935a)

4.0.0 (2017-11-14)

  • bug fix; implemented code review comments: using theme package to get layer value and removed (b1a84f5)
  • breaking; added z-index to blanket (4665973)
  • breaking; aK-3851-fix added z-index to blanket, reverts b344810 (issues closed: ak-3851) (4665973)

3.0.3 (2017-10-26)

  • bug fix; fix to rebuild stories (793b2a7)

3.0.2 (2017-10-22)

  • bug fix; update dependencies for react-16 (077d1ad)

3.0.1 (2017-10-13)

  • bug fix; fix Blanket stories (b9ac4ab)
  • bug fix; other fix for other issue (014f79c)
  • bug fix; fix render issue for Blanket storybook (b277ff3)

3.0.0 (2017-08-31)

  • breaking; removed z-index (b344810)
  • breaking; removed z-index for integration with @kalamazoo/layer-manager (b344810)
  • feature; update to use @kalamazoo/theme - now supports dark mode (422c74e)

2.4.3 (2017-08-09)

  • bug fix; bump util-shared-styles dependency to latest to reduce app bundle sizes (issues closed: ak-3252) (dbc406c)

2.4.2 (2017-07-27)

  • fix; rename jsnext:main to jsnext:experimental:main temporarily (c7508e0)

2.4.1 (2017-07-25)

  • fix; use class transform in loose mode in babel to improve load performance in apps (fde719a)

2.1.0 (2017-07-17)

  • fix; rerelease, failed prepublish scripts (5fd82f8)

2.1.0 (2017-07-17)

  • feature; added ES module builds to dist and add jsnext:main to most ADG packages (ea76507)

2.0.5 (2017-07-13)

  • fix; testing releasing more than 5 packages at a time (e69b832)
  • fix; add prop-types as a dependency to avoid React 15.x warnings (92598eb)

2.0.4 (2017-04-27)

  • fix; update legal copy to be more clear. Not all modules include ADG license. (f3a945e)

2.0.3 (2017-04-26)

  • fix; update legal copy and fix broken links for component README on npm. New contribution and (0b3e454)

2.0.2 (2017-03-29)

  • fix; repush stories for broken releases (cde4000)

2.0.1 (2017-03-28)

  • fix; update blanket with new structure, use new readme story component (2ecfd11)

2.0.0 (2017-03-27)

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

1.2.4 (2017-03-23)

  • fix; Empty commit to release the component (49c08ee)

1.2.2 (2017-03-21)

  • fix; maintainers for all the packages were added (261d00a)

1.2.0 (2017-02-27)

  • feature; added canClickThroughBlanket prop to Blanket to make it possible to animate (cacb5cb)

1.1.0 (2017-02-22)

  • feature; add canClickThrough to blanket (c2e31aa)

1.0.2 (2017-02-10)

  • fix; Dummy commit to release components to registry (5bac43b)

1.0.1 (2017-02-06)

  • fix; bumps deps to use scoped packages (9384221)