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

Package detail

@atlaskit/checkbox

atlassian83.6kApache-2.015.2.4TypeScript support: included

A checkbox is an input control that allows a user to select one or more options from a number of choices.

atlaskit, react, ui

readme

Checkbox

A checkbox is an input control that allows a user to select one or more options from a number of choices.

Installation

yarn add @atlaskit/checkbox

Usage

Detailed docs and example usage can be found here.

changelog

@atlaskit/checkbox

15.2.4

Patch Changes

15.2.3

Patch Changes

  • Updated dependencies

15.2.2

Patch Changes

  • Updated dependencies

15.2.1

Patch Changes

  • Updated dependencies

15.2.0

Minor Changes

15.1.1

Patch Changes

  • #166026 962b5e77810fb - Adds side-effect config to support Compiled css extraction in third-party apps

15.1.0

Minor Changes

Patch Changes

  • Updated dependencies

15.0.0

Major Changes

  • #153563 c30346996e058 - Removes size prop from checkbox, using the default "medium" size for all checkboxes. There is a codemod included that removes this prop for you.

Patch Changes

  • Updated dependencies

14.0.3

Patch Changes

  • Updated dependencies

14.0.2

Patch Changes

  • Updated dependencies

14.0.1

Patch Changes

  • Updated dependencies

14.0.0

Major Changes

  • #136677 d0453c21aafb7 - Remove small and xlarge from sizes. These are currently completely unused within Atlassian and the smaller size results in less accessible interfaces. We are also deprecating the size prop to eventually only have checkboxes render at medium (the default) size.

13.7.1

Patch Changes

  • Updated dependencies

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

13.6.1

Patch Changes

  • Updated dependencies

13.6.0

Minor Changes

  • #126756 be7f8b7ab5827 - Accessibility changes. Removed aria-checked attribute, and set indeterminate to true if nested checkbox is checked.

13.5.2

Patch Changes

13.5.1

Patch Changes

  • Updated dependencies

13.5.0

Minor Changes

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

Patch Changes

  • Updated dependencies

13.4.0

Minor Changes

13.3.0

Minor Changes

  • #94675 5d9e1dccacca - [ux] Update input border color token to meet 3:1 color contrast ratioLight theme: color.border.input: #091E4224 → #8590A2Dark mode: color.border.input: #A6C5E229 → #738496

Patch Changes

  • Updated dependencies

13.2.0

Minor Changes

13.1.5

Patch Changes

13.1.4

Patch Changes

13.1.3

Patch Changes

  • #83297 6b1707c169e0 - The internal composition of this component has changed. There is no expected change in behaviour.

13.1.2

Patch Changes

13.1.1

Patch Changes

13.1.0

Minor Changes

  • #80805 427c2dd9e0d6 - [ux] update border with from 2px to 1px with darker color to meet 3:1 color contrast for accessibility improvement

Patch Changes

  • Updated dependencies

13.0.2

Patch Changes

  • #78598 cabae83473c3 - [ux] Improved visibility of focus styles by adding a gap between the checkbox and focus ring. This makes the focus ring easier to distinguish to a selected checkbox, which is also blue.

13.0.1

Patch Changes

  • Updated dependencies

13.0.0

Major Changes

  • #41760 909e4a30fe7 - Removed all remaining legacy theming logic from the Blanket, Breadcrumbs and Checkbox components.

12.6.11

Patch Changes

12.6.10

Patch Changes

12.6.9

Patch Changes

12.6.8

Patch Changes

  • #37615 ba0a43d8ccc - [ux] update focused color fallback to meet contrast requirement

12.6.7

Patch Changes

12.6.6

Patch Changes

  • #36754 4ae083a7e66 - Use @af/accessibility-testing for default jest-axe config and jest-axe import in accessibility testing.

12.6.5

Patch Changes

12.6.4

Patch Changes

12.6.3

Patch Changes

  • #34051 49b08bfdf5f - Migrated use of gridSize to space tokens where possible. There is no expected visual or behaviour change.

12.6.2

Patch Changes

12.6.1

Patch Changes

12.6.0

Minor Changes

  • #33335 8d0fd2d3f6c - [ux] reduce stroke width from 2px to 1px with new color to meet contrast requirement

12.5.0

Minor Changes

Patch Changes

  • Updated dependencies

12.4.6

Patch Changes

  • Updated dependencies

12.4.5

