tc-ui-kit

Topcoder UI Kit

Welcome to the Topcoder UI Kit!

Installation

npm install --save tc-ui-kit or add tc-ui-kit: '0.0.x' to your package.json file

Once installed, put @import topcoder-styles in your top level css file. @import topcoder-styles should only be included once. On every other CSS file that requires access to variables or mixins, put @import topcoder-includes at the top.

Browse the Styles

Link to live UI Kit soon using the [SC5 styleguide generator] (http://styleguide.sc5.io/). Checkout the [demo] (http://demo.styleguide.sc5.io/) to see what it will look like.

Contributing

When contributing to this repo, please follow the style guide below. Any changes that are not purely code related must be approved by Vic, and anything added to the repo should be for use across all Topcoder pages. Any page specific images or styles should be added to topcoder-app.

When you're done adding content or making changes:

• increase the version number in package.json
• push your code up to Github
• run npm publish
• in your project that uses tc-ui-kit, run npm update tc-ui-kit. Note that you must have a version number like 0.0.x in your package.json for npm update to work.

Style Guide

When creating new ui components:

• make sure to preface the class name with tc-