scx567888 / scx-ui

✨ Some front end UI kits for SCX

English | 简体中文

Some front end UI kits for SCX

NPM

npm install scx-ui

Quick start

1. Install the vite plugin for ScxIcon .

import {scxIconPluginUseJS} from 'scx-ui/vite-plugin/index.js';

export default {
    base: './',
    plugins: [scxIconPluginUseJS( // or scxIconPluginUseHtml
        'your-svg-root' //your svg icon root, It can also be an array []
    )]
}

2. Install vue component for ScxIcon .

import {createApp} from 'vue';
import {ScxComponent} from 'scx-ui';
import App from './App.vue';
import 'scx-ui/style/default.css'; // Don't forget to import theme
import 'scx-ui/style/dark.css';
import 'scx-icon/register'; //if type = js you need import this virtual module

createApp(App)
    .use(ScxComponent)
    .mount('#app');

3. Use ScxIcon component .

<!-- You will see a smile face icon -->
<scx-icon icon="outlined-face-smile"/>

For more information, see docs

Stats