@designbycode/tailwindcss-text-shadow
v2.2.1TypeScript
Tailwindcss utilities for text stroke
front-endfrontendcsstailwindcssplugintailwindcss-plugintailwindcss text-shadowtext-shadowdesignbycode
0/weekUpdated 1 years agoMITUnpacked: 22.8 KB
Published by designbycode_
npm install @designbycode/tailwindcss-text-shadow
Tailwind CSS Text Shadow Plugin
!npm
!NPM
!npm bundle size
!ts
The Tailwind CSS Text Shadow Plugin extends the default set of utility classes in Tailwind CSS to provide easy text shadow customization for your web projects. With this plugin, you can apply custom text shadows using utility
classes or define your own text shadow variations based on predefined steps and color palettes.
!TextShadow Plugin
📇 Table of Contents
- Installation
- Using pnpm
- Using npm
- Using yarn
- Setup
- Default configuration styles
- Use
- Video Tutorial
- Apply Text Shadows
- Text shadow blur modifier
- Text shadow x and y modifiers
- Text shadow color modifier
- Text shadow color opacity
- Long shadow
- Customization
- Example
- Contributing
- License
- Author
- Acknowledgments
Installation
To use this plugin, you need to have Tailwind CSS installed in your project. If you haven't installed Tailwind CSS yet, follow these steps:
#### Using pnpm
``
bash
pnpm add @designbycode/tailwindcss-text-shadow
`
#### Using npm
`bash
npm install @designbycode/tailwindcss-text-shadow
`
#### Using yarn
`bash
yarn add @designbycode/tailwindcss-text-shadow
`
$3
1. Add the Plugin to your Tailwind CSS Config
In your tailwind.config.js file, add the plugin to the plugins array:
`javascript
module.exports = {
// ...other configurations
plugins: [
// ...other plugins
require("@designbycode/tailwindcss-text-shadow"),
],
}
`
$3
2. If the default styles do not suit your preferences, you can effortlessly customize them using the following configuration options
`javascript
module.exports = {
// ...other configurations
require("@designbycode/tailwindcss-text-shadow"
)
({
shadowColor: "rgba(0, 0, 0, 0.5)",
shadowBlur: "3px",
shadowOffsetX: "2px",
shadowOffsetY: "2px",
})
`
Use
$3
See plugin in action in video below. 👇
$3
Once the plugin is added to your Tailwind CSS configuration, you can use the provided utility classes to apply text shadows to your HTML elements.
`html
Hello, Tailwind CSS!
`
$3
To make the spread or blur bigger add the .text-shadow-blur-{value}
`html
Hello, Tailwind CSS!
`
$3
The shadow can be moved on the xy axis using .text-shadow-x-{value} and .text-shadow-y-{value}
`html
Hello, Tailwind CSS!
`
$3
`html
Hello, Tailwind CSS!
`
In the example above, the element will have a red text shadow with an x offset of 3px, a y offset of 4px, and a blur radius of 2px. The text-shadow class enables the text shadow styles, while the text-shadow-x-md,
text-shadow-y-lg, and
text-shadow-blur-2 classes customize the horizontal offset, vertical offset, and blur radius, respectively.
$3
To change the opacity of the text-shadow-color use the following method
`html
Hello, Tailwind CSS!
Hello, Tailwind CSS!
Hello, Tailwind CSS!
`
> Warning
> New experimental long shadow feature
`javascript
module.exports = {
// ...other configurations
require("@designbycode/tailwindcss-text-shadow"
)
({
experimental: true, // 👈
})
`
> Note the latest version doesn't need experimental anymore
$3
The long shadow is a new experimental feature that I add. It creates shadow that stacks to any amount. The classes is .text-shadow-sm or .text-shadow-[steps]
`html
Hello, Tailwind CSS!
Hello, Tailwind CSS!
`
Customization
You can customize the available text shadow options by modifying the theme.textShadowSteps property in your tailwind.config.js file. The steps defined in this object will be used to generate utility classes for each aspect of the text
shadow.
$3
`javascript
// tailwind.config.js
module.exports = {
theme: {
prefix: 'text-shadow',
textShadowSteps: {
sm: "1px",
md: "2px",
lg: "3px",
xl: "4px",
0: "0",
1: "1px",
2: "2px",
3: "3px",
4: "4px",
},
},
}
`
In this example, we have customized the textShadowSteps object with only four steps for sm, md, lg, and xl, and removed the rest. The plugin will generate utility classes accordingly.
$3
If you don't like to use class name .text-shadow or are getting conflicts in application you can change it to whatever you want like .textShadow, ts or whatever you want. Change it in theme settings.
`typescript
// tailwind.config.js
module.exports = {
theme: {
prefix: 'ts',
},
}
`
$3
`html
``
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.
$3
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
Claude Myburgh
- Github: @designbycode
- Npm: @designbycode_
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.
text-shadow-y-lg, and
text-shadow-blur-2 classes customize the horizontal offset, vertical offset, and blur radius, respectively.
$3
To change the opacity of the text-shadow-color use the following method
Hello, Tailwind CSS!
Hello, Tailwind CSS!
Hello, Tailwind CSS!
> Warning
> New experimental long shadow feature
module.exports = {
// ...other configurations
require("@designbycode/tailwindcss-text-shadow"
)
({
experimental: true, // 👈
})
> Note the latest version doesn't need experimental anymore
$3
The long shadow is a new experimental feature that I add. It creates shadow that stacks to any amount. The classes is
Hello, Tailwind CSS!
Hello, Tailwind CSS!
Customization
You can customize the available text shadow options by modifying the theme.textShadowSteps property in your tailwind.config.js file. The steps defined in this object will be used to generate utility classes for each aspect of the text
shadow.
$3
// tailwind.config.js
module.exports = {
theme: {
prefix: 'text-shadow',
textShadowSteps: {
sm: "1px",
md: "2px",
lg: "3px",
xl: "4px",
0: "0",
1: "1px",
2: "2px",
3: "3px",
4: "4px",
},
},
}
In this example, we have customized the textShadowSteps object with only four steps for sm, md, lg, and xl, and removed the rest. The plugin will generate utility classes accordingly.
$3
If you don't like to use class name
// tailwind.config.js
module.exports = {
theme: {
prefix: 'ts',
},
}
$3