Socket
Book a DemoInstallSign in
Socket

@rebilly/recomponents

Package Overview
Dependencies
Maintainers
5
Versions
153
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@rebilly/recomponents

Official Rebilly front-end components library

1.40.0
latest
Source
npmnpm
Version published
Weekly downloads
157
5133.33%
Maintainers
5
Weekly downloads
 
Created
Source

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

Keywords

Rebilly

FAQs

Package last updated on 26 Aug 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.