Getting started
Installation
NPM
To install in your project NPM is the preferred way to go as it is what is used in development and what Ornament is built with.
shell
$ npm install ornament-ui$ npm install ornament-uiYarn
Yarn installation
shell
$ yarn add ornament-ui$ yarn add ornament-uiRegisteration
Global (plugin)
To use as a plugin which will enable Ornament globally in every vue file and will also have no need for component registeration
typescript
// main.ts || main.js
import OrnamentUI from 'ornament-ui';
const app = createApp(App)
.use(OrnamentUI)
.mount('#app')// main.ts || main.js
import OrnamentUI from 'ornament-ui';
const app = createApp(App)
.use(OrnamentUI)
.mount('#app')Global (single component)
The approach above can also be used to register single components globally
typescript
// main.ts || main.js
import { OrInput } from 'ornament-ui';
const app = createApp(App)
.component('or-input', OrInput)
.mount('#app')// main.ts || main.js
import { OrInput } from 'ornament-ui';
const app = createApp(App)
.component('or-input', OrInput)
.mount('#app')Per component
Ornament can also be registered at a component level
typescript
import { defineComponent } from 'vue';
import { OrInput } from 'ornament-ui';
export default defineComponent({
components: {
OrInput
}
})import { defineComponent } from 'vue';
import { OrInput } from 'ornament-ui';
export default defineComponent({
components: {
OrInput
}
})