Giter VIP home page Giter VIP logo

turtle-ui's Introduction

turtle-ui

A small collection of react components with styles.

NPM JavaScript Style Guide

Install

npm install --save turtle-ui

Usage

Button

import {Button}  from 'turtle-ui'

class Example extends Component {
  render () {
    return (
      <div>
        <Button>Neutral</Button>
        <Button classes="brand">Brand</Button>
        <Button classes="accent">Accent</Button>

        <Button classes="plain">Neutral</Button>
        <Button classes="brand plain">Brand</Button>
        <Button classes="accent plain">Accent</Button>

        <Button classes="text plain">Neutral</Button>
        <Button classes="brand text plain">Brand</Button>
        <Button classes="accent text plain">Accent</Button>
      </div>
    )
  }
}

See ./example/app/ for more usage samples.

Run Demo Site

This project was bootstrapped with create-react-library so...

Local development is broken into two parts.

First, you'll run rollup to watch your src/ module and automatically recompile it into dist/ whenever you make changes.

npm start # runs rollup with watch flag 

The second part will be running the example/ create-react-app that's linked to the local version of your module.

# (in another tab) 
cd example
npm link <your-module-name> # optional if using yarn 
npm start # runs create-react-app dev server 

Now, anytime you make a change to your component in src/ or to the example app's example/src, create-react-app will live-reload your local dev server so you can iterate on your component in real-time.

Components

  • Buttons
  • Dropdowns
  • Forms
  • Cards
  • Tables
  • Modals
  • Navs

TODO

  • Put the "styles" in place that's accessible, these would currently need to be copied from the example base.css file
    • Grid
    • Typography
    • Utility
  • Responsiveness
  • Don't use props as initial state
  • Convert styles to be CSS Modules
  • Document each component with sample code

Release Notes

1.3.3

  • Update modal backdrop color
  • Add description prop to input, select, textarea.

1.3.0

  • Add styles to slide modal in from right
    • Updated modal styles to be position fixed, be sure to set --root-overflow: hidden when showing (so the background content does not scroll)
  • Fix nav underline margin
  • Add Switch (checkbox)

1.2.0

  • Updated table styles to include a condensed class as well as a footer prop option
  • Updated table to support a title prop option to show above table headers
  • Added a pagination/filter demo to the example docs for tables
    • NOTE: Pagination/Filtering is not a functional option of the Table component, but it is fairly simple to implement, as the example shows
  • Added a small class to the Input component

License

MIT © anothrNick

turtle-ui's People

Contributors

anothrnick avatar

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.