Quark Design

An enterprise-class UI design language and cross-framework UI library, Based on web components.

Motivation

The emergence of the technical framework has improved the development experience and page performance, but the continuous iterative update of the technical framework has brought many challenges to the maintenance of the project, such as:

Visual components cannot be used across technical frameworks (React, Vue, etc.)
Once the technical framework is upgraded, visual components often have to be upgraded iteratively

Therefore, we developed this UI framework to isolate it from the technology framework (no technology stack), so that visual components can avoid falling into the vicious circle of technology stack iteration and iteration.

Features

Support Vue, React, Angular, JQ and no framework project
40+ High quality components
Support Tree Shaking
90%+ Unit test coverage
Written in TypeScript
Support TypeScript
Support Custom Theme
Support i18n, built-in 20+ languages

Install

Using npm to install:

# install for Vue/React/Angular/No framework project
npm i quarkd

#  install for React project
npm i @quarkd/quark-react --save

Quickstart

Vue.x

// 1. Import the components you need
import "quarkd/lib/button"

// 2. Use it
<quark-button type="primary">Button</quark-button>

React.x

// 1. Import the components you need
import { Button } from '@quarkd/quark-react';

// 2. Use it
const App = () => (
  <>
    <Button type="primary">Button</Button>
  </>
);

Angular

// 1. Import the components you need
import "quarkd/lib/button"

// 2. Use it
@Component({
  template: `<quark-button loading="{{loading}}"" (click)="handleClick()">
    Button
  </quark-button>`
})

No framework project

<!DOCTYPE html>
<html lang="en">
<body>
  <quark-button loading="false" id="btn">Button</quark-button>
</body>

<script src="./node_modules/quarkd/lib/button/index.js" /> // or cdn
<script>
  window.addEventListener(function() {
    const el = document.getElementById('btn')
    el.loading = true
    setTimeout(() => { el.loading = true }, 2000);
  })
</script>
</html>

Custom theme

See custom theme 。

Internationalization

Dozens of languages supported in, see Docs。

Browser Support

Modern browsers and Internet Explorer 11 (withpolyfills)。

Contribution Guide

Please make sure to read the Contributing Guide before making a pull request.

Special Note

Since the components provided by quarkd are all native custom elements (analogous to div), the events dispatched by the components need to be received using addEventListener.
The Vue stack uses @xx to receive natively dispatched events, so there is no need to use addEventListener to receive them.
For the React technology stack, in order to avoid developers manually addingEventLisener to receive events, we rely on quarkd at the bottom and Reactify (Reactize) the upper layer! Therefore the React project recommends using @quarkd/quark-react.

Pay attention

Unknown custom element in Vue project:

<!-- vue2: -->
Unknown custom element: <quark-icon> - did you register the component correctly? For recursive components, make sure to provide the "name" option.
<!-- vue3 -->
[Vue warn]: Failed to resolve component: quark-icon

This is because the syntax part of Vue components refers to custom elements. In order to avoid conflicts with Vue components, custom elements need to be ignored! Please inject the following code into the project:

// VUE2.x
Vue.config.ignoredElements = [/^quark-/]

// VUE3.x
// https://v3.cn.vuejs.org/guide/migration/global-api.html#config-productiontip-%E7%A7%BB%E9%99%A4
const app = createApp({})
app.config.compilerOptions.isCustomElement = tag => tag.startsWith('quark-')

If you are using vite, modify vite.config.js:

import vue from '@vitejs/plugin-vue'

export default {
  plugins: [
    vue({
      template: {
        compilerOptions: {
          isCustomElement: tag => tag.startsWith('quark-')
        }
      }
    })
  ]
}

Contact us

Wechat(微信交流/沟通群)，欢迎提意见或建议，有机会获取周边礼品🎁～

hyc123456hyc/quark-design