Skip to content

Latest commit

 

History

History
83 lines (56 loc) · 2.1 KB

README.md

File metadata and controls

83 lines (56 loc) · 2.1 KB
Raw

ClearKit One

A Tailwind preset and accompanying stylesheet for use across Clearbit user interfaces.

Installation

yarn add @clearkit/one

Usage

Note that you'll need to install Tailwind in your project in order to consume @clearkit/one.

Once installed, pull in the @clearkit/one preset in your configuration and you're halfway there.

// Your project's tailwind.config.js
const preset = require('@clearkit/one');

module.exports = {
  presets: [preset],
  variants: {
    backgroundColor: ['even', 'odd'],
  },
};

Next, be sure to import the following stylesheet, as it contains all of the class definitions for any .ck-* prefixed component (e.g., ck-button, or ck-toast).

/* Your project's main CSS entry point */
@tailwind utilities;
@tailwind base;
@tailwind components;
@import '~@clearkit/one/dist/components.css';

Local Development

yarn
yarn start

Testing in a Consuming Application

Since @clearkit/one is a separate repository from consuming apps, it may be necessary to test CSS changes in situation (e.g., in a component in @clearkit/react). This is possible with yarn link

  1. In @clearkit/one, run:
yarn build
yarn link
  1. In consuming app (tested in @clearkit/react), run:
yarn link "@clearkit/one"
  1. With app running, to make updates in CSS, rerun yarn build in @clearkit/one as needed.

When done local testing, make sure to run in @clearkit/one:

yarn unlink

and in the consuming app:

yarn unlink "@clearkit/one"

This will restore the installed version to the version in package.json.

Publish New Versions

This repo uses GitHub actions to automate releases and publishing. There is no need to manually create tags, releases, or publish to npm.

Follow the instructions for using actions when creating pull requests. Take careful note of how to use labels to create semantic versions.