npm

Bring the best of OSS JavaScript development to your projects with npm Orgs - private packages & team management tools.Learn more »

@globalfishingwatch/map-components

1.8.1 • Public • Published

GFW map components

npm version

Set of components used in global fishing watch map frontend.

Using the components

Check out the online documentation

Components structure

component
│   component.js    // Component logic
│   component.css   // Component styles
│   component.mdx   // Generates component documentation
│   index.js // Optional file that generates a new folder below the components one
│            // and exports component code and any possible child component dependencies
│            // This makes possible components code splitting easily with
│            // import Component from '@globalfishingwatch/map-components/components/[component-name]
│
└───subcomponent
│       subcomponent.js
│       subcomponent.css
└───────────────────────

Develop with components

In order to do easier edits on the components while developping parent apps, use this repo locally:

git clone git@github.com:GlobalFishingWatch/map-components.git
cd map-components
yarn install
yarn link
yarn start
cd sandbox
yarn install
yarn link "@globalfishingwatch/map-components"
yarn start

Documentation

Docz is used to include live components documentation using mdx.

This playground could be used locally to test the components running:

yarn docz:dev

Release

Using zeit release to make our life easier, so just run

npx release major|minor|patch

and it will update the package.json, generate the github release and push your changes and finally:

npm publish

(⚠️ don't forget to bump dependency version on parent project if needed!)

License

MIT ©

Keywords

none

install

npm i @globalfishingwatch/map-components

Downloadsweekly downloads

109

version

1.8.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability