Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.46 KB

README.md

File metadata and controls

42 lines (25 loc) · 1.46 KB

React TEC

NPM JavaScript Style Guide

These docs will provide you with simple get started instructions and detailed examples of every component in the library.

Installation

The package can be installed via NPM:

yarn add react-tec or npm install react-tec --save

You will also need to install styled-components react-route and react-router-dom.

yarn add styled-components react-router react-router-dom or npm install styled-components react-router react-router-dom --save

Usage

Start by wrapping your app or where ever you plan to use React TEC components with TEThemeContext or TEAppWrapper. These components provide a base theme to all components and you will experience an error if you don't. I typically do this kind of wrapping in index.js. Usually something like:

import React from 'react'
import { TEAppWrapper } from 'react-tec'

const Main = () => (
	<TEAppWrapper>
		<App />
	</TEAppWrapper>
)

ReactDOM.render(<Main />, document.getElementById('root'))

Acknowledgements

Thank you to TSDX for such an amazing starting point!

License

MIT © SCasarotto