Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/AndersNielsen85/tailwindcss-bg-svg

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/AndersNielsen85/tailwindcss-bg-svg
Owner: AndersNielsen85
Created: 2019-03-15T12:04:57.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-04-01T08:08:05.000Z (about 2 years ago)
Last Synced: 2024-01-22T04:40:56.386Z (5 months ago)
Language: JavaScript
Size: 7.81 KB
Stars: 20
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Lists

awesome-tailwindcss - Background SVG - Inject SVGs as background images with color variants. (Plugins)
awesome-tailwindcss - Background SVG - Inject SVGs as background images with color variants. (Plugins)

README

# Background svg Tailwind Plugin

## V2 breaking change
The configuration has been moved from plugin to utility.
This should allow for on-the-fly adding icons with HMR.

If you are coming from pre v2 you will need to move your configuration.

[Looking for the the V1 documentation?](https://github.com/AndersNielsen85/tailwindcss-bg-svg/tree/v1)

## Installation

Add this plugin to your project:

```bash
# Install via npm
npm install --save-dev tailwindcss-bg-svg

# or yarn
yarn add tailwindcss-bg-svg --dev
```

## Usage

The Background svg plugin exposes options for you to use. The plugin will use your existing tailwind colors.
It works by replacing "svgcolor" with the color code and base64 encoding the svg.
Remember to set your fill/stroke to svgcolor

Example code for using the plugin.

```js
let colors = {
'black': '#22292f',
'grey': {
'100': '#3d4852',
},
}

module.exports = {
theme: {
bgSvg: {
'arrow': '',
}
// ...
},
plugins: [
require('tailwindcss-bg-svg'),
// ...
],
}
```

This configuration would create the following classes:

```css
.bg-svg-arrow-black{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24.99 25'%3E%3Cpath d='M24.65 21.61l-4.87-4.87a1.16 1.16 0 0 0-.78-.34h-.8a10.14 10.14 0 1 0-1.75 1.75V19a1.16 1.16 0 0 0 .34.83l4.87 4.87a1.17 1.17 0 0 0 1.65 0l1.38-1.38a1.16 1.16 0 0 0-.04-1.71zm-14.5-5.22a6.25 6.25 0 1 1 6.25-6.25 6.24 6.24 0 0 1-6.25 6.25z' fill='%2322292f'/%3E%3C/svg%3E")}
.bg-svg-arrow-grey-100{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24.99 25'%3E%3Cpath d='M24.65 21.61l-4.87-4.87a1.16 1.16 0 0 0-.78-.34h-.8a10.14 10.14 0 1 0-1.75 1.75V19a1.16 1.16 0 0 0 .34.83l4.87 4.87a1.17 1.17 0 0 0 1.65 0l1.38-1.38a1.16 1.16 0 0 0-.04-1.71zm-14.5-5.22a6.25 6.25 0 1 1 6.25-6.25 6.24 6.24 0 0 1-6.25 6.25z' fill='%233d4852'/%3E%3C/svg%3E")}
```