@atlaskit/theme

What is @atlaskit/theme?

@atlaskit/theme is a theming library provided by Atlassian for creating consistent and customizable themes across Atlassian products. It offers utilities for managing colors, spacing, typography, and other design tokens, making it easier to maintain a cohesive design system.

What are @atlaskit/theme's main functionalities?

Colors

The @atlaskit/theme package provides a set of predefined colors that can be used to maintain consistency across your application. The colors are organized by their usage and intensity.

const { colors } = require('@atlaskit/theme');

const primaryColor = colors.B400;
console.log(primaryColor); // Outputs: #0052CC

Spacing

The package offers a spacing utility based on a grid system. This helps in maintaining consistent spacing throughout the application.

const { gridSize } = require('@atlaskit/theme');

const spacing = gridSize() * 2;
console.log(spacing); // Outputs: 16 (assuming gridSize is 8)

Typography

Typography utilities are provided to ensure consistent font sizes and families across the application. These utilities can be used to style text elements in a uniform manner.

const { fontSize, fontFamily } = require('@atlaskit/theme');

const headingStyle = {
  fontSize: fontSize.heading,
  fontFamily: fontFamily.heading
};
console.log(headingStyle); // Outputs: { fontSize: '24px', fontFamily: 'Arial, sans-serif' }

Theming

The @atlaskit/theme package includes a ThemeProvider component and a useTheme hook to apply and access custom themes throughout your application. This allows for dynamic theming and easy customization.

const { ThemeProvider, useTheme } = require('@atlaskit/theme');

const MyComponent = () => {
  const theme = useTheme();
  return <div style={{ color: theme.colors.text }}>Hello, World!</div>;
};

const App = () => (
  <ThemeProvider theme={{ colors: { text: '#000000' } }}>
    <MyComponent />
  </ThemeProvider>
);

Other packages similar to @atlaskit/theme

styled-components

styled-components is a popular library for styling React applications using tagged template literals. It allows for dynamic theming and scoped styles, similar to @atlaskit/theme, but with a more flexible and powerful API for creating custom styles.

emotion

Emotion is a performant and flexible CSS-in-JS library. It offers similar theming capabilities as @atlaskit/theme, with a focus on performance and developer experience. Emotion provides both styled components and a css prop for applying styles.

theme-ui

Theme UI is a library for building consistent, themeable React applications. It provides a theming context and design tokens, similar to @atlaskit/theme, but with additional utilities for building design systems and responsive styles.

README

@atlaskit/theme

* Please note that this module could have dependencies that are governed by the Atlassian Design Guidelines license which will be automatically included on install. Each dependency has a license file that indicates whether the Atlassian Design Guidelines license applies.

We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

Are you in trouble? Read through our contribution guidelines and raise an issue to us.