Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.65 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.65 KB

Link

Examples and documentation are available here: https://dcomponents.ucsddesign.co

Technologies Used

Web Development: React, TypeScript, Storybook, Jest, Rollup, Webpack, Babel, SCSS

DevOps: Git, GitHub Packages, GitHub Actions

Development Standards: Web Content Accessibility Guidelines (WCAG) 2.1, Aria Authoring Practices Guide (APG)

Description and Motivation

This is a component library for Design Co UCSD. It is published to npm: https://www.npmjs.com/package/@arth-shukla/dco-mponents.

Features

  1. Supports computer, mobile, and tablet web interfaces through webkit
  2. Written in Typescript
    • Prop typing allows for easier debugging in projects
    • Components usable in both Typescript and standard React projects
  3. Jest for Unit Testing
    • Scalable and allows for high code coverage
  4. Storybook for documentation and demos
    • Easy visual QAs to make sure in-line with DCo Design System
    • Documentation generated automatically
    • Demos allow for examining/testing use cases
  5. Accessible
    • The components themselves support keyboard control and aria tags are added where appropriate.
    • Additional acessibility options (e.g. aria-labels) must be passed as props.
  6. Customizable
    • Additional props (ids, classNames, etc) can be passed into the component to override default styling.
    • One can also alter the styling directly with CSS by modfying the class styling

Related Projects

Storyboook demos and documentation are available here: https://ucsddesignco.github.io/dco-mponents.

About Me

Arth Shukla Site | GitHub | LinkedIn