@miniarray/monorail

v1.5.0

Published

2 years ago

Metro UI components for vue

Downloads

0High
0Medium
0Low

simonwjackson

Introduction

monorail is a metro UI component framework for Vue.js. It aims to provide clean, semantic and reusable components that make building your web based windows application a breeze.

Browser Support

monorail supports evergreen browsers, mobile, laptop & desktop.

Documentation

You can find the monorail documentation on the website.

One minute Quick-start

Codepen link

<!DOCTYPE html>
<html>
  <head>
    <link href="https://unpkg.com/metro4@4/build/css/metro-all.css" rel="stylesheet" />
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui">
  </head>
  <body>
    <div id="app">
      <m-switch :checked="true" />
    </div>

    <script src="https://unpkg.com/vue@2/dist/vue.js"></script>
    <script src="https://unpkg.com/@miniarray/monorail/dist/components/monorail.js"></script>
    <script>
      new Vue({
        el: '#app'
      })
    </script>
  </body>
</html>

Installation

Modern

$ npm install @miniarray/monorail
$ npm install vue metro4 # dependencies

import Vue from 'vue'
import Monorail from '@miniarray/monorail'
import 'metro4/build/css/metro-all.css' // Required for CSS styles

Vue.use(Monorail)

CDN

<link href="https://unpkg.com/metro4@4/build/css/metro-all.css" rel="stylesheet" />
<script src="https://unpkg.com/vue@2/dist/vue.js"></script>
<script src="https://unpkg.com/@miniarray/monorail/dist/components/monorail.js"></script>

Running The Test Suite

Console:

Installed the dependencies, via:

npm install

then you can run the tests (and get detailed output) by running:

npm test

Community Support

Ask your support questions on the monorail Discord Community.

Contributing

Developers interested in contributing should read the Code of Conduct.

Please do not ask general questions in an issue. Issues are only to report bugs, request enhancements, or request new features. For general questions and discussions, ask on the monorail Discord Community.

It is important to note that for each release, the detailed changes are documented in the release notes.

Contributing Guide

You can report issues by following the Issue Template and you can create a minimal reproduction with a CodePen template or a full project at CodeSandbox.

We also have a list of help wanted issues that you might want to check.

License

monorail is MIT licensed.