react-talend-components

0.111.0 • Public • Published

react-talend-components

A set of stateless components which follows the Talend Guidelines

NPM

Travis CI Quality dependencies devdependencies peerdependencies Codacy Badge

Conventions

Please look at our CONTRIBUTING first.

Please read our style guidelines first.

Supported browsers

BrowserStack logo

Thanks to BrowserStack for providing real browser testing infrastructure.

How to create a new component

All components are created using the yeoman talend generator using stateless option.

yo talend:react-component
> (nature) stateless
> (tests) snapshot

No {children} for leaf

We want to avoid {children} as much as possible. We believe an app should only pass arguments to stateless components.

So please don't do Pull Requests (PR) to add {children} on leaf components.

But what is a leaf component ? It's a component that is not supposed to contain another component. For example the following components are leaf components:

  • AppHeaderBar
  • SidePanel
  • List
  • Breadcrumb
  • Icon
  • Action(s)

But the following are not leaf:

  • Layout

If you feel the need to add {children} this means we have forget a use case. In this case please expose your use case and try to see how it could be done by passing some props.

onClick / onEvent

The API we have for all components is the following for an event handler

const onClick(event, payload) {
    //do what ever you want 
}
return <APureComponents onClick={onClick} />

Write tests + docs

Our tests are using the react-test-renderer aka snapshot testing. This is by far the best tool to test pure components.

For the documentation and developpement environnement we are using React StoryBook.

    npm start

No anchor

If you want to create a link please use Action component which accept a link prop.

Anchor need href. We are in a single page application, so JavaScript decides the behavior, not the browser. So we don't want to see any anchor link in the markup.

If you want to use Button from react-bootstrap don't forget to add the role + bsStyle="link".

const model = {id: ...};
const onClick(event, payload) {
    //do what ever you want 
    payload.action.label === 'click me';
    payload.model === model;
};
<Action
    label="click me"
    icon="svg-yeah"
    onClick={onClick}
    model={model}
    />

Use Icon for icon

We all are used to <i className="fa fa-XX" /> but this is finished now. We are using <Icon name="fa-xx" /> because with this one we are able to support svg icons which is on the way to be our next gen icons sets.

If you want you can register an new Icon this way:

Icon.register('svg-test', (<svg viewBox="0 0 20 20"><path d="M10.219,1.688c-4.471,0-8.094,3.623-8.094,8.094s3.623,8.094,8.094,8.094s8.094-3.623,8.094-8.094S14.689,1.688,10.219,1.688 M10.219,17.022c-3.994,0-7.242-3.247-7.242-7.241c0-3.994,3.248-7.242,7.242-7.242c3.994,0,7.241,3.248,7.241,7.242C17.46,13.775,14.213,17.022,10.219,17.022 M15.099,7.03c-0.167-0.167-0.438-0.167-0.604,0.002L9.062,12.48l-2.269-2.277c-0.166-0.167-0.437-0.167-0.603,0c-0.166,0.166-0.168,0.437-0.002,0.603l2.573,2.578c0.079,0.08,0.188,0.125,0.3,0.125s0.222-0.045,0.303-0.125l5.736-5.751C15.268,7.466,15.265,7.196,15.099,7.03" /></svg>));

Add component into screenshot CI

open screenshots.config.json file.

The top of the file should stay unchanged. The stories are registred this way:

    "Action": {
      "default": [
        {
          "name": "action-default",
          "selector": ["#default", "#hidelabel"]
        }
      ]
    },
  • Action is the string name of 'storiesOf(' call
  • default is the exact string of the .add / .addWithInfo call
  • the content is an array of Object with name + selector
  • name will be the name of the screenshot(s)
  • selector is a string or an array of string which is behind used to call document.querySelect(selector) so you can try your selector.

npm scripts

  • npm start -> launch storybook on localhost:6006
  • npm run prepublish -> build the sources into the lib folder
  • npm test -> to execute unit test
  • npm run lint -> check the code style
  • npm run watch -> watch the source to trigger a build

LICENSE

Copyright (c) 2006-2016 Talend

Licensed under the Apache V2 License

Package Sidebar

Install

npm i react-talend-components

Weekly Downloads

215

Version

0.111.0

License

Apache-2.0

Last publish

Collaborators

  • frassinier
  • glorieux
  • jmfrancois
  • jsomsanith
  • sromain
  • talend-frontend