Haroenv / brix-ui

☄️ The library of reusable UI components for React, made in minimalistic and light style, adopting modern technologies and approaches.

Home Page:https://ustudioteam.github.io/brix-ui/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Brix UI

lerna style: styled-components

Minimal UI framework for React built with TypeScript and styled-components.


Brix UI is shipping several packages:

Some of these are not intended to be used directly but are required for the others to work. Most common use-case for Brix UI would be installing the core package which provides full-on experience of the framework.

Installation

npm i @brix-ui/core # styled-components react react-dom
yarn add @brix-ui/core # styled-components react react-dom

Make sure to have react, react-dom and styled-components installed in your package as they are included in our peer dependencies.

Usage

Before writing any components in your application make sure to provide them with our theme. This is done by wrapping your application in our ThemeProvider component.

import ThemeProvider from '@brix-ui/theme';

ReactDOM.render(
  document.querySelector('#root'),
  <ThemeProvider>
    <App />
  </ThemeProvider>
);

More examples can be found in the theme package readme.

After that, you are ready to use our framework inside of your application!

// Please note that in most cases we provide direct default exports for better tree-shaking support.
import Button from '@brix-ui/core/button';

Live demo can be found here (GitHub).

Contributing

We are open for your suggestions and contributions to this project. In order to properly help us get better please refer to the contributing and code of conduct documents.

History

This package continues the story of ustudio-ui – our first attempt at creating a UI library for React. ustudio-ui generally met our requirements yet leaving much room for improvement. Here we made an attemt to completely rewrite the first version of our library, redesigning components and rethinking all the code and architecture in the process.

Brix UI was made in the country of Ukraine by these lovely members and ex-members of the uStudio company:

About

☄️ The library of reusable UI components for React, made in minimalistic and light style, adopting modern technologies and approaches.

https://ustudioteam.github.io/brix-ui/

License:MIT License


Languages

Language:TypeScript 95.5%Language:JavaScript 4.5%