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

@aboutbits/react-ui-integrations

v1.2.0

Published

Webpack and Tailwind integration for ReactUI

Downloads

126

Readme

ReactUI Integrations

npm package license

This is a collection of tools for various libraries to integrate About Bit's ReactUI into a project.

Table of content

Usage

  1. Install the package

    npm install -D @aboutbits/react-ui-integrations
  2. Add a reactui.config.js to your project's directory

    See Configuration for available options.

    module.exports = {
      theme: {
        override: [...],
        merge: [...]
      }
    }
  3. Pass the REACTUI_THEME to your ReactUIProvider instance:

    import { ReactUIProvider, Theme } from '@aboutbits/react-ui'
    import React from 'react'
    
    declare const REACTUI_THEME: Theme
    
    export const Layout: React.FC = ({ children }) => {
      return <ReactUIProvider theme={REACTUI_THEME}>{children}</ReactUIProvider>
    }
  4. Configure the Tailwind CSS plugin

    tailwind.config.js:

    module.exports = {
      plugins: [
        // Basic configuration
        require('@aboutbits/react-ui-integrations').useTailwindPlugin(),
    
        // Configuration with custom config file
        require('@aboutbits/react-ui-integrations').useTailwindPlugin({
          configFile: resolve('./reactui_custom.config.js'),
        }),
      ],
    }

    Optional configuration options

    • configFile: Absolute path to an alternative configuration file
  5. Configure the respective library in your project

    See Supported libraries.

Supported libraries

Next.js

next.config.js:

const { withReactUI } = require('@aboutbits/react-ui-integrations')

let nextConfig = {} // your NextJS config

// Basic configuration
nextConfig = withReactUI(nextConfig)

// Configuration with custom theme variable and config file
nextConfig = withReactUI(nextConfig, {
  themeVariable: 'REACTUI_THEME_CUSTOM',
  configFile: path.resolve('./reactui_custom.config.js'),
})

module.exports = nextConfig

Optional configuration options

  • themeVariable: Configure the variable name to which the ReactUI theme will be bound (by Webpack's DefinePlugin).
  • configFile: Absolute path to an alternative configuration file

Webpack

webpack.config.js:

const { ReactUIWebpackPlugin } = require('@aboutbits/react-ui-integrations')

module.exports = {
  plugins: [
    // Basic configuration
    new ReactUIWebpackPlugin(),

    // Configuration with custom theme variable and config file
    new ReactUIWebpackPlugin({
      themeVariable: 'REACTUI_THEME_CUSTOM',
      configFile: path.resolve('./reactui_custom.config.js'),
    }),
  ],
}

Optional configuration options

  • themeVariable: Configure the variable name to which the ReactUI theme will be bound (by Webpack's DefinePlugin).
  • configFile: Absolute path to an alternative configuration file

Jest

webpack.config.js:

const { getTheme } = require('@aboutbits/react-ui-integrations')

module.exports = {
  globals: {
    REACTUI_THEME: getTheme(),
  },
}

Optional configuration options

  • configFile: Absolute path to an alternative configuration file

Configuration

These configuration options are available to be set in the reactui.config.js:

  • theme.override / theme.merge

    Extend ReactUI theme configuration. Starting with version 1.0 you have the option to override or merge the ReacUI's default theme configuration.

Build & Publish

To publish the package commit all changes and push them to main. Then run one of the following commands locally:

npm version patch
npm version minor
npm version major

Information

About Bits is a company based in South Tyrol, Italy. You can find more information about us on our website.

Support

For support, please contact [email protected].

Credits

License

The MIT License (MIT). Please see the license file for more information.