This project powered by Theo provides design tokens to the Ocean design system.

Design tokens are the visual design atoms of the design system — specifically, they are named entities that store visual design attributes. We use them in place of hard-coded values (such as hex values for color or pixel values for spacing) in order to maintain a scalable and consistent visual system for UI development – Salesforce UX

Installation

yarn add @useblu/ocean-tokens

or

npm i @useblu/ocean-tokens

Usage

Javascript

import styled from 'styled-components';
import {
  fontFamilyHighlight,
  fontSizeLg,
  fontWeightExtrabold,
  lineHeightMedium,
  colorInterfaceLightPure,
} from '@useblu/ocean-tokens/web/tokens';

export const Heading1 = styled.h1`
  font-family: ${fontFamilyHighlight};
  font-size: ${fontSizeLg};
  font-weight: ${fontWeightExtrabold};
  line-height: ${lineHeightMedium};
  color: ${colorInterfaceLightPure};
`;

Sass

@import '~@useblu/ocean-tokens/web/tokens.scss';

.h1 {
  font-family: $font-family-highlight;
  font-size: $font-size-lg;
  font-weight: $font-weight-extrabold;
  line-height: $line-height-medium;
  color: $color-interface-light-pure;
}

Versioning

This package uses (Semantic Release)[https://github.com/semantic-release/semantic-release] for versioning and distributing to NPM. It analyses commits since last version to generate or not a new version. Use the follow commit prefixes to bump versions:

fix: Generates patch versions feat: Generates minor versions BREAKING CHANGES: Generate major versions

Other prefix commits (like chore:) will be ignored!

Contributing

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of this project! :blue_heart: Read below to learn how you can take part of it.

Code of Conduct

We adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

Join our community

Join our discord server to get the latest updates, chat with other Ocean enthusiasts, and see what's happening in the community!

License

All packages are licensed under the terms of the GPL-3.0 License.