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

Package detail

@atlaskit/docs

atlassian1.8kApache-2.09.1.30

Utilities for building documentation

readme

changelog

@atlaskit/docs

9.1.30

Patch Changes

  • Updated dependencies

9.1.29

Patch Changes

  • Updated dependencies

9.1.28

Patch Changes

  • Updated dependencies

9.1.27

Patch Changes

  • Updated dependencies

9.1.26

Patch Changes

  • Updated dependencies

9.1.25

Patch Changes

  • Updated dependencies

9.1.24

Patch Changes

  • Updated dependencies

9.1.23

Patch Changes

  • Updated dependencies

9.1.22

Patch Changes

  • Updated dependencies

9.1.21

Patch Changes

  • Updated dependencies

9.1.20

Patch Changes

  • Updated dependencies

9.1.19

Patch Changes

  • Updated dependencies

9.1.18

Patch Changes

  • Updated dependencies

9.1.17

Patch Changes

  • Updated dependencies

9.1.16

Patch Changes

  • Updated dependencies

9.1.15

Patch Changes

  • Updated dependencies

9.1.14

Patch Changes

  • Updated dependencies

9.1.13

Patch Changes

  • Updated dependencies

9.1.12

Patch Changes

  • Updated dependencies

9.1.11

Patch Changes

  • Updated dependencies

9.1.10

Patch Changes

  • Updated dependencies

9.1.9

Patch Changes

  • Updated dependencies

9.1.8

Patch Changes

  • Updated dependencies

9.1.7

Patch Changes

9.1.6

Patch Changes

  • #129411 300b0a472d9ce - Removes deprecated usage of ak/theme mixin functions and replaces them with their direct outputs
  • Updated dependencies

9.1.5

Patch Changes

  • Updated dependencies

9.1.4

Patch Changes

  • Updated dependencies

9.1.3

Patch Changes

  • Updated dependencies

9.1.2

Patch Changes

  • Updated dependencies

9.1.1

Patch Changes

  • Updated dependencies

9.1.0

Minor Changes

Patch Changes

  • Updated dependencies

9.0.13

Patch Changes

  • #25547 93118b676a8 - This changeset exists because a PR touches these packages in a way that doesn't require a release

9.0.12

Patch Changes

9.0.11

Patch Changes

9.0.10

Patch Changes

  • Updated dependencies

9.0.9

Patch Changes

  • Updated dependencies

9.0.8

Patch Changes

9.0.7

Patch Changes

  • Updated dependencies

9.0.6

Patch Changes

  • #10230 7ba7af04db8 - Type fixes related to consumption of @atlaskit/code
  • Updated dependencies

9.0.5

Patch Changes

9.0.4

Patch Changes

  • Updated dependencies

9.0.3

Patch Changes

  • Updated dependencies

9.0.2

Patch Changes

  • #4424 7315203b80 - Rename AkCode and AkCodeBlock exports to Code and CodeBlock for @atlaskit/code.
  • Updated dependencies

9.0.1

Patch Changes

  • #4573 30853172ff - Reset babel config back to ie11 to prevent runtime issues in Jira and to unbreak the Confluence es5-check

9.0.0

Major Changes

Patch Changes

  • Updated dependencies

8.5.4

Patch Changes

8.5.3

Patch Changes

  • #2731 a5815adf37 - Fixed es2019 distributable missing a version.json file

8.5.2

Patch Changes

8.5.1

Patch Changes

8.5.0

Minor Changes

  • [minor]8c9e4f1ec6:

    Minor – The example component can now have the visibility of the source view controlled via a sourceVisible prop. If completely controlled source toggle behavior is required, the optional onToggleSource callback prop will replace internal source toggle behavior.

Patch Changes

8.4.0

Minor Changes

  • [minor]66dcced7a0:

    Update pretty-proptypes dependency in @atlaskit/docs added a PropTable component to render prop-types in a table Added automatic prop-resolution behaviour to @atlaskit/gatsby-theme-brisk

Patch Changes

8.3.2

Patch Changes

8.3.1

Patch Changes

8.3.0

Minor Changes

Patch Changes

8.2.0

Minor Changes

  • [minor]9648afc5be:

    Adds highlight prop to AkCodeBlock, Example, and the code template literal. Use this to emphasize which lines of code you would like people to look at!

    The highlight prop can be used as follows:

    • To highlight one line: highlight="3"
    • To highlight sequential lines: highlight="1-5"
    • To highlight sequential and multiple single lines: highlight="1-5,7,10,15-20"

    AkCodeBlock component

    Use the highlight prop.

    import { AkCodeBlock } from '@atlaskit/code';

<AkCodeBlock
    highlight="1-2"
    text={`
<div>
  hello there
  <span>buds</span>
</div>
  `}
/>;

    Example component

    Use the highlight prop.

    import { Example } from '@atlaskit/docs';

<Example
    packageName="@atlaskit/code"
    Component={require('../examples/00-inline-code-basic').default}
    title="Basic"
    highlight="19,24,30,36"
    source={require('!!raw-loader!../examples/00-inline-code-basic')}
/>;

    code template literal

    Add highlight= to the top of your code snippet. It takes the same values as the highlight prop.

    import { code } from '@atlaskit/docs';

code`highlight=5-7
  import React from 'react';

  () => (
    <div>
      hello there
      <span>buds</span>
    </div>
)`;

8.1.9

Patch Changes

  • [patch]5f044ec4d0:

    Update pretty-proptype dep fro 1.0.1 to 1.0.2

8.1.8

Patch Changes

  • [patch]35d2229b2a:

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

8.1.7

