@kaizen/tailwind 0.3.0 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/package.json +2 -2
- package/README.md +0 -53
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.3.1](https://github.com/cultureamp/kaizen-design-system/compare/@kaizen/tailwind@0.3.0...@kaizen/tailwind@0.3.1) (2023-01-31)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @kaizen/tailwind
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
# [0.3.0](https://github.com/cultureamp/kaizen-design-system/compare/@kaizen/tailwind@0.2.7...@kaizen/tailwind@0.3.0) (2023-01-30)
|
|
7
15
|
|
|
8
16
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kaizen/tailwind",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Kaizen Tailwind presets",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "yarn clean && yarn prepublish",
|
|
@@ -39,5 +39,5 @@
|
|
|
39
39
|
"peerDependencies": {
|
|
40
40
|
"react": "^16.14.0 || ^17.0.0 || ^18.0.0"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "34cab1ad71ba487271950c7ac3e2f52b9f1e515c"
|
|
43
43
|
}
|
package/README.md
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Install
|
|
2
|
-
|
|
3
|
-
```
|
|
4
|
-
yarn add -D @kaizen/tailwind
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
- [Caveat before use](#caveat-before-use)
|
|
10
|
-
- [What our package does](#what-our-package-does)
|
|
11
|
-
- [Getting started](#getting-started)
|
|
12
|
-
|
|
13
|
-
## Caveat before use
|
|
14
|
-
|
|
15
|
-
This is an early release of the Kaizen Tailwind Preset - the API may change and evolve as we receive feedback from our teams. We will endeavour to assist where possible if classes or utilities are updated in the future.
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
## What our package does
|
|
19
|
-
|
|
20
|
-
This package is essentially a custom Tailwind preset. This package does not change how Tailwind works; it only changes the suffixes that can be attached to utilities.
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
These suffixes are based on our [design tokens](https://github.com/cultureamp/kaizen-design-system/tree/main/packages/design-tokens).
|
|
25
|
-
|
|
26
|
-
For this reason, refer to the [Tailwind core concepts docs](https://tailwindcss.com/docs/utility-first) for getting up to speed on how Tailwind _works_, but refer to our [storybook](https://cultureamp.design/storybook/) as a reference guide for our _custom suffixes_.
|
|
27
|
-
|
|
28
|
-
As an example, if I wanted to know which font-family values are available as Tailwind classes, I would open our storybook and look under Tailwind > Typography > Font Family (or just search "Font Family").
|
|
29
|
-
|
|
30
|
-
## Getting started
|
|
31
|
-
|
|
32
|
-
>The assumption is that you have previously followed the FE Foundation guide for setting Tailwind up in your project.
|
|
33
|
-
|
|
34
|
-
Install `@kaizen/tailwind` as a dependency and require it into your Tailwind config. Then, pass it into your `presets` array.
|
|
35
|
-
|
|
36
|
-
```js
|
|
37
|
-
// this originally lived in @kaizen/design-tokens but we've decoupled this for ease of versioning
|
|
38
|
-
const { Preset } = require("@kaizen/tailwind")
|
|
39
|
-
|
|
40
|
-
module.exports = {
|
|
41
|
-
content: ["./**/*.{ts,tsx}"],
|
|
42
|
-
presets: [Preset],
|
|
43
|
-
// important to add to the #root and #docs-root (for storybook) to ensure that Tailwind classes supersede component styles
|
|
44
|
-
important: ["#root", "#docs-root"],
|
|
45
|
-
theme: {
|
|
46
|
-
extend: {},
|
|
47
|
-
},
|
|
48
|
-
plugins: [],
|
|
49
|
-
}
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
For preset configuration options, see [CONFIGURATION.md](CONFIGURATION.md)
|
|
53
|
-
|