Patch Changes

  • Updated dependencies

12.4.4

Patch Changes

  • Updated dependencies

12.4.3

Patch Changes

  • Updated dependencies

12.4.2

Patch Changes

  • #27738 ed1b0fd2c2d - [ux] Removes redundant whitespace from checkbox when no visual label is applied - eg when an aria-label or id is used instead.

12.4.1

Patch Changes

  • Updated dependencies

12.4.0

Minor Changes

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

Patch Changes

  • Updated dependencies

12.3.20

Patch Changes

12.3.19

Patch Changes

12.3.18

Patch Changes

  • #23381 fe575d49d66 - Updated styles to use new input design tokens
  • Updated dependencies

12.3.17

Patch Changes

12.3.16

Patch Changes

  • #23179 f55cf469372 - Added id property to the checkbox label for compatibility with aria-labelledby

12.3.15

Patch Changes

  • Updated dependencies

12.3.14

Patch Changes

  • #22130 ff75f6c3189 - [ux] Checkbox now uses grid layout in order to position the hidden checkbox over the area where the icon is. This improves the virtual cursor for screen readers while also meaning that modifier keys used when clicking the checkbox work."

12.3.13

Patch Changes

  • Updated dependencies

12.3.12

Patch Changes

12.3.11

Patch Changes

  • Updated dependencies

12.3.10

Patch Changes

  • Updated dependencies

12.3.9

Patch Changes

  • Updated dependencies

12.3.8

Patch Changes

  • #18526 5d27b03c5cf - Styles have been rewritten in preparation for migration to compiled.
  • Updated dependencies

12.3.7

Patch Changes

  • #16752 19d72473dfb - Updates usage of deprecated token names so they're aligned with the latest naming conventions. No UI or visual changes
  • Updated dependencies

12.3.6

Patch Changes

  • Updated dependencies

12.3.5

Patch Changes

  • #15998 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

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

  • #13864 6e2231d4609 - Checkbox no longer creates an empty <span/> element next to the input if no label is provided.
  • Updated dependencies

12.3.0

Minor Changes

  • #13302 fe79d66ea34 - Instruments checkbox with the new tokens api. This will continue to work alongside the existing theming implementation. No visual changes

Patch Changes

  • b6b4c4100cd - Updates high contrast css declarations to use system color tokens + generic media query
  • 2d7cc544696 - Updates token usage to match the latest token set
  • Updated dependencies

12.2.2

Patch Changes

  • #12837 18c128f6b73 - [ux] Fix bug in which modified click events (e.g. Ctrl+Click) would not get passed down to the underlying input element in Firefox.
  • Updated dependencies

12.2.1

Patch Changes

12.2.0

Minor Changes

Patch Changes

  • 3c67db1a6e9 - Fix for checkbox to account for a change in the @atlaskit/icon API
  • Updated dependencies

12.1.3

Patch Changes

12.1.2

Patch Changes

  • #11584 37324ccc750 - Fix styling error causing rendering errors in iOS Safari, and focus rings in Firefox

12.1.1

Patch Changes

  • #10230 a99925b1634 - Added styles for edge high contrast modes (black on white and white on black)
  • Updated dependencies

12.1.0

Minor Changes

  • #9510 02a0cdbd98b - Added aria-invalid to checkbox input which corresponds the isInvalid prop

12.0.2

Patch Changes

  • #9083 e0278312c57 - Checkbox now uses the new SVG component from @atlaskit/icon.
  • Updated dependencies

12.0.1

Patch Changes

  • #8644 79c23df6340 - Use injected package name and version for analytics instead of version.json.
  • 08c1f789a45 - [ux] Fixes flickering when transitioning to and from indeterminate states

12.0.0

Major Changes

  • #6571 ee02ee0aaa In this version, we made Checkbox dramatically faster and more lightweight 😍

Changes

In 12.0.0 we improved the performance of Checkbox by making it more similar to a native checkbox and removing performance-heavy API.

Overrides

overrides is an API that allowed extreme customisation flexibility. Previously you could customise the css and attributes of 6 internal components or replace the component entirely.

<Checkbox
  overrides={{
    IconWrapper: {
      cssFn: defaultStyles => {
        ...defaultStyles,
        transition: 'all 0.3 cubic-bezier',
      },
      component: SomeCustomComponent,
      attributes: { 'data-custom': true }
    }
  }}
/>

