Git Product home page Git Product logo

stage-laravel-tailwind-config's Introduction

Laravel Tailwind Config

This is a fork form approvedio/laravel-mix-export-tailwind-config to use with Roots Sage > 10 & Stage. The original author Michael Boffey described it like this:

"I've recently found myself using Tailwind more and more but have run into a few situations where I need to access tailwind config values within my blade templates. The most recent event occurred when building a admin section and i needed to access a color defined within the tailwind config file to pass to a charting library. Instead of hardcoding the value I decided to create this library."

Installation

composer require ouun/stage-laravel-tailwind-config

Publish Config

$  wp acorn vendor:publish --provider="Stage\Tailwind\TailwindServiceProvider"

The application service provider and facade will be automatically registered for you.

Or add the service provider to your app.php config file

Stage\Tailwind\TailwindServiceProvider::class,

Optionally you can add the alias to the Aliases section of your app.php config file

'Tailwind' => Stage\Tailwind\Facades\Tailwind::class,

Usage

You can use the facade

Tailwind::get('colors.red-light', '#FF0000');

You can use the helper method

tailwind('colors.red-light', '#FF0000');

Config

By default we assume your tailwind config file is called tailwind.json in the `/dist folder of your project. you can override this configuration by publishing the config and updating the path to your tailwind.json file.

'cache_path' => base_path('dist/tailwind.json'),

To generate the tailwind.json file from your config you will either need to use a Webpack export package such as this one or add the following Mix extension to your webpack.mix.js:

mix.extend('exportTailwindConfig', function(webpackConfig, configPath = './tailwind.js') {
    let fs = require('fs');
    let config = require(configPath);
    let json = JSON.stringify(config, null, 2);

    fs.writeFile('./tailwind.json', json);
});

And then call the following mix function to generate this file

mix.exportTailwindConfig('./tailwind.js');

stage-laravel-tailwind-config's People

Contributors

ouun avatar boffey avatar oxyc avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.