Git Product home page Git Product logo

monorail's Introduction

๐Ÿš Monorail | Cyber Design System

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.

Quick Start

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/visualComponents/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.

Iconography

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โ€>

Typescript

When using Monorail with a typescript project, make sure to add the following line to the compilerOptions of your tsconfig.json:

"skipLibCheck": true

monorail's People

Contributors

quicksnap avatar steve-jones avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.