https://github.com/movableink/tailwind-config

Tailwind Config for Fluid
https://github.com/movableink/tailwind-config

Last synced: 1 day ago
JSON representation

Tailwind Config for Fluid

• Host: GitHub
• URL: https://github.com/movableink/tailwind-config
• Owner: movableink
• Created: 2019-12-11T22:11:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T19:14:52.000Z (about 1 year ago)
• Last Synced: 2024-09-15T22:25:34.709Z (18 days ago)
• Language: JavaScript
• Homepage: https://movableink.github.io/tailwind-config
• Size: 40 MB
• Stars: 5
• Watchers: 9
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# `@movable/tailwind-config` [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

![Verify](https://github.com/movableink/tailwind-config/workflows/Verify/badge.svg)

[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/movableink/tailwind-config)

[![Create CodePen with Template](https://img.shields.io/badge/CodePen-Use%20Template-yellow)](https://codepen.io/pen?template=jOPWJdW)

> [Tailwind][tailwind] configuration file for Movable Ink's Fluid Design System

_Note: if you wish to contribute to `@movable/tailwind-config`, please see our [contribution documentation](./CONTRIBUTING.md)._

## Installation

### Default Process

Tailwind provides good installation instructions on how to get set up with their tools, which you can find [here][tailwind-installation].

With the imports from Tailwind in place, you can leverage the Movable Ink configuration like so:

```javascript

// tailwind.config.js

module.exports = {

  presets: [require('@movable/tailwind-config')],

};

```

### Pre-Built File

For cases where you do not want to set up PostCSS or the Tailwind command line tool, a pre-built version of the Tailwind CSS is included in this package. Note that with this approach, you probably miss out on the ability to statically analyze your templates and remove any unused CSS classes.

#### From your dependencies

For tools that allow you to include a pre-existing CSS file into your application, this package includes a pre-built version of the CSS file that you can import. For example, if you are using `create-react-app`, you could add the following to your `src/index.js`

```javascript

import '@movable/tailwind-config/dist/fluid-tailwind.css';

```

And the CSS classes will be made available to you.

#### From a CDN

If you want to go even _simpler_, you can link against the pre-built CSS file on [`unpkg`][unpkg]. Include the following in the `head` of your document.

```html

```

Note that with this approach, you will _always_ get the latest version of the Tailwind CSS -- even if there was a major version bump. See the `unpkg` documentation if you want to link against a specific version the package.

### Fonts

Regardless of which approach you take to including the Tailwind CSS into your application, you _also_ must link to the font definitions that we use as part of Fluid.

Include the following `link` in the `head` of your document, _before_ any other CSS files

```html

```

[tailwind]: https://tailwindcss.com

[tailwind-installation]: https://tailwindcss.com/docs/installation

[unpkg]: https://unpkg.com

## Conventional Commits

This repo has [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) We lint for this both pre-commit and on PR actions. It is **required** and will not pass without it.

Ex:

```

fix(percy): added percy snapshots for all component states

- active

- disabled

- focused

```