npm:@rebilly/recomponents

README

Recomponents

Installation

Recomponents is compatible with both yarn and npm:

npm install @rebilly/recomponents --save
yarn add @rebilly/recomponents

Usage

Recomponents can be imported directly via CDN (check JSFiddle):

<html>
    <head>
        <meta charset="utf-8">
        <script src="https://unpkg.com/vue"></script>
        <script src="https://unpkg.com/@rebilly/recomponents/dist/recomponents.js"></script>
        <link rel="stylesheet" href="https://unpkg.com/@rebilly/recomponents/dist/recomponents.css">
    </head>
    <body>
        <recomponents-r-button>Click me</recomponents-r-button>
    </body>
</html>

Or bundled with webpack:

<template>
    <main>
        <r-button>Click me</r-button>
    </main>
</template>

<script>
    import Vue from 'vue'
    import '@rebilly/recomponents/dist/recomponents.css'
    import Recomponents from '@rebilly/recomponents'

    Vue.use(Recomponents)

    export default {}
</script>

During installation you can specify some options that could ovverride default behaviour of some components.

List of available options

ErrorHandler - Handler to convert any server / client error into user-friendly message that can be displayed via RToast
allowToastCloseButton - Add ability to close all RToast messages by default

Documentation

We prefer Storybook to plain-old documentation. Check it out to see all of our components on display, with a comprehensive description and the ability to tweak properties and slots.

Building storybook

Building (will generate bundled version in ../../docs folder):

npm run build-storybook
yarn build-storybook

Serving built storybook (from docs folder)

If you want to serve the built version you can install http-server:

    yarn global add http-server
    npm install http-server -g

and run:

    yarn serve-built-storybook
    npm run serve-built-storybook

Licence

Recomponents are open source and released under the MIT Licence.

Usage no npm install needed!