@rebilly/recomponents

Official Rebilly front-end components library
3,724 8
vue rebilly
Install
npm install @rebilly/recomponents
Latest Version:1.40.0
Vue:2
License:MIT
Last Updated:Jan 26, 2023
Links: GitHub  ·  npm
Maintainer: adamaltman

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

⚠️ If you encounter errors when building, it might be the node version(like v16) is too high, we recommend using nvm to downgrade the node version to v14.

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.

Copyright © 2019 Rebilly

Related Packages

@rebilly/framepay-vue

Official Vue wrapper for Rebilly FramePay

78,075
rebilly vue billing framepay framepay-vue payment
vue

The progressive JavaScript framework for building modern web UI.

588,019,132 54,801
vue
@vueuse/shared
372,738,348 22,398
vue utils vue-use
@vueuse/core

Collection of essential Vue Composition Utilities

367,188,523 22,398
vue utils vue-use
@vitejs/plugin-vue

The official plugin for Vue SFC support in Vite.

333,357,380 686
vue vite vite-plugin

Version History

Version Released Vue License
1.40.0 ^2.6.0 MIT
1.39.0 ^2.6.0 MIT
1.38.7 ^2.6.0 MIT
1.38.6 ^2.6.0 MIT
1.38.5 ^2.6.0 MIT