This public repository contains a collection of reusable packages designed for Atlassian products and experiences, mirrored from our internal repository.
All packages in this repository are available as individual npm packages.
Packages in this repository can have peer dependencies. When installing a package make sure to have these installed first:
npm i react@^16.8 react-dom@^16.8 styled-components@^3.2
Packages related to Editor and Media can also have a peer dependency on react-intl. If using an Editor or Media package, make sure to install this peer dependency:
npm i react-intl@^2.6
Since these are all peer dependencies, they need to be on the specified major version. Undefined behavior may occur when trying to use these peer dependencies on different major versions.
Some packages need this reset to ensure styles are rendered consistently as undefined behavior can happen without it:
npm i @atlaskit/css-reset
For setup instructions please view the CSS reset documentation.
Currently packages in this repository support the following versions of tools:
- npm: >= 9.0.0
- yarn: >= 1.23.0
- Node: >= 16
- Webpack: >=4.0.0 && <= 5.0.0
- Parcel: >= 2.8
Install packages you’re interested in using, for example, a button:
npm i @atlaskit/button
import Button from '@atlaskit/button';
<Button>Hello world!</Button>
Atlassian Frontend supports all supported browsers for Atlassian cloud products.
| Latest ✔ Latest Android ✔ Latest iOS ✔ | Latest on latest macOS ✔ Latest iOS ✔ | Latest ✔ | Latest ✔ |
Currently, Atlassian Frontend is only accepting contributions from Atlassian employees. If you are an Atlassian employee you can find information about this on our internal docs.
For developers outside of Atlassian looking for help, or to report issues, please make a post on the community forum. The forums are monitored and posts will be directed to the appropriate maintainers. We offer support for components that are part of the Atlassian Design System (which corresponds to the /design-system folder in the repository).
Please note that the level of support varies for all other packages. They are owned by different teams within Atlassian and are primarily intended for internal use. We will monitor the forums and try our best to redirect topics to the appropriate maintainers, but some packages are made available without official support.
This repository is a monorepo, which means that different parts of this repository can have different licenses.
The base level of the repository is licensed under Apache 2.0. There are separate license files for each package that specifies the license restrictions. (For example, view the Avatar license).
If you fork this repository, you can continue to use Atlassian Design Guidelines licensed packages only under the given license restrictions. If you want to redistribute this repository, you will need to replace these Atlassian Design Guidelines licensed packages with your own implementation.
Copyright © 2020 Atlassian
This is a mirror of all public @atlaskit scoped packages from Atlassian Frontend. No issues, commits, or pull requests can be made to this repository at this time.