About The Project

All heropatterns.com patterns as TailwindCSS classes.

Built With

Getting Started

Installation

1. Install NPM package:

   npm install @lorenzopalaia/tailwind-hero-patterns

2. Add the plugin to your tailwind.config.js file:

   plugins: [
    require('@lorenzopalaia/tailwind-hero-patterns'),
    ...
   ]

Usage

Pattern

Follow the schema pattern-{name}-{color}/{opacity}, where:

• name is the pattern name
• color refers to any possible color of Tailwind's palette
• opacity controls pattern's opacity from 0 to 100%

For example:

   <div class="pattern-jigsaw-red-500/50">
    ...
   </div>

Scale

To scale the pattern follow the schema pattern-{name}-scale-{percent}, where:

• percent follows the same rules as Tailwind's scaling options

For example:

   <div class="pattern-jigsaw-scale-50">
    ...
   </div>

If you prefer to use a custom scaling multiplier then follow the schema pattern-{name}-scale-[multiplier].

For example:

   <div class="pattern-jigsaw-scale-[1.5]">
    ...
   </div>

Full Example

The following example will generate a red jigsaw pattern with 50% opacity and scaled by 1.5 multiplier on a blue background:

   <div class="bg-blue-400 pattern-jigsaw-red-500/50 pattern-jigsaw-scale-[1.5]">
    ...
   </div>

For more examples, please refer to the Documentation

Patterns

Here's the full list of available patterns. Check Hero Patterns to choose your favourite pattern.

jigsaw, ripples, topography, texture, hub, architect, voxel, crosses, graph, squares, falling-triangles, pies, hexagons, zig-zag-2, autumn, temple, death-star, overlapping-hexagons, stars, bamboo, floor, cork-screw, kiwi, lips, checkered, x-equals, bevel-circle, brick-wall, fancy-rectangles, heavy-rain, overlapping-circles, plus, plus-connected, volcano-lamp, wiggle, bubbles, cage, connections, current, diagonal-stripes, flipped-diamonds, houndstooth, leaf, lines-in-motion, moroccan, morphing-diamonds, rails, rain, squares-in-squares, stripes, tic-tac-toe, zig-zag, aztec, bank-note, boxes, circles-and-squares, circuit-board, curtain, clouds, eyes, tiles, groovy, intersecting-circles, melt, overlapping-diamonds, wood, pixel, polka, signal, slanted, lines-diagonal-right, lines-diagonal-left, lines-horizontal, lines-vertical, sprinkles, waves, hive, squiggles, triangles, grid, zebra, overcast, piano-man, dominoes, stamp-collection, church-on-sunday, i-like-food, lisbon, random-shapes, steel-beams, anchors-away, floating-cogs, glamorous, skulls, wallpaper, yyy, happy-intersection

Roadmap

• [ ] Replace current scaling class with pattern-scale-{percent} / pattern-scale-[multiplier]

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Lorenzo Palaia - [email protected]

Project Link: https://github.com/lorenzopalaia/tailwind-hero-patterns