Patch Changes

  • [patch]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' })
    }
  }}
/>

8.1.6

Patch Changes

  • [patch]556c413643:

    Fixes the title size of the Atlaskit documentation messages.

8.1.5

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

Patch Changes

8.1.3

8.1.2

8.1.1

  • [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.1.0

  • [minor]35405c3362:

    Currently on the Atlaskit website, we are using section messages for developer preview at several places. In addition, as we recently removed couple of components from the Atlaskit service desk, we need to indicate if the component is intended for Atlassian first. Hence, We added another section message that will warn about the usage.

    Now, in your docs, you can directly import those section messages to inform your customers.

    Usage:

    • <AtlassianInternalWarning /> is the section message that warns about Atlassian usage.

    • <DevPreviewWarning> is the section message that warns about the componenent readiness.

    • If you add the two section messages, meaning the component is Atlassian only and in dev preview: import { AtlassianInternalWarning, DevPreviewWarning } from '@atlaskit/docs/src/SectionMessages';

        <>
    <div style={{ marginBottom: '0.5rem'}}>
    <AtlassianInternalWarning />
    </div>
    <div style={{ marginTop: '0.5rem'}}>
      <DevPreviewWarning />
    </div>
    </>
  )}```

- If you need one component, just import the requested one: `${( <AtlassianInternalWarning />)}`

  • Updated dependencies 97bfe81ec8:

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

  • [patch]d3cad2622e:

    • Removes babel-runtime in favour of @babel/runtime

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

  • [patch]050e08173f:

    • Add missing import for codesandboxer

6.0.1

6.0.0

  • [major]58b84fa:

    • Use latest version of pretty-proptypes - this is incompatible with extract-react-types versions under 0.15.0

5.2.3

5.2.2

5.2.1

5.2.0

  • [minor] Add ErrorBoundary to Examples so that errors in Example components don't leak out onto the containing page when embedding examples within docs. 5131102

5.1.0

  • [minor] Example component now accepts a packageName. This prop is now required 7a8278d

5.0.8

5.0.7

  • [patch] Upgrade extract-react-types to add TypeScript support. c742e5a

5.0.6

5.0.5

5.0.4

  • [patch] Export a modified replaceImport function 18f2701
  • [none] Updated dependencies 18f2701

5.0.3

  • [patch] Update pretty-proptypes c7e484c
  • [none] Updated dependencies c7e484c

5.0.2

5.0.1

5.0.0

4.2.2

  • [patch] Add missing dependencies to packages to get the website to build 99446e3

  • [none] Updated dependencies 99446e3

  • [none] Updated dependencies 9bac948

4.2.1

4.2.0

  • [minor] Added upgrade guide, updated atlaskit/docs dep on react-markings to expose md parser customisations aef4aea
  • [none] Updated dependencies aef4aea

4.1.1

4.1.0

4.0.1

4.0.0

3.0.4

3.0.3

3.0.2

  • [patch] Upgrade pretty proptypes 0ad9962

3.0.1

  • [patch] Switch to using pretty-proptypes 2b08b6b

3.0.0

  • [major] Bump to React 16.3. 4251858

2.6.2

  • [patch] Update look and feel of collapsed props e42d92e

2.6.1

  • [patch] Props with default values are not marked as required d00499f

2.6.0

  • [minor] Add prop to allow proptype shape to be hidden 3150228

2.5.5

  • [patch] Docs now handle props of nested intersections, and remove console errors fd2d099

2.5.4

  • [patch] Make header not display when passed a string cff04f2

2.5.3

  • [patch] Add converter for intersection in prettyPropType 0d6b5fa

2.5.2

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

2.5.1

  • [patch] Update kind2string dependency to 0.3.1 2c432fd

2.5.0

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

2.4.3

2.4.2

  • [patch] Refactor code helper function to fix React re-render bug. 8dcb772

2.4.1

2.4.0

  • [minor] Add React 16 support. 12ea6e4

2.3.0

  • [minor] Added support for JSX Elements in default prop declarations 8030309

2.2.0

  • [minor] Props component now understands how to parse members of the Array type 3eebe75

2.1.1

  • [patch] Convert function parameters f6c5a21
  • [patch] Convert function parameters f6c5a21

2.1.0

  • [minor] corrected types and added heading option to props bdf39b3
  • [minor] corrected types and added heading option to props bdf39b3

2.0.0

  • [major] Now renders default props, consumes breaking change from extract-react-types df9fa94
  • [major] Now renders default props, consumes breaking change from extract-react-types df9fa94

1.0.1

  • [patch] Releasing 1.x as this is now stable 0b87d5c
  • [patch] Releasing 1.x as this is now stable 0b87d5c

0.0.7

  • [patch] Bump version of @atlaskit/docs everywhere 9a0ea18
  • [patch] Bump version of @atlaskit/docs everywhere 9a0ea18
  • [patch] Update react-markings dependency 71d0703
  • [patch] Update react-markings dependency 71d0703

0.0.6

  • [patch] bump icon dependency da14956
  • [patch] bump icon dependency da14956

0.0.5

  • [patch] bump consumer versions for release c730a1c
  • [patch] bump consumer versions for release c730a1c
  • [patch] Add documentation to editor core; introduce code formatting method to docs a1c7e56
  • [patch] Add documentation to editor core; introduce code formatting method to docs a1c7e56

0.0.4

  • [patch] Use correct dependencies 7b178b1
  • [patch] Use correct dependencies 7b178b1
  • [patch] Adding responsive behavior to the editor. e0d9867
  • [patch] Adding responsive behavior to the editor. e0d9867