Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.24 KB

README.md

File metadata and controls

57 lines (40 loc) · 2.24 KB
Raw

MAPC Design System

This is a small experimental library connected to the npm registry. As such, use with care when implementing components into a production site. A few TypeScript-based MAPC sites use the Footer component from version 2.0.0, but due to compilation issues it is not necessarily stable in regular JavaScript projects.

For local development, add SKIP_PREFLIGHT_CHECK=true to your .env file.

Currently actively being contributed by the MAPC Digital Services team. Adding new Typescript React components to be reused throughout different web projects. When engineering new projects and developing custom elements, the Digital Services team considers components for addition with intent to streamline and standardize development materials throughout MAPC web projects.

Development

yarn install
yarn start
yarn storybook

To create a new component, you must include:

  • component.tsx : code for component
  • component.stories.tsx : meta data for component, and different stories to test the component (needs to be a tsx file for react storybook decorators)
  • (optional) styling.css : a file containing the styling for the component
  • add component to index.tsx

Testing

yarn test

Deployment

yarn build and yarn build-storybook, then push code to main branch. Storybook site should automatically redeploy to Github Pages.

To push a new version to the npm registry, make sure you are logged into the MAPC Digital Services npm account (check Dashlane) and run yarn publish

Going forward

This library was built on top of Create React App, which in hindsight was not the best choice. In order for this to be a fully-functioning component library, a few things need adjusting:

  1. Remove CRA artifacts (easiest route might be copying component code into a separate repo and starting fresh rather than trying to carve out CRA)
  2. Configure build script to process TypeScript into JavaScript while still keeping typechecking available with a .d.ts file
  3. Build a more robust test suite beyond Storybook click-testing

MAPC Components

  • Accordion
  • Button:
  • Dropdown Menu
  • Footer
  • Header
  • Logo
  • Map
  • Metrocommon Triangle
  • Page
  • Social Icon
  • Social Nav
  • Tabular View