Git Product home page Git Product logo

monorail's Introduction


Metro UI compent library for Vue.js


npm CircleCI license GitHub issues FOSSA Status
GitHub commit activity the past week, 4 weeks, year GitHub last commit npm
codebeat badge Chat Chat code with hearth by miniArray
Standard - JavaScript Style Guide
contributions welcome Open Source Helpers

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/src'
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.

monorail's People

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.