npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@designbycode/tailwindcss-text-stroke

v1.2.1

Published

Tailwindcss utilities for text stroke

Downloads

2,230

Readme

Tailwind CSS Text Stroke Plugin

npm version npm NPM npm bundle size ts GitHub stars HitCount

NPM

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

📇 Table of Contents

Installation

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

Using pnpm

pnpm add @designbycode/tailwindcss-text-stroke

Using npm

npm install @designbycode/tailwindcss-text-stroke

Using yarn

yarn add @designbycode/tailwindcss-text-stroke

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

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

Setup

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

  2. Next, require the plugin in your Tailwind CSS 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 Tailwind CSS color palette.
  • .text-stroke-fill-{color}: Applies a custom fill color to the text stroke. The {color} should match a color in your Tailwind CSS 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

Use modifiers to change text width and color. Use predefined setting this, medium, thick or arbitrary values.

<h1 class="text-stroke text-stroke-indigo-200 text-stroke-fill-indigo-600">
    Hello, TailwindCSS
</h1>
<!-- default -->
<h1 class="text-stroke"></h1>
<!-- thin, medium, and thick -->
<h1 class="text-stroke-{value}"></h1>
<!-- 1, 2, or 3  -->
<h1 class="text-stroke-[number]"></h1>
<!-- [2px]  -->
<h1 class="text-stroke-[value]"></h1>

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.

License

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

Author

Acknowledgments

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