This proved to be a significant performance problem even if you weren't using the API. It also exposes internal structure as external API which prevents us from changing the structure and improving the component. We found that not many consumers were using overrides so we decided to benefit all consumers of Checkbox we have removed overrides from the package. If you are using overrides and we haven't already been in contact with you, contact the design system team for assistance in migrating away from it.

Theming

theme is another API that allows you to customise the appearance of Checkbox. Theming could previously be used to customise the various colours, spacing and sizes used in Checkbox. Much like overrides there was minimal usage of this API and it was identified to have a negative performance impact regardless of whether it was used.

We decided to also remove this API to benefit all consumers of Checkbox. If you would like to continue customising checkbox there are now two ways of doing this. Checkbox now spreads any HTMLInputAttribute onto the checkbox input. Therefore you can put a className on the checkbox input and target the svg that is actually being shown, in the exact same way that we target the svg based off checkbox styles. For example,

import React from 'react';
import { css } from '@emotion/core';
import { Checkbox } from '@atlaskit/checkbox;

export default function CustomStyleExample() {
  return (
    <Checkbox
      label="Custom style checkbox"
      css={css`
        & + svg {
          margin-left: -2px;
        }
      `}
    />
  )
}

You can also customise the size of the Checkbox with the size prop.

import React from 'react';

import { Checkbox } from '@atlaskit/Checkbox';

export default function LargeSizeExample() {
  return (
    <Checkbox
      defaultChecked
      value="Large checkbox"
      label="Large checkbox"
      name="checkbox-basic"
      size="large"
      testId="large"
    />
  );
}

Note that Checkbox still supports the light mode / dark mode global token. Along with this change we have removed the exports ComponentTokens and ThemeFn from Checkbox as they can no longer be used with the removal of theme.

Other changes

  • Previously all interaction styles were generated in JS using events, causing unnecessary and slow rerenders for actions like hovering and focusing. Now all styles for the Checkbox are applied using css selectors.
  • To generate less dom elements we have removed the dependency on @atlaskit/icon and instead changed to an svg that can be customised to be the default checkbox or the indeterminate checkbox. This svg is styled from the input element with the sibling selector.
  • The disabled state of Checkbox previously had no border. This was not intentional and now Checkbox has a 2px border when it is disabled, this is consistent with all other states of Checkbox.
  • CheckboxProps now extends HTMLInputAttribute which means you can pass any input attribute as a prop onto Checkbox.
  • Changed the inputRef prop to be ref which returns the ref of the checkbox input using forwardRef. This new ref prop will accept the type of the old inputRef prop, (input?: HTMLInputElement) => any, as well as if ref is created with createRef.
  • Removed the prop isFullWidth as it did not do anything.
  • Updated the entry point to only export Checkbox and CheckboxProps. Checkbox can now be a named or default import. As the old entry point allowed access to every export at the base level these exports have now been removed; ComponentTokens, ThemeFn, CheckboxWithoutAnalytics, CheckboxIcon as well as all exported types.
  • Changed indeterminate checkboxes to set aria-checked to be mixed.

Automatic upgrading

There is a codemod that assists you in upgrading most of the changes from above.

  • Removes isFullWidth, theme and overrides prop.
  • Shifts over usages of inputRef to ref
  • Removes imports of ComponentTokens and ThemeFn.
  • Changes imports of CheckboxProps to be at the base level.
  • Changes imports of CheckboxWithoutAnalytics to import Checkbox at the base level.
# You first need to have the latest `Checkbox` installed before you can run the codemod
yarn upgrade @atlaskit/checkbox@^12.0.0

# Run the codemod cli
# Pass in a parser for your codebase
npx @atlaskit/codemod-cli /path/to/target/directory --parser [tsx | flow | babel]

Patch Changes

  • c7604cdf02 - In 12.0.0 the checkbox input accidentally changed vertical alignment from top to center. This had a visual impact when you had a checkbox label the spanned multiple lines. This changes the vertical alignment of the checkbox input back to top.
  • 6cb7f0c5e5 - Patch fix to make the svg not shrink and give Checkbox a display name.

11.0.8

Patch Changes

11.0.7

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.

11.0.6

Patch Changes

  • Updated dependencies

11.0.5

Patch Changes

11.0.4

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.

11.0.3

Patch Changes

  • #3823 6262f382de - Use the 'lodash' package instead of single-function 'lodash.*' packages
  • e99262c6f0 - All form elements now have a default font explicitly set

