/go1d

Primary LanguageTypeScript

Go1d

Overview

Go1d (Spoken Gold) stands for Go1 Design System and is a library of mostly static components for building interfaces. This repo should contain minimal components with more stateful components being in GO1D/Mine module.

Installation

To use the Go1d component library in your consuming app, run either:

yarn add @go1d/go1d

… or:

npm install @go1d/go1d

Documentation

Contributing

See the CONTRIBUTING.md guide to learn:

  • How to develop Go1d locally and add changesets
  • How to link across repos
  • How to run tests
  • How to develop component stories in Storybook
  • How to develop the docs-site in the subdirectory project ./docs-site with its own dependencies. See docs-site/README.md

Maintainers

Known Issues

#1

We have some import like this:

import merge = require("lodash/merge");

which doesn't work with babel specifically @babel/preset-typescript. This piece of code should only work with tsc compiler. While in our tsconfig.json, we leave { "allowSyntheticDefaultImports": true } this means allow to import default export import x from "y", howerver, above option should come with { esModuleInterop: true }. I think this is why we had a require like issue #1.