Skip to content

Commit dad27a7

Browse files
committed
feat: update README based on new version of style-dictionary
1 parent eba804f commit dad27a7

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

README.md

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Generate `tailwind.config.js` by setting type to `all`.
2424
See [Creating each theme file](https://github.com/nado1001/sd-tailwindcss-transformer#creating-each-theme-file) if you wish to customize the configuration file with [plugin functions](https://tailwindcss.com/docs/plugins), etc.
2525

2626
```js
27-
const StyleDictionaryModule = require('style-dictionary')
28-
const { makeSdTailwindConfig } = require('sd-tailwindcss-transformer')
29-
30-
const StyleDictionary = StyleDictionaryModule.extend(
31-
makeSdTailwindConfig({ type: 'all' })
32-
)
33-
34-
StyleDictionary.buildAllPlatforms()
27+
import StyleDictionary from 'style-dictionary';
28+
import { makeSdTailwindConfig } from 'sd-tailwindcss-transformer';
29+
30+
const StyleDictionaryTailwind = new StyleDictionary(
31+
makeSdTailwindConfig({ type: 'all' }),
32+
);
33+
await styleDictionaryTailwind.hasInitialized;
34+
await StyleDictionaryTailwind.buildAllPlatforms();
3535
```
3636

3737
Output:
@@ -68,18 +68,21 @@ Create an object for each theme, assuming that various customizations will be ma
6868
Import and use the created files in `tailwind.config.js`.
6969

7070
```js
71-
const StyleDictionaryModule = require('style-dictionary')
72-
const { makeSdTailwindConfig } = require('sd-tailwindcss-transformer')
71+
import StyleDictionary from 'style-dictionary';
72+
import { makeSdTailwindConfig } from 'sd-tailwindcss-transformer';
7373

74-
const types = ['colors', 'fontSize']
74+
const types = ['colors', 'fontSize'];
7575

76-
types.map((type) => {
77-
const StyleDictionary = StyleDictionaryModule.extend(
78-
makeSdTailwindConfig({ type })
79-
)
76+
for (const type of types) {
77+
let tailwindConfig = makeSdTailwindConfig({
78+
type,
79+
});
8080

81-
StyleDictionary.buildAllPlatforms()
82-
})
81+
const styleDictionaryTailwind = new StyleDictionary(tailwindConfig);
82+
83+
await styleDictionaryTailwind.hasInitialized;
84+
await styleDictionaryTailwind.buildAllPlatforms();
85+
}
8386
```
8487

8588
Output:
@@ -110,30 +113,33 @@ CSS custom variables can be used by setting isVariables to `true`.
110113
In this case, a CSS file must also be generated.
111114

112115
```js
113-
const StyleDictionaryModule = require('style-dictionary')
114-
const { makeSdTailwindConfig } = require('sd-tailwindcss-transformer')
116+
import StyleDictionary from 'style-dictionary';
117+
import { makeSdTailwindConfig } from 'sd-tailwindcss-transformer';
115118

116119
const sdConfig = makeSdTailwindConfig({
117-
type: 'all',
118-
isVariables: true
119-
})
120+
type: 'all',
121+
isVariables: true,
122+
});
120123

121124
sdConfig.platforms['css'] = {
122-
transformGroup: 'css',
123-
buildPath: './styles/',
124-
files: [
125-
{
126-
destination: 'tailwind.css',
127-
format: 'css/variables',
128-
options: {
129-
outputReferences: true
130-
}
131-
}
132-
]
133-
}
134-
135-
const StyleDictionary = StyleDictionaryModule.extend(sdConfig)
136-
StyleDictionary.buildAllPlatforms()
125+
transformGroup: 'css',
126+
buildPath: './styles/',
127+
files: [
128+
{
129+
destination: 'tailwind.css',
130+
format: 'css/variables',
131+
options: {
132+
outputReferences: true,
133+
},
134+
},
135+
],
136+
};
137+
138+
const StyleDictionaryTailwind = new StyleDictionary(
139+
makeSdTailwindConfig({ type: 'all' }),
140+
);
141+
await styleDictionaryTailwind.hasInitialized;
142+
await StyleDictionaryTailwind.buildAllPlatforms();
137143
```
138144

139145
Output:

0 commit comments

Comments
 (0)