wri-api-components

2019-11-10 admin

wri-api-components是什么

什么是wri-api-components,Components to use with WRI's API

wri-api-components使用教程帮助文档

Vizzuality Components

Vizzuality Components is a collection of React components shared with any applications and they are based on WRI’s API. The goal of this project is to centralize all common components and keep the consistency through the different apps.

Requirements <g-emoji class=“g-emoji” alias=“hammer_and_wrench” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png”>🛠️</g-emoji>

  node 8.11.2

Getting Started <g-emoji class=“g-emoji” alias=“man_technologist” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png”>👨‍💻</g-emoji>


Once you have the project locally, run yarn install to install project’s dependencies.

Then install peer dependencies running:

yarn add react react-dom vega vega-lib

And that’s all! No need of more setup.

To start working run yarn start. This will run styleguidist responsible of generating our styleguide. Now you are ready to code!

Adding a new component <g-emoji class=“g-emoji” alias=“space_invader” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png”>👾</g-emoji>

To add a new component, go to src/components, you will see a bunch of first-level folders, those are the sections, then choose where you want to create your component (or create a new section, see below).

The component folder needs the following structure:

- index.js (entrypoint, ususally where the component is defined)
- readme.md (file used to define how styleguidist will render the component).
- styles.scss (optional, if there are styles to apply)

Feel free to create as many file as you need to make your component work once you have the mandatory ones.

❗❗ As we are using CSS Modules don’t forget to replace className with styleName in your component in order to allow CSS Modules compile the styles properly.

Adding a new section <g-emoji class=“g-emoji” alias=“scroll” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png”>📜</g-emoji>

To add a new section, go to styleguide.config.js file, look for sections and add yours:

  {
    name: 'Awesome section',
    components: () => ([ path.resolve(__dirname, 'src/components/awesome-section/*', 'index.js') ])
  }

Deploy <g-emoji class=“g-emoji” alias=“rocket” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f680.png”>🚀</g-emoji>


The deploy is set up with gh-pages. To deploy, styleguidist will generate a compiled and production-ready version and gh-pages will deploy it to the gh-pages branch automatically.

Those steps can be run just typing yarn deploy.

For more details, check package.json, scripts section.

Troubleshooting <g-emoji class=“g-emoji” alias=“warning” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/26a0.png”>⚠️</g-emoji>

Vega library uses canvas dependency, this one at the same time depends on cairo. So if you are suffering installing canvas or related go to https://github.com/Automattic/node-canvas#compiling and follow the steps.

Recommendations <g-emoji class=“g-emoji” alias=“rabbit” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f430.png”>🐰</g-emoji>


It’s strongly recommended to use nvm for mananing different Node versions easily.

Release


To release using a fork of zeit release to generate the changelog automatically with all of the PR included since the last release just run:

(Be sure you have all of your branches sync first, and merge the changes that you want in master locally before running the command)

npx release 'major' | 'minor' | 'patch'

and push to master!

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-78897.html

文章标题:wri-api-components

回到顶部