TailwindCSS Text Stroke Plugin

Add custom text stroke utilities to your TailwindCSS project using this plugin. It allows you to apply an outline-like stroke around text using CSS properties supported by WebKit-based browsers.

#Installation

To use this plugin, you need to install it via pnpm, npm or yarn.

#Using pnpm

pnpm add -D @designbycode/tailwindcss-text-stroke

#Using npm

npm install @designbycode/tailwindcss-text-stroke --save-dev

#Using yarn

yarn add -D @designbycode/tailwindcss-text-stroke

First, ensure you have TailwindCSS installed in your project. If not, install it by following the official documentation.

Next, require the plugin in your TailwindCSS configuration file (usually named tailwind.config.js).

#Setup

1. First, ensure you have TailwindCSS installed in your project. If not, install it by following the official documentation.

2. Next, require the plugin in your TailwindCSS configuration file (usually named tailwind.config.js).

module.exports = {
  // ...other configurations
  plugins: [
    // ...other plugins
    require("@designbycode/tailwindcss-text-stroke"),
  ],
};

Once you've required the plugin and added it to the plugins array, you can use the new text stroke utilities in your HTML templates.

#Use

The Text Stroke plugin provides the following utility classes for styling text with stroke effects:

• .text-stroke: Base component that sets the default text stroke styles. You can override these styles using CSS variables.
• .text-stroke-{value}: Sets the stroke width to the specified {value}. The available options are defined in the textStrokeWidth theme configuration.
• .text-stroke-{color}: Applies a custom color to the text stroke. The {color} should match a color in your TailwindCSS color palette.
• .text-stroke-fill-{color}: Applies a custom fill color to the text stroke. The {color} should match a color in your TailwindCSS color palette.

#Example

Here's an example of how you can use the utility classes to apply image masks:

<h1 class="text-7xl font-black text-stroke">
  Hello, TailwindCSS
</h1>

#With modifiers

<h1 class="text-7xl font-black text-stroke text-stroke-indigo-200 text-stroke-fill-indigo-600">
  Hello, TailwindCSS
</h1>

#Conclusion

The TailwindCSS Stripes Plugin simplifies the process of creating striped backgrounds with utility classes and components. You can easily apply striped patterns to your elements using the provided classes and customize their appearance according to your project's needs. The plugin offers control over colors, sizes, opacity, and animation direction, making it a powerful addition to your TailwindCSS toolkit.

#Contributing

Contributions to this plugin are welcome! If you encounter any issues, have feature requests, or want to improve the plugin, feel free to create a pull request or submit an issue on the GitHub repository.

#Contributors

#License

This project is licensed under the MIT License - see the LICENSE file for details.

#Acknowledgments

• This plugin is inspired by the needs of web developers using TailwindCSS.
• Special thanks to the TailwindCSS team for creating such an amazing framework.