:blue_book: Documentation

​ Our documentation site lives at design.mobivia.com. You'll be able to find detailed documentation on getting started, all of the components, our themes, our guidelines, and more. ​

:package: Installation

​ Before moving further, please make sure you have Node.js installed on your machine. You can install the latest version through their website.

If you’re planning on using web components in a project that doesn’t yet use Node Package Manager, you’ll have to first create a package.json file. To do this, run npm init and follow the steps provided.

Run in your project or website root directory (where package.json lives): ​

npm install @roadtrip/components --save

​ Now that the Web Component library is installed, you'll find information about framework integration in our documentation. ​

:rocket: Usage

​ Our Web Components are loaded by the loader your installed in your application, so now you can just put tags and properties of components your want to use. ​

<road-button color="secondary">click me!</road-button>

​ You can find the list of all our components already available in our documentation. ​

:computer: Contributing

Please take a look at our contributing guidelines if you're interested in helping! ​

:newspaper: Changelog

Find all the latest changes in our changelog.

:page_with_curl: License

​ Copyright © 2021 Mobivia.

Distributed under Apache-2.0 license.