npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

postcss-json-variables

v1.0.1

Published

A PostCSS plugin that allows you to inject values from a JSON file into your CSS using a custom `json()` function. This plugin enables you to dynamically manage CSS variables by referencing JSON data, making it easier to maintain consistency across your s

Downloads

133

Readme

postcss-json-variables

A PostCSS plugin that allows you to inject values from a JSON file into your CSS using a custom json() function. This plugin enables you to dynamically manage CSS variables by referencing JSON data, making it easier to maintain consistency across your stylesheets.

Installation

To install the plugin, use npm:

npm install postcss-json-variables --save-dev

Usage

You can use this plugin in your PostCSS configuration file. Here's an example of how to set it up:

postcss.config.js

module.exports = {
    plugins: [
        require('postcss-json-variables')({
            path: 'variables.json'
        }),
        // other PostCSS plugins
    ]
};

Example JSON File

Create a JSON file (e.g., variables.json) with your variables:

{
    "body": {
        "header": {
            "font-family": "Arial, sans-serif",
            "font-size": "16px"
        }
    }
}

Example CSS

You can now use the json() function in your CSS:

body {
    font-family: json(body[header][font-family]);
    font-size: json(body[header][font-size]);
}

API

Plugin Options

  • path (String): The path to your JSON file. If not specified, it defaults to ./variables.json.

Functions

getJsonValue(jsonObject, reference)

Safely evaluates a nested JSON reference (e.g., 'body[header][font-family]') to retrieve the corresponding value from the JSON object.

  • Parameters:
    • jsonObject (Object): The parsed JSON object containing variables.
    • reference (String): The direct string reference to the JSON value.
  • Returns: The value from the JSON object, or undefined if the reference is invalid.

Error Handling

If the plugin fails to load or parse the specified JSON file, it will throw an error with a descriptive message. Additionally, if a referenced variable does not exist in the JSON file, the plugin will log a warning and remove the corresponding CSS declaration.

Contributing

Contributions are welcome! Please submit issues and pull requests for any enhancements or bug fixes.