steffo/bluelib
steffo/bluelib
1
Fork 0
mirror of https://github.com/Steffo99/bluelib.git synced 2024-12-22 11:34:21 +00:00
Code Activity
Customizable, flexible and modular CSS library https://bluelib.gh.steffo.eu/
138 commits 8 branches 18 tags 35 MiB
Less 97.6%
Shell 2%
HTML 0.4%
Find a file
dependabot[bot] 8a63dabd26 Bump url-parse from 1.5.4 to 1.5.7 
Bumps [url-parse](https://github.com/unshiftio/url-parse) from 1.5.4 to 1.5.7.
- [Release notes](https://github.com/unshiftio/url-parse/releases)
- [Commits](https://github.com/unshiftio/url-parse/compare/1.5.4...1.5.7)

---
updated-dependencies:
- dependency-name: url-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-19 18:28:36 +01:00
.idea ✨ BREAKING: Add useValidatedState hook 2021-09-14 22:58:49 +02:00
.storybook ✨ Add builtinColor prop, allowing to choose a builtin color without using bluelibClassNames 2021-10-10 18:23:16 +02:00
public ✨ Initialize project 2021-08-14 17:02:47 +02:00
src Add typing for useBluelibInBody 2022-02-09 13:53:42 +01:00
.gitignore Ignore /out* 2022-02-09 13:53:26 +01: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 v4.5.1 2022-02-09 13:53:52 +01: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 Bump url-parse from 1.5.4 to 1.5.7 2022-02-19 18:28:36 +01:00

README.md

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>
)