Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.65 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.65 KB
Raw

ML Component Library

Keep track of reusable components for internal re-use. Based on the CDL spec

View the Library

Current plan

Clone this branch and then run npm install && npm start to run the server and try out components locally or visit the library demo page.

PRs and bug reports greatly appreciated. Contact @jeffp on slack or post in the #cdl channel.

styled-components

I have ported some of these components over to styled-components from CSS modules for simplicity and because I really like them. I am open to other options but the self-contained aspect of styled-components is appealing for this use case.

Folder structure

├── src/
│     ├── assets
│     │   └── fonts
│     │   └── styles
│     ├── components/
│     │   └── MLButton
│     │     └── MLButton.example // Demo code for the preview playground
│     │     └── MLButton.js // React component module
│     │     └── MLButton.md // Usage information, the text below the demo
│     └── libs/

TODO

  • Establish component standards
    • Which components are pure vs smart?
  • Package these as modules for NPM installation
  • Add a11y requirements
  • Finish copying usage information from
  • Write tests
  • AccordionList

View usage examples on the demo.