Nosy Pinocchio Manners

    openmined-ui

    0.0.6 • Public • Published

    OpenMined UI

    styled with prettier Chat on Slack npm

    Because data science should look good.

    Check it out!

    Welcome to the OpenMined UI library! The purpose of this is to give UI developers one design language in the creation of OpenMined applications. In the same way that our code repositories should constantly be improving, it should also be assumed that this file is a working document that will change and improve over time. Below are a list of guidelines for how various user interface elements should be used throughout the visual design of the OpenMined ecosystem. We encourage you to use them at will and suggest new ones in the #team_uiux channel in Slack. Please note that it is imperative that you always consult the OpenMined brand manual first as it is the ultimate source of truth for remaining true to the brand.

    Setup

    Prerequisites

    node >= 8
    

    Installation

    yarn add openmined-ui

    Usage

    import React, {Component} from 'react'
    import {Button} from 'openmined-ui'
     
    export default class App extends Component {
      render () {
        return <Button>Click Here!</Button>
      }
    }

    Components

    • <Async />
    • <BackgroundGradient />
    • <Button />
    • Grid
      • <Column />
      • <Container />
      • <Row />
    • <Heading />
    • <Input />
    • <Page />
    • <Progress />
    • <Switch />

    Development

    yarn
    yarn build:storybook
    yarn storybook

    From there, storybook should hot reload at localhost:9000 with any change. You may need to restart when adding new files.

    License

    Apache-2.0 by OpenMined contributors

    Keywords

    none

    Install

    npm i openmined-ui

    DownloadsWeekly Downloads

    24

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    471 kB

    Total Files

    48

    Last publish

    Collaborators

    • cereallarceny
    • kevinahuber