@navinc/marketplace-web
v9.20.44
Published
A fully portable -- across Nav's standard environments -- marketplace for the web.
Downloads
2,226
Maintainers
Keywords
Readme
@navinc/marketplace-web
A fully portable -- across Nav's standard environments -- marketplace for the web.
You can view the current build of Storybook here.
Bug Reporting: For technical issues message @frontend
. For design issues talk to a designer.
Quick start
Start Storybook
npx lerna run start --stream --scope=@navinc/marketplace-web
And go to http://localhost:6006/
Contributing
Adding a new Component:
Copy the pattern used with other components. Each component should have its own folder with a structure similar to
/index.js
/index.spec.js
/index.stories.js
IMPORTANT: Don't forget to add them to the main src/index.js
file.
Updating a Component:
This can be dangerous waters. Its super easy to update global components now, but be careful cause this will change it everywhere its used! Make sure to be smart about changes you make and to thoroughly test your changes! If you do make breaking changes, make sure you do a major version bump.
Building
Component Library
npx lerna run build --stream --scope=@navinc/marketplace-web
Storybooks
npx lerna run build:storybook --stream --scope=@navinc/marketplace-web
And open /public/marketplace-web/index.html
to test storybook.
Testing
npx lerna run test --stream --scope=@navinc/marketplace-web
This will run Jest and our linter.
Test in Pip
- Test in pipsqueak with
./bin/copy-package marketplace pip
or to continuously copy over to pipnpx lerna run dev:marketplace --stream --scope=@navinc/marketplace-web
Using marketplace-web in your own projects
- Install it in your project
npm i @navinc/marketplace-web
- Use it! Ex:
import { CreditCardMarketplace } from '@navinc/marketplace-web'
- Refer to Storybook for implementation details for each component.
Add-ons
We use the following add-ons are in Storybooks. Please read their documentation for more details.
- Controls: allow you to edit React props dynamically using the Storybook UI.
- Viewport: allows your stories to be displayed in different sizes and layouts
- Actions: used to display data received by event handlers.
- Options: used to set configure the Storybook UI.
- a11y: accessibility testing. story.
- Info : Shows additional info in the storybook ui about a component