Giter VIP home page Giter VIP logo

ornament-ui's Introduction

Ornament UI

A UI component library for Vue 3.

Note: Thanks for trying this out. Please take notice that this project is still in active development and doesn't have a v1 yet. As such you can expect it'll be buggy. If you find any bugs or just want a feature please create an issue. Thanks

See it in action Ornament Docs

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.

$ npm install ornament-ui

Yarn

Yarn installation

$ yarn add ornament-ui

Registeration

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

// 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

// 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

import { defineComponent } from 'vue';
import { OrInput } from 'ornament-ui';

export default defineComponent({
    components: {
        OrInput
    }
})

ornament-ui's People

Contributors

ikeohachidi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

ornament-ui's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.