11.0.2

Patch Changes

  • #3293 954cc87b62 - The readme and package information has been updated to point to the new design system website.

11.0.1

Patch Changes

11.0.0

Major Changes

Patch Changes

  • Updated dependencies

10.1.14

Patch Changes

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

10.1.13

Patch Changes

10.1.12

Patch Changes

  • Updated dependencies

10.1.11

Patch Changes

10.1.10

Patch Changes

10.1.9

Patch Changes

10.1.8

Patch Changes

10.1.7

Patch Changes

10.1.6

Patch Changes

10.1.5

Patch Changes

10.1.4

Patch Changes

10.1.3

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 '@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.1.2

Patch Changes

  • [patch]35d2229b2a:

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

10.1.1

Patch Changes

  • [patch]a2d0043716:

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

10.1.0

Minor Changes

  • [minor]f22f6e1e4f:

    Adding an optional prop testId that will set the attribute value data-testid. It will help products to write better integration and end to end tests.

10.0.0

Major Changes

  • [major]97bab7fd28:

    @atlaskit/checkbox 10.x includes the following changes:

    • Replaced previous theme implementation with new @atlaskit/theme v2 implementation
      • Please read more about this implementation in the theming guide
    • Added overrides prop which enables targeted customisations of key components in the @atlaskit/checkbox package.

    Breaking Changes

    HiddenCheckbox and spread props

    Passing props to the <Checkbox/> component for them to be spread onto the underlying <HiddenCheckbox/> component is now no longer possible. @atlaskit/checkbox still supports passing props down to the <HiddenCheckbox/> component, however we've opted to make this behaviour more explicit.

    Whereas previously you would do this:

    <Checkbox
      ...supportedCheckboxProps
      'data-testid'='test-checkbox'
    />

    Now you would leverage the overrides prop to pass these props down to the <HiddenCheckbox/> component like so:

    <Checkbox
      ...supportedCheckboxProps
      overrides={{
        HiddenCheckbox:{
          attributesFn: () => ({ 'data-testid': 'test-checkbox' })
        }
      }}
    />

9.0.9

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

9.0.8

Patch Changes

9.0.7

Patch Changes

  • [patch]708028db86:

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

9.0.6

Patch Changes

  • [patch]de35ce8c67:

    Updates component maintainers

9.0.5

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

9.0.4

Patch Changes

  • [patch]9f8ab1084b:

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

9.0.3

Patch Changes

  • [patch]bbff8a7d87:

    Fixes bug, missing version.json file

9.0.2

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

9.0.1

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);

9.0.0

Major Changes

  • [major]87a2638655:

    Replaced styled-components with emotion 10 as part of Atlaskit-wide conversion process.

    No changes to styling or API; only a breaking change if checkbox is being styled using the styled-components styled function or via the styled-components theming library.

8.0.5

8.0.4

Patch Changes

8.0.3

Patch Changes

  • [patch]9c80ef7539:

    The update to node 10 reveals that unknown type is breaking the extract react types. I had to replace unknown type by any

8.0.2

8.0.1

Patch Changes

  • [patch]c67483c207:

    Fixed a scrollbar bug with checkboxes

8.0.0

  • [major]70862830d6:

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

7.0.1

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

6.0.4

6.0.3

6.0.2

  • [patch]98e11001ff:

    • Removes duplicate babel-runtime dependency

6.0.1

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

5.0.14

  • [patch]c0ad531a70:

    • Added test to make use props are passed down to hidden input

5.0.13

  • [patch]3ae465b6f0:

    • fix for checkbox logging error on mount

5.0.12

  • [patch]b0153ee6c9:

    • Enabled the isRequired validation on checkbox and added the asterisk after the checkbox label to signify the required field

5.0.11

5.0.10

  • [patch]fad28be:

    • Fixing invalid type for checkbox id prop

5.0.9

5.0.8

5.0.7

5.0.6

5.0.5

  • [patch] Upgrade guide & minor flow type fixes 0be287d

5.0.4

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

5.0.3

  • [patch] Fixed bug where checkbox would use state isChecked value when passing false to isChecked as props eaf8d16

5.0.2

5.0.1

  • [patch] Checkbox now only fires onChange once c78e59e

