@vividseats/vivid-design-patterns

vivid-design-patterns

Vivid Design Patterns are a collection of styles, design tokens and re-usable react components that provide logic and uniformity for Vivid apps.

Full documentation here: http://vivid-design-patterns-master.vividseats.test

How to Install

yarn add @vividseats/vivid-design-patterns

or

npm install @vividseats/vivid-design-patterns --save

Documentation

To run and view documentation locally:

yarn start:docs

You can view and modify the jsx of any component by pressing the view code button </>.

For more information on creating documentation with Docz, visit: https://github.com/pedronauck/docz/blob/master/README.md

Testing

To run tests:

yarn test

Building

To build the javascript assets:

yarn run build:js

Local development with other projects

If you want to make changes to vivid-design-patterns and test them in a separate project without the need to publish the package, do the following:

$ cd vivid-design-patterns
$ yarn link
$ cd your-other-project
$ yarn link @vividseats/vivid-design-patterns

If you are using webpack in your other project, be sure to include this following to your webpack config,

    {
        resolve: {
            symlinks: false
        }
    }

Each time you make a change to vivid-design patterns, rerun yarn run build:js to see the changes reflected in your-other-project

Common Error Seen When Linking VDP to an Application

Uncaught Invariant Violation: Invalid hook call. Hooks can only be called inside of the body of a function component.

This is a common error seen when linking VDP due to an issue with the generation of the dist directory or bundling of its files.

You can fix this error and rebuild the dist directory by running the following in VDP:

$ yarn run clean
$ yarn run build:js
$ yarn link

And by re-linking VDP in your application:

$ yarn link @vividseats/vivid-design-patterns

Feature Branches

When developing with feature branches, you can publish to NPM using a tag. To publish the current branch, run yarn run publish:branch. This will publish the package with the branch name as the tag and 0.0.0-<BRANCH_NAME>-<TIME_STAMP> as the version.

On your feature branch in other projects, use yarn add @vividseats/vivid-design-patterns@<BRANCH_NAME> to install the tagged version of VDP.