{"id":18040506,"url":"https://github.com/aboutbits/react-ui-integrations","last_synced_at":"2025-10-10T23:22:19.123Z","repository":{"id":38352752,"uuid":"475774539","full_name":"aboutbits/react-ui-integrations","owner":"aboutbits","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-11T05:48:53.000Z","size":356,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-02T06:53:24.089Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aboutbits.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-30T07:50:12.000Z","updated_at":"2025-09-11T05:48:56.000Z","dependencies_parsed_at":"2024-03-18T08:25:08.167Z","dependency_job_id":"2a8de632-e6d7-4262-b269-866d490c9fb0","html_url":"https://github.com/aboutbits/react-ui-integrations","commit_stats":{"total_commits":34,"total_committers":1,"mean_commits":34.0,"dds":0.0,"last_synced_commit":"59be7d99f13fe8ddd8ba240d4ced195279f960a7"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/aboutbits/react-ui-integrations","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutbits%2Freact-ui-integrations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutbits%2Freact-ui-integrations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutbits%2Freact-ui-integrations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutbits%2Freact-ui-integrations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aboutbits","download_url":"https://codeload.github.com/aboutbits/react-ui-integrations/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutbits%2Freact-ui-integrations/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005552,"owners_count":26083918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-30T15:06:18.559Z","updated_at":"2025-10-10T23:22:19.118Z","avatar_url":"https://github.com/aboutbits.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReactUI Integrations\n\n[![npm package](https://badge.fury.io/js/%40aboutbits%2Freact-ui-integrations.svg)](https://badge.fury.io/js/%40aboutbits%2Freact-ui-integrations)\n[![license](https://img.shields.io/github/license/aboutbits/react-ui-integrations)](https://github.com/aboutbits/react-ui-integrations/blob/main/license.md)\n\nThis is a collection of tools for various libraries to integrate [About Bit's ReactUI](https://github.com/aboutbits/react-ui) into a project.\n\n## Table of content\n\n- [Usage](#usage)\n- [Supported libraries](#supported-libraries)\n  - [Next.js](#nextjs)\n  - [Webpack](#webpack)\n- [Configuration](#configuration)\n- [Build \u0026 Publish](#build--publish)\n- [Information](#information)\n  - [Support](#support)\n  - [Credits](#credits)\n  - [License](#license)\n\n## Usage\n\n1. Install the package\n\n   ```bash\n   npm install -D @aboutbits/react-ui-integrations\n   ```\n\n2. Add a `reactui.config.js` to your project's directory\n\n   See [Configuration](#configuration) for available options.\n\n   ```js\n   module.exports = {\n     theme: {\n       override: [...],\n       merge: [...]\n     }\n   }\n   ```\n\n3. Pass the `REACTUI_THEME` to your `ReactUIProvider` instance:\n\n   ```jsx\n   import { ReactUIProvider, Theme } from '@aboutbits/react-ui'\n   import React from 'react'\n\n   declare const REACTUI_THEME: Theme\n\n   export const Layout: React.FC = ({ children }) =\u003e {\n     return \u003cReactUIProvider theme={REACTUI_THEME}\u003e{children}\u003c/ReactUIProvider\u003e\n   }\n   ```\n\n4. Configure the Tailwind CSS plugin\n\n   `tailwind.config.js`:\n\n   ```js\n   module.exports = {\n     plugins: [\n       // Basic configuration\n       require('@aboutbits/react-ui-integrations').useTailwindPlugin(),\n\n       // Configuration with custom config file\n       require('@aboutbits/react-ui-integrations').useTailwindPlugin({\n         configFile: resolve('./reactui_custom.config.js'),\n       }),\n     ],\n   }\n   ```\n\n   **Optional configuration options**\n\n   - `configFile`: Absolute path to an alternative configuration file\n\n5. Configure the respective library in your project\n\n   See [Supported libraries](#supported-libraries).\n\n## Supported libraries\n\n### Next.js\n\n`next.config.js`:\n\n```js\nconst { withReactUI } = require('@aboutbits/react-ui-integrations')\n\nlet nextConfig = {} // your NextJS config\n\n// Basic configuration\nnextConfig = withReactUI(nextConfig)\n\n// Configuration with custom theme variable and config file\nnextConfig = withReactUI(nextConfig, {\n  themeVariable: 'REACTUI_THEME_CUSTOM',\n  configFile: path.resolve('./reactui_custom.config.js'),\n})\n\nmodule.exports = nextConfig\n```\n\n**Optional configuration options**\n\n- `themeVariable`: Configure the variable name to which the ReactUI theme will be bound (by Webpack's DefinePlugin).\n- `configFile`: Absolute path to an alternative configuration file\n\n### Webpack\n\n`webpack.config.js`:\n\n```js\nconst { ReactUIWebpackPlugin } = require('@aboutbits/react-ui-integrations')\n\nmodule.exports = {\n  plugins: [\n    // Basic configuration\n    new ReactUIWebpackPlugin(),\n\n    // Configuration with custom theme variable and config file\n    new ReactUIWebpackPlugin({\n      themeVariable: 'REACTUI_THEME_CUSTOM',\n      configFile: path.resolve('./reactui_custom.config.js'),\n    }),\n  ],\n}\n```\n\n**Optional configuration options**\n\n- `themeVariable`: Configure the variable name to which the ReactUI theme will be bound (by Webpack's DefinePlugin).\n- `configFile`: Absolute path to an alternative configuration file\n\n### Jest\n\n`webpack.config.js`:\n\n```js\nconst { getTheme } = require('@aboutbits/react-ui-integrations')\n\nmodule.exports = {\n  globals: {\n    REACTUI_THEME: getTheme(),\n  },\n}\n```\n\n**Optional configuration options**\n\n- `configFile`: Absolute path to an alternative configuration file\n\n## Configuration\n\nThese configuration options are available to be set in the `reactui.config.js`:\n\n- `theme.override` / `theme.merge`\n\n  Extend ReactUI theme configuration. Starting with version 1.0 you have the option to override or merge the ReacUI's default theme configuration.\n\n## Build \u0026 Publish\n\nTo build and publish the package, visit the GitHub Actions page of the repository.\n\nYou can choose between two workflows:\n- `Release Package` to publish a new version of the package.\n- `Pre-Release Package` to publish a new pre-release version of the package.\n\n**Note:** Pre-releases need to be supplied with a pre-id.\n\n**Note:** To increment a pre-release, you have to run the normal release workflow and select \"prerelease\". For this action you need to already be on a pre-release version.\n\n## Information\n\nAbout Bits is a company based in South Tyrol, Italy. You can find more information about us\non [our website](https://aboutbits.it).\n\n### Support\n\nFor support, please contact [info@aboutbits.it](mailto:info@aboutbits.it).\n\n### Credits\n\n- [All Contributors](../../contributors)\n\n### License\n\nThe MIT License (MIT). Please see the [license file](license.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutbits%2Freact-ui-integrations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faboutbits%2Freact-ui-integrations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutbits%2Freact-ui-integrations/lists"}