Getting Started
Kro UI is an MIT-licensed open source Vue UI library for building web applications.
Official Documentation & Demos
Install Kro UI
To install Kro UI you will either need to have NPM or Yarn installed.
Install via NPM
npm i --save @black-kro/ui
Install via Yarn
yarn add @black-kro/ui
Using Kro UI
import { createApp } from 'vue';
import App from 'App.vue';
import { KroUIPlugin } from '@black-kro/ui';
import '@black-kro/ui/dist/kro-ui.common.css';
import '@black-kro/ui/dist/themes/default.scss';
createApp(App)
.use(KroUIPlugin, {
icons: {
'menu': 'M3,6H21V8H3V6M3,11H21V13H3V11M3,16H21V18H3V16Z',
}
})
.mount('#app');
Contributing
Feel free to contirbue to the project. You can request new features by creating an issue or you can contribute your own features by creating a pull request. Before working on a feature it is a good idea to open an issue to ensure the feature fits the project.
Bug reports are also appericated. When reporting a bug try to provide some information that can be used to help determine the issue. Things like erros messages, package version, and relevent code would be good things to include.
Development Setup
You will need to install the latest version of Node.js before getting started.
After cloning the repo, run:
$ npm install
Commonly used NPM scripts.
$ npm run serve
$ npm run build
$ npm run docs
Project Structure
build
: Contains build scripts for the project and docs.dist
: Contains built files for distribution.docs
: Contains docs for the UI library.src
: Contains the source code for the UI components.
components
: Contains folders which each represent a different component.styles
: Contains the base styles needed for the Kro UI library.
License
MIT
Copyright (c) 2020-present, Jacob Clevenger