uxilab / uxi

UXI Core components - https://twitter.com/uxi_lab

https://www.uxilab.eu/

5 stars 1 forks source link

a11y react redux styled-components ui-components user-experience

readme

UXI - React component library

Demo (wip): uxilab.eu

Doc (wip): uxilab.github.io/uxi/

We're looking for contributors!

This page is only dedicated to contributors. For documentation around the project, please go to uxilab.eu

Pre-requirements

peerDependecies:
- react@^16
- styled-components@3.2.0
- react-dom@^16
Browser support:
- IE11 (in progress)
- all evergreen browser

Installing

Install node.js
git clone git@github.com:uxilab/uxi.git
cd uxi
npm install

start dev

npm run dev
open browser to http://localhost:8989

Add an icon:

drop the dvg into the src/Icons/svgs foldes (named like the other (Name-ico.svg))
cd into src/Icons
run _scripts node _script.js
cd to project root
run npm run lint
stage your icon (svg, js and test file) AND stage the scr/Icons/index.js file
commit

Backlog of things

General

Having UXI documentation online
Having UXI website online

Alert

Create Sketch file for Alert
Create better documentation
Write UX guidelines

Badge

Create tests for Badge
Create Sketch file for Badge
Create better documentation
Write UX guidelines

Button

Create better documentation
Create Sketch file for Button
Add more tests
Write UX guidelines

Dialog

Create documentation
Create Sketch file for Dialog
Create tests
Write UX guidelines

Header

Write UX guidelines
Create documentation
Create tests
Create Sketch file

Img

Write UX guidelines
Create documentation
Create tests
Create Sketch file (?)

Indicator

Write UX guidelines
Create documentation
Create tests
Create sketch file

Input

Checkbox

Create tests
Write UX guidelines
Create Documentation
Create sketch file

Date Input

on hold

File Input

on hold

Radio Input

Create tests
Write UX guidelines
Create Documentation
Create Sketch File

Search Form

Create tests
Write UX guidelines
Create Documentation
Create Sketch File

Select Input

Create tests
Write UX guidelines
Create Documentation
Create Sketch File

Switch Input

Create tests
Write UX guidelines
Create Documentation
Create Sketch file

TextField

Create tests
Write UX guidelines
Create Documentation
Create Sketch file

Input Group

Create tests
Write UX guidelines
Create Documentation
Create Sketch File

Form Decorate for redux-form

TODO

Icons

Create Documentation
Create Sketch File
Create UX guidelines

Menu

Create Documentation
Create Sketch File
Create UX guidelines
Create Tests

Dropdown

Create Documentation
Create Sketch File
Create tests
Create UX guidelines

SlidePanel

Create Documentation
Create Sketch File
Create tests
Create UX guidelines

Stepper

Create Documentation
Create Sketch File
Create tests
Create UX guidelines

Divier

Create Documentation
Create Sketch File
Create tests
Create UX guidelines

Avatar

Create Documentation
Create Sketch File
Create tests
Create UX guidelines

Tabs

Create stand-alone version of tabs
Create overflow version of tabs
Create Documentation
Create Sketch File
Create UX guidelines
Creats tests

Auto-Complete

Create the component
Create Documentation
Create Sketch File
Create UX guideline
Create tests