https://github.com/discue/ui-components

Themeable open source Vue.js UI component library of discue.io
https://github.com/discue/ui-components

asynchronous asynchronous-programming components vue vuejs

Last synced: 10 days ago
JSON representation

Themeable open source Vue.js UI component library of discue.io

• Host: GitHub
• URL: https://github.com/discue/ui-components
• Owner: discue
• License: mit
• Created: 2022-04-25T06:08:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T11:28:49.000Z (16 days ago)
• Last Synced: 2024-11-01T12:24:33.412Z (16 days ago)
• Topics: asynchronous, asynchronous-programming, components, vue, vuejs
• Language: Vue
• Homepage: https://ui.discue.io
• Size: 14.3 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        








[![GitHub tag](https://img.shields.io/github/tag/discue/ui-components?include_prereleases=&sort=semver&color=blue)](https://github.com/discue/ui-components/releases/)

[![Latest Stable Version](https://img.shields.io/npm/v/@discue/ui-components.svg)](https://www.npmjs.com/package/@discue/ui-components)

[![License](https://img.shields.io/npm/l/@discue/ui-components.svg)](https://www.npmjs.com/package/@discue/ui-components)




[![NPM Downloads](https://img.shields.io/npm/dt/@discue/ui-components.svg)](https://www.npmjs.com/package/@discue/ui-components)

[![NPM Downloads](https://img.shields.io/npm/dm/@discue/ui-components.svg)](https://www.npmjs.com/package/@discue/ui-components)




[![contributions - welcome](https://img.shields.io/badge/contributions-welcome-blue)](/CONTRIBUTING.md "Go to contributions doc")

[![Made with Node.js](https://img.shields.io/badge/Node.js->=16-blue?logo=node.js&logoColor=white)](https://nodejs.org "Go to Node.js homepage")






# ui-components

A collection of **themeable** vue.js components used in discue.io.

## 📦 Installation

Install the package via npm:

```bash

  npm install @discue/ui-components

```

## 🚀 Usage

In your component files, import any ui component from the main export and use it in your template. 

```vue

    Go to pricing

import { NavLink } from '@discue/ui-components'

```

The list of currently available components can be found at [ui.discue.io](https://ui.discue.io/components/back-to-top.html).

## ✨ Theming

To change the default theme, register the module as a [Vue Plugin](https://vuejs.org/guide/reusability/plugins.html#introduction) and pass an object with theme properties. Valid theme property keys can be found in [theme.js](src/theme.js) and [theme-keys.js](src/theme-keys.js).

```js

import { theme } from '@discue/ui-components'

import { createApp } from 'vue'

import App from './App.vue'

createApp(App)

    .use(theme, {

        [theme.TEXT_COLOR_DEFAULT]: 'text-gray-500'

    })

    .mount('#app')

```

## 🧪 Running Tests

To run tests, run the following command

```bash

  npm run test:unit

```

## 📄 License

[MIT](https://choosealicense.com/licenses/mit/)