Skip to content
This repository was archived by the owner on Dec 15, 2024. It is now read-only.

benface/tailwindcss-triangles

Repository files navigation

Be aware. Be angry. Do better. Demand change. Show your support any way you can. Click on the link above to find protests, petitions, and other ways to help. DO NOT LET IT GO SILENT.

Triangles Plugin for Tailwind CSS

Requirements

This plugin requires Tailwind CSS 1.5 or later. If your project uses an older version of Tailwind, you should install the latest 2.x version of this plugin (npm install tailwindcss-triangles@2.x).

Installation

npm install tailwindcss-triangles

Usage

// tailwind.config.js
module.exports = {
  theme: {
    triangles: { // defaults to {}
      'left': {
        direction: 'left',      // one of 'left', 'right', 'up', 'down', 'left-up', 'left-down', 'right-up', and 'right-down'
        size: '1em',            // defaults to defaultSize
        height: '0.5em',        // defaults to half the size; has no effect on the diagonal directions (e.g. 'left-up')
        color: 'currentColor',  // defaults to defaultColor
      },
    },
  },
  variants: {
    triangles: ['responsive'], // defaults to []
  },
  plugins: [
    require('tailwindcss-triangles')({
      componentPrefix: 'c-',        // defaults to 'c-'
      defaultSize: '1em',           // defaults to '1em'
      defaultColor: 'currentColor', // defaults to 'currentColor'
    }),
  ],
};

The above configuration would generate the following CSS:

.c-triangle-left {
  width: 0;
  height: 0;
  border: 0;
  border-right: .5em solid currentColor;
  border-top: .5em solid transparent;
  border-bottom: .5em solid transparent;
}

@media (min-width: 640px) {
  .sm\\:c-triangle-left {
    width: 0;
    height: 0;
    border: 0;
    border-right: .5em solid currentColor;
    border-top: .5em solid transparent;
    border-bottom: .5em solid transparent;
  }
}

About

Tailwind CSS plugin to generate custom triangle components

Resources

License

Stars

Watchers

Forks

Packages

No packages published