blackfry/sort-columns

Checklist before submitting code

• The code quality is checked automatically when running npm start. Problems are reported at console output. We expect zero problem be reported
• Components is placed in frontend/components/ and it should be unit tested (See MSNotification.test.js for sample) and documented (See README.md from LinkWithIcon). In summary, for component YourComponent, you should provide us YourComponent.js, YourComponent.css, README.md at "frontend/components/YourComponent/" and YourComponent.test.js at "frontend/test/"
• Please only use the libraries we specified in document to finish the task
• We expect css class name use camel case naming convention. When the css is accessed as javascript property we prefer dot notation instead of square brackets notation. For example, we prefer style.myClassName instead of style['my-class-name'].
• Make sure statements like console.log or debugger be removed
• Take a screenshot of finished component and send to us
• Please use APIs from CommonUtil.js and common.css. But don't modify these two files

Usage

Run npm install && npm run devbuild && npm start will:

• Compile the code into dev version
• Start the dev web server

The root directory of the running application is at frontend-dist, relative to this README.

You can open http://127.0.0.1:3333/webpack-dev-server/ in browser.

When you update the code, the code is automatically deployed and browser is updated automatically. So you basically need do nothing if you use npm start to start the server.

Coding Style

General

Code indentation is two spaces for JS/JSX/CSS.

Keep an eye on console output (the command line window where you run npm commands) from time to time. Any issue is automatically checked and reported there. Make sure zero problem is reported.

Javascript

We use javascript ES2015 and JSX in javascript files. The ES2015 javascript is compiled into ES5 by Babel.

I intend to make javascript code clean and easy to read. So don't use syntactic sugar simply because you can. In the meantime, you do have the full freedom to use any syntax babel compiler supports.

The key point is to be practical and avoid over engineering. For example, it's better to write the redux reducer in its simplest form without extra function wrapper. If there are many reducers rules for one component, it's fine to place those rules inside a function or even an independent js file. But the better solution is to re-design the component so it expose less API to external environment.

React

In import statement, the path should be relative to the current file or the root directory frontend/components. Here are two examples:

// relative to current file
import { fetchComponentData } from './util.js';
// relative to root
import { fetchComponentData } from 'fetchData/fetchData.js';

Root is defined in webpack.config.js resolve section.

We prefer the path relative to root.

But relative to current file is OK if the path is not relative to the parent directory. In other words, ".." must NOT appear in the path.

Front end components are placed at frontend/components:

• A component could inherit from other component
• A component could import another component
• A component is a directory containing one CSS file and one JS file
• See frontend/components/MSFormInput for example
• We use third party UI components from react-bootstrap. If your new component is to inherit from or override a react-bootstrap component. Your component name should comply with react-bootstrap naming convention. For example, if a component type is button, its name must end with "Button"
• Make your code DRY (Don't Repeat Yourself) is encouraged. But avoid over-engineering by creating too many tiny components

Here is a component YourComponentName.js using redux,

import React from 'react';
import { connect } from 'react-redux';
// Optional
import st from './YourComponentName.css';

export class YourComponentName extends React.Component {
  componentDidMount() {
  }

  constructor(props) {
    super(props);
    this.state = {
    };
    this.clickMe = this.clickMe.bind(this);
  }

  clickMe() {
    alert('clickMe() called');
  }

  render() {
    return (
      <div>
        <h1>hello</h1>
        <button onClick={this.clickMe}>Click Me</button>
      </div>
    );
  }
}

function mapDispatchToProps(dispatch) {
  return({
    callDistpach: () {
      dispatch({
        type: 'EVT_GET_CASHFORECAST',
        date: true
      });
    }
  });
}
export default connect(
  function (storeState) {
    // store state to props
    return {
    };
  },
  mapDispatchToProps
)(YourComponentName);

If your component is simple (a button, for example) which does NOT use redux, here is the minimum code(note keyword "default"),

import React from 'react';
export default class YourComponentName extends React.Component {
  render() {
    return (
      <h1>hello</h1>
    );
  }
}

CSS

We use POSTCSS enhanced by postcss-nested, postcss-import, postcss-simple-vars.

It's basically just native CSS with some syntactic sugar. The good news is you don't need consider namespace when writing CSS for a component (css files under components/ directory). You can use any CSS class name without worrying class name conflicts.

Check MyModal.css for general css style. Our button, dropdown, table, grid layout is based on Bootstrap. So make sure the UI style (font size, button width ...) is similar to sample should be fine unless designer has specific requirement.