Dev QA Master

Topcoder UI Kit

This repo houses Topcoder's style guide and component library. Design documentation and information on the style guide principles can be found at https://app.frontify.com/d/zEXqGHFD1YN2/ui-library.

The technologies used are React, Redux, ES2015, Webpack, and SCSS.

Installation

We use node 5.x and npm 3.x, so you may need to download a new version of node. The easiest way is to download nvm. We have a .nvmrc file in the root of the project, so you can just run nvm use to switch to the correct version of node.

Install dependencies by running the following in the root of the project:

• npm i
• Note: You must use npm 3. Type npm -v to ensure you have a 3.x version.

NPM Commands

• To run locally, run npm start and head to localhost:8080
• To make sure your code passes linting: npm run lint
• To create the build: npm run build

Contributing

Pull Requests

To contribute to the repository, please create a feature branch off of the dev branch. Once you're finished working on the feature, make a pull request to merge it into dev. Please make sure that every pull request has passed the build checks, which appear just before the "Merge pull request" button in github.

Code Style

Checkout the code and comments in src/components/ExampleComponent for an example functional React component and .scss file.

React

• Most components should be stateless and use the functional component pattern
• If you need a stateful component, use ES6 classes
• Always use PropTypes for all props
• Use classnames for dynamic classes. See ExampleComponent for an example.

JavaScript

• Make sure your variable names are easy to understand and descriptive. No acronyms, except for common ones like i or err.
• Use lodash and functional JavaScript if it makes the code clearer.
• Please use ES2015 syntax whenever possible
• Specific rules are enforced via .eslintrc.json
• Run npm run lint to check your code against the linter

SCSS Files

• This repository uses flexbox for arranging content
• The use of any extra CSS libraries should be discussed with the team
• Use SCSS syntax, but do not overly nest
• Use 2 spaces for indentation
• Use variables, mixins, and classes as much as possible from our style guide
• To include variables from the style guide mentioned above, place @import 'topcoder/tc-includes;' at the top of your .scss file. Locally, you can look in ./node_modules/appirio-styles/styles/topcoder/_tc-colors.scss to find many colors already defined (e.g. #A3A3AE => $accent-gray)
• When adding media queries, nest them inside the element, rather than creating a new section

@import 'topcoder/tc-includes;'

$my-local-var: 50px;

.box {
  height: $my-local-var;
  width: 50px;
  color: $medium-gray;
  @media screen and (min-width: 768px) {
    height: 100px;
    width: 100px;
    color: $dark-gray;
  }

  .inside-box {
    font-size: 14px;
    @media screen and (min-width: 768px) {
      font-size: 18px;
    }
  }
}

Recommended Developer Tools

Syntax highlighting for ES6 and React JSX

• Install babel via the package manager in Sublime Text
  • Note: Sublime Text 3 is required for this plugin
• Set the plugin as the default syntax for a particular extension
  • Open a file with the .js extension
  • Select View from the menu
  • Then Syntax -> Open all with current extension as...
  • Then Babel -> JavaScript (Babel)
  • Repeat for any other extensions, e.g. .jsx

Recommended Theme

• Install Oceanic Next Color Theme via the Sublime Text package manager.
• Add the following to Sublime Text -> Preferences -> Settings-User (⌘ + , on Mac)

{
  "color_scheme": "Packages/Oceanic Next Color Scheme/Oceanic Next.tmTheme",
  "theme": "Oceanic Next.sublime-theme"
}

Automatic JavaScript linting in Sublime Text

• Install SublimeLinter following the instructions under "Installing via Package Control"
• Install SublimeLinter-eslint with the package manager. The package is called SublimeLinter-contrib-eslint

Code expander

• Examples:
  • div.cool-class becomes <div className="cool-class"></div>
  • a becomes <a href=""></a>
• Install Emmet via Sublime Text package manager
• Configure Emmet to work with React, e.g. classes expand to className instead of class
• Follow the instructions under Get Emmet working
  • Note: Add the last snippet of code to reg_replace.sublime-settings by navigating to Sublime Text -> Preferences -> Package Settings -> Reg Replace -> Settings-User

Using the tc-ui repository in your app

Install

npm install --save tc-ui