1
Fork 0
mirror of https://github.com/Steffo99/bluelib.git synced 2024-12-22 11:34:21 +00:00
Customizable, flexible and modular CSS library https://bluelib.gh.steffo.eu/
Find a file
2021-09-14 23:07:19 +02:00
.idea BREAKING: Add useValidatedState hook 2021-09-14 22:58:49 +02:00
.storybook 🔧 Theme Storybook for bluelib-react 2021-08-24 13:06:28 +02:00
public Initialize project 2021-08-14 17:02:47 +02:00
src 🐛 Fix module exports 2021-09-14 23:03:49 +02:00
.gitignore 🔨 Use directly webpack instead of create-react-app (#2) 2021-08-26 04:23:34 +02:00
.gitmodules Create the base of the library 2021-08-16 19:10:23 +02:00
bluelib-react.iml Add layouts 2021-08-17 17:45:29 +02:00
LICENSE.txt 🗒 Write a small README 2021-08-24 13:35:12 +02:00
package.json v3.2.1 2021-09-14 23:07:19 +02:00
README.md 🗒 Add a README.md 2021-08-28 12:49:01 +02:00
rollup.config.js 📦 Configure typescript to output declarations 2021-08-28 11:38:59 +02:00
tsconfig.json 📦 Configure typescript to output declarations 2021-08-28 11:38:59 +02:00
yarn.lock 🔨 Configure rollup 2021-08-28 06:02:18 +02:00

bluelib-react

React bindings for bluelib@3

Documentation

An interactive documentation for bluelib-react is available here, built using Storybook.

Installation

You can download bluelib-react using your favourite node package manager:

$ npm install --save @steffo/bluelib-react
$ yarn add @steffo/bluelib-react

Ensure you have react and react-dom installed, as they are peer dependencies of this package and aren't installed automatically.

Usage

You can import the components you want to use using the ES6 import syntax:

import { Box } from "@steffo/bluelib-react"

All Bluelib components must be inside a <Bluelib> container for them to work correctly!

import { Bluelib, Heading, Box } from "@steffo/bluelib-react"


const MyComponent = props => (
    <Bluelib theme={"royalblue"}>
        <Heading level={1}>
            Hello world!
        </Heading>
        <Box>
            Welcome to Bluelib!
        </Box>
    </Bluelib>
)