5.0.0

  • [major] Checkbox refactored to remove the need for CheckboxStateless 80e1925

    @atlaskit/checkbox 5.x is part of an ongoing body of work to normalize atlaskit form components. There are a few breaking changes you need to be aware of in upgrading from 4.x to 5.x.

    Exports

    @atlaskit/checkbox no longer specifies the Checkbox component as the default export. Moreover the following changes have been made to exports from the @atlaskit/checkbox package.

    Checkbox

    Checkbox is now a named export of the @atlaskit/checkboxpackage. Please import it as below.

    import { Checkbox } from @atlaskit/checkbox;

    The Checkbox component is now a conditionally controlled component, the isChecked prop is exposed for users to control the checked state of the component. This was the sole reason for having the CheckboxStateless component in pre 5.x, and as a result leveraging this pattern allows us to do away with the CheckboxStateless component.

    To let the component take care of checked state, leave the isChecked prop unset, or explicitly set it to undefined.

    Additionally, one can control the initial checked state of a component by setting the defaultChecked (boolean) prop. This is used as the initial value of the internal isChecked property in state. This value will be overridden by additional user interactions with the component.

    CheckboxStateless - deprecated

    This component has been deprecated in favor of the conditionally controlled component pattern specified above.**

    CheckboxGroup - deprecated:

    @atlaskit/checkbox no longer exports a CheckboxGroup component. It has been removed for the following reasons:

    • It was really a thin wrapper enforcing very basic styling opinions over its children (display: flex, flex: column).
    • The existing styling blocks the horizontal display of checkbox group children.

    Prop Changes

    • <Checkbox/> - initiallyChecked renamed to defaultChecked
    • <Checkbox/> - label prop now accepts type Node instead of type string.
    • <Checkbox/> - isChecked is now an optional boolean prop on the Checkbox component.

4.0.6

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

4.0.4

4.0.3

4.0.2

4.0.1

4.0.0

3.1.3

  • [patch] Button should be a dev dependency 50ca31b
  • [none] Updated dependencies 50ca31b

3.1.2

3.1.1

  • [patch] update to active box color of checkbox to b50 to inline with ADG3 guideline 21073ca
  • [none] Updated dependencies 21073ca

3.1.0

3.0.6

3.0.5

3.0.4

3.0.3

  • [patch] ref prop on checkbox stateless component is now reference to class 05b4ffd
  • [none] Updated dependencies 05b4ffd

3.0.2

  • [patch] Fix for flow 33f632f
  • [patch] Update onChange function to pass type for name and value f3e768c
  • [none] Updated dependencies 33f632f
  • [none] Updated dependencies f3e768c

3.0.1

3.0.0

2.1.0

  • [minor] Updated the appearance for checkbox and radio items ece7426
  • [none] Updated dependencies ece7426

2.0.2

2.0.0

  • [major] Bump to React 16.3. 4251858

1.4.0

  • [minor] Add indeterminate prop to stateless checkbox 3fc6c5e

1.3.1

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

1.3.0

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

1.2.3

1.2.2

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

1.2.1

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

1.2.0

  • [minor] Add React 16 support. 12ea6e4

1.1.8

  • [patch] update flow dep, fix flow errors 722ad83

1.1.7

  • [patch] Updates dependency on button to 6.0.0 2b02ebc
  • [patch] Moved to new repo & build system. Cleaned up docs & examples & added Flow 9b55672

1.1.6 (2017-11-24)

Bug Fixes

  • component: fixed typo in Checkbox defaultProps (4388a11)

1.1.5 (2017-11-22)

Bug Fixes

  • component: checkbox and radio should not highlight when parent element is focused (5c900ff)
  • component: removed focus styling from radio and checkbox svg as they will never be focused (ec68128)

1.1.4 (2017-11-15)

Bug Fixes

  • component: bumping internal dependencies to latest major version (91833c3)

1.1.3 (2017-10-27)

Bug Fixes

  • stories: rebuild stories (7aa7337)

1.1.2 (2017-10-22)

Bug Fixes

  • package: update dependencies for react-16 (077d1ad)

1.1.1 (2017-10-10)

Bug Fixes

  • package: removed internal label from keywords (b76b4f2)

1.1.0 (2017-09-27)

Bug Fixes

  • component: change margin of icon (4459e96)

Features

  • component: dark mode checkbox (554c978)

1.0.0 (2017-09-13)

Features

  • component: create checkbox component (5ce7055)