https://github.com/n1kk/tailwindcss-spaced-items

TailwindCSS plugin to generate classes for setting fixed space between containers child elements.
https://github.com/n1kk/tailwindcss-spaced-items

Last synced: about 2 months ago
JSON representation

TailwindCSS plugin to generate classes for setting fixed space between containers child elements.

• Host: GitHub
• URL: https://github.com/n1kk/tailwindcss-spaced-items
• Owner: n1kk
• Created: 2018-11-03T14:29:47.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-03-16T23:00:53.000Z (over 4 years ago)
• Last Synced: 2024-06-30T21:56:29.834Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 15
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This plugin generates a set of css classes to add fixed margins to container children, except last one, to spread content in a consistent manner.

This can be useful when you want to spread items in the container with a set interval but don't want to add margins to every child manually and remove it from last child to make separation look proper. 

## Install

yarn

```bash

yarn add tailwindcss-spaced-items

```

npm

```bash

npm i tailwindcss-spaced-items

```

## API

#### `spacedItems({ values, children = ['*']} = {})`

- _`values`_: [optional] an object with values to generate classes, defaults to configs 'margin' object values. If config does not contain margin values you have to pass your own values for classes to be generated.

- _`children`_: [optional] array of selectors of which child tags should be affected, defaults to `['*']`

## Usage

In tailwind config

```javascript

const spacedItems = require('tailwindcss-spaced-items')

module.exports = {

  plugins: [

    spacedItems(),

  ],

}

```

This will produce css like this for each value in configs `margin` object:

```css

.spaced-x-1 > * { margin-right: .25rem; }

.spaced-x-1 > *:last-child { margin-right: 0; }

.spaced-y-1 > * { margin-bottom: .25rem; }

.spaced-y-1 > *:last-child { margin-bottom: 0; }

.spaced-xy-1 > * { margin-bottom: .25rem;

                   margin-right: .25rem; }

.spaced-xy-1 > *:last-child { margin-bottom: 0;

                              margin-right: 0; }

/* ... */

```

To override values:

```javascript

const spacedItems = require('tailwindcss-spaced-items')

module.exports = {

  plugins: [

    spacedItems({

      values: {

        '1': '1px',

        '5': '5px',

        '10': '10px',

        '20': '20px',

      },

    }),

  ],

}

```

This will produce:

```css

.spaced-x-1 > * { margin-right: 1px; }

.spaced-x-1 > *:last-child { margin-right: 0; }

/* ... */

```

To define a child tag:

```javascript

const spacedItems = require('tailwindcss-spaced-items')

module.exports = {

  plugins: [

    spacedItems({

      children: ['div', 'p'],

    }),

  ],

}

```

This will produce:

```css

.spaced-x-1 > div, 

.spaced-x-1 > p {

  margin-right: .25rem; 

}

.spaced-x-1 > div:last-child, 

.spaced-x-1 > p:last-child 

{ 

  margin-right: 0; 

}

/* ... */

```