Skip to content
This repository has been archived by the owner on Mar 21, 2023. It is now read-only.
/ rqcomponents Public archive

Reusable business component, not basic ui lib, build from scratch

Notifications You must be signed in to change notification settings

anson09/rqcomponents

Repository files navigation

RQCOMPONENTS

ricequant common vue componenets

Release

master: https://www.npmjs.com/package/@rqjs/rqcomponents

Import

Full Import(NOT RECOMMANDED)

import UI from "@rqjs/rqcomponents";
import "@rqjs/rqcomponents/lib/theme/index.css";
import "@rqjs/rqcomponents/lib/theme/base";
import "@rqjs/rqcomponents/lib/theme/base.css";

Partial Import

rqcomponent only exports esm packages.

import RqHeader from "@rqjs/rqcomponents/lib/[rq-component-name]";
// Or import all components and deconstruction.
// import { RqHeader } from "@rqjs/rqcomponents";

import "@rqjs/rqcomponents/lib/theme/[rq-component-name].css";
import "@rqjs/rqcomponents/lib/theme/base";
import "@rqjs/rqcomponents/lib/theme/base.css";

Registration

Global Registration

import RqHeader from "@rqjs/rqcomponents/lib/[rq-component-name]";

Vue.use(RqHeader);

new Vue({
  el: "#rq-header",
  render: (h) => h(RqHeader),
});

Local Registration

import RqHeader from "@rqjs/rqcomponents/lib/[rq-component-name]";

new Vue({
  el: "#rq-header",
  components: { RqHeader },
  render: (h) => h(RqHeader),
});

Developer

Commands

npm run start: preview components, need configure `nginx.sample.conf`,visit http://<host>/rqcomponents

npm run dev : generating publish files use watch mode

npm run build : generating publish files

npm run lint : audit code style

npm run clean : clear demo cache

Contributions

  1. git 规范

  2. lint 规范

  3. npm 规范

  4. icon 规范

  5. please keep sync COMPONENTS_DOC.md and demo/App.vue with packages/<package-name>/