Monorail for React helps developers execute the Monorail Design Language. Developed by the core team of engineers and UX designers at SimSpace, these components enable a reliable development workflow to build beautiful and functional web projects.
Add Monorail to your React application.
yarn add @simspace/monorail
You will also need our peerDependencies
.
yarn add react react-dom styled-components
Check the accepted version range in package.json
for compatibility.
Import the components you want and use them
import { Button } from '@simspace/monorail/dist/buttons/Button'
...
render() {
return (
<Button>Monorail</Button>
)
}
Check out our documentation site, design.simspace.com to see all the components that are available, and how to use them.
Some Monorail components need default icons from the Material Icon's set. Link the iconography font into your app:
<link href=โhttps://fonts.googleapis.com/icon?family=Material+Iconsโ rel=โstylesheetโ>
When using Monorail with a typescript project, make sure to add the following line to the compilerOptions
of your tsconfig.json
.
"skipLibCheck": true
When it's ready, first you must bump the version:
npm version patch
This will increment the patch version. Then, create a new build:
yarn build
The dist/
folder now contains the files and its own package.json
. To actually publish the new release:
(cd dist && npm publish --access public)