@rocketclimb/tw-utils
v0.0.2
Published
Tailwind utils package for rocketclimb plugins
Downloads
428
Readme
tw-utils
Overview
tw-utils
is a utility library designed to assist in parsing Tailwind CSS configurations on creating Tailwind plugins.
Features
- Parse Tailwind CSS configuration files easily.
- Parse extend configuration merging with default or base configuration
Installation
To install tw-utils
, use npm or yarn:
npm install tw-utils
# or
yarn add tw-utils
Usage
Parsing Tailwind Config You can use tw-utils to parse your Tailwind CSS configuration file. Here’s an example:
import { configResolver } from "./config-resolver";
// config is the Tailwind helper for looking up values in the user’s Tailwind configuration as documented at https://tailwindcss.com/docs/plugins
configResolver("path", config);
Resolver options
export type ResolverOptions<T> = {
rootPath?: string; // change the intial path for the lookup
defaultConfig?: T; // add default configuration
};
License
This project is licensed under the MIT License. See the LICENSE file for details.