Giter Club home page Giter Club logo

react-components's Introduction

=nil; Foundation user interface kit


UI components library to build React applications using =nil; pre-designed styles out of the box.

Build Npm version License: MIT Minified size

Table of contents

Getting started

npm

npm install @nilfoundation/ui-kit baseui styletron-engine-atomic styletron-react

yarn

yarn add @nilfoundation/ui-kit baseui styletron-engine-atomic styletron-react

CDN

<script src="https://unpkg.com/@nilfoundation/ui-kit/dist/ui-kit.iife.js"></script>

Notice, that global React variable should be accessible, because it is not included in the standalone bundle.

Usage

import { BaseProvider } from "baseui";
import { Client as Styletron } from "styletron-engine-atomic";
import { Provider as StyletronProvider } from "styletron-react";
import { createTheme, Button } from "@nilfoundation/ui-kit";

const engine = new Styletron();
const { theme } = createTheme(engine);

function App() {
  return (
    <StyletronProvider value={engine}>
      <BaseProvider theme={theme}>
        <Button>Button Label</Button>
      </BaseProvider>
    </StyletronProvider>
  );
}

SSR

Use this workaround to make Styletron, which this package is levelraging, work with SSR.

License

MIT

react-components's People

Contributors

ukorvl avatar gagrigoryan avatar dependabot[bot] avatar klond90 avatar chipi007 avatar

Stargazers

Tuan Duc Tran avatar  avatar Oleg Solomko avatar Haresh Gedia avatar

Watchers

 avatar James Cloos avatar Drankov Sergey avatar Konstantin Nazarov avatar Stepan Kolesnikov avatar  avatar

Forkers

gagrigoryan

react-components's Issues

[M] Components specification

Required components:
Required ASAP components are in the top, in the bottom - the most unnecessary

We are using BaseWeb as a base framework

Pipeline:

  1. Create design for the component/leave it as is with BaseWeb default styles. If styles does not change - jump to 7.
  2. Introduce design to =nil; team
  3. Create react component and styles
  4. Create pull request into master from a separate branch and link it to this issue. The branch name should start with 25-
  5. Test component and get PR approval
  6. Merge pull request
  7. Mark component as done in this issue

Constraints

  1. Components should be provided as tweak component that wraps baseweb components with new default but still support all properties and overrides. That means that we don't want to add additional functionally we just want style it and have a compatibility with future upgrades of baseweb.
  2. It should be written in Typescript.
  3. Every component that will be styled should have the same name as in baseweb and should be drop-in replacement.

Lose docs of elements

image With moving behaviour into component (it shouldn't be imported also) we lose a usability of docs. A lot of examples don't make any sense

Custom error page

Create reusable error 404 page content component, using updated website error page as example.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.