https://github.com/dd3tech/bui

BUI: Tailwind based React component library to build back-office platforms :rocket:
https://github.com/dd3tech/bui

components design-system javascript library nextjs nextjs-tailwind production-code react react-components react-ui-components tailwindcss typescipt typescript ui-components uikit

Last synced: 8 days ago
JSON representation

BUI: Tailwind based React component library to build back-office platforms :rocket:

• Host: GitHub
• URL: https://github.com/dd3tech/bui
• Owner: dd3tech
• License: mit
• Created: 2023-03-14T18:49:57.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T22:44:17.000Z (3 months ago)
• Last Synced: 2024-10-29T22:49:00.844Z (3 months ago)
• Topics: components, design-system, javascript, library, nextjs, nextjs-tailwind, production-code, react, react-components, react-ui-components, tailwindcss, typescipt, typescript, ui-components, uikit
• Language: TypeScript
• Homepage: https://bui.dd360.mx
• Size: 58 MB
• Stars: 23
• Watchers: 1
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        










A React ecosystem library for building back-office platforms like [DD360](https://dd360.mx/). 


It's library created by developers for developers 




**[Stable v6](https://bui.dd360.mx/)**

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/dd3tech/bui)

[![npm latest package](https://img.shields.io/npm/v/dd360-ds/latest.svg)](https://www.npmjs.com/package/dd360-ds)

[![npm downloads](https://img.shields.io/npm/dm/dd360-ds)](https://www.npmjs.com/package/dd360-ds)

[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/dd3tech/bui.svg)](https://isitmaintained.com/project/dd3tech/bui 'Average time to resolve an issue')

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/7584/badge)](https://bestpractices.coreinfrastructure.org/projects/7584)

[![Storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg)](https://main--62ffec7466615c40c8dbe435.chromatic.com)



  





  Docs •

  Website





## 📲 Installation

```bash

npm install dd360-ds

```

or

```bash

yarn add dd360-ds

```

## 💅 Customize theme

If you want to use a provider to configure the library's theme, you can do so using the ThemeProvider provided by dd360-ds. This will allow you to set your own settings for the theme.

To use the ThemeProvider, you must import it as follows:

```tsx

import { createTheme, ThemeProvider } from "dd360-ds/theme";

```

You can then create your own theme configuration using the createTheme function, which accepts an object with different properties to customize the theme. For example, you can define the primary and secondary colors as shown below:

```tsx

const theme = createTheme({

  palette: {

    primary: {

      main: "purple"

    },

    secondary: {

      main: "#FFC107"

    }

  }

});

```

After creating your theme configuration, you can use the ThemeProvider to wrap your React app. This can be done as follows:

```tsx

ReactDOM.createRoot(document.getElementById("root")).render(

  

    

      

    

  

);

```

Within the ThemeProvider, you can use the components provided by dd360-ds and the corresponding styles will be applied based on your theme settings.

Remember that to use the ThemeProvider, you must import both the createTheme component and the ThemeProvider component from dd360-ds/theme.

## 💡 Usage

After Installation, you will have to make some extra configurations for everything to work normally.

Import stylesheets into the `App.js` or `App.tsx`

```js

import 'dd360-ds/dd360.css'

```

⚠️ ***Warning: If you want to combine it with other styles, be sure to import our css as the last one.***

How to import components?

```jsx

import { Button } from 'dd360-ds'

```

## 🔫 Components

This is the most fun part. Below we will explain the use of the components we are currently developing.

You can checking and contribute to the docs website [here](https://github.com/dd3tech/bui-docs)