@discue/ui-components

ui-components

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

📦 Installation

Install the package via npm:

  npm install @discue/ui-components

🚀 Usage

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

<template>
    <NavLink href="#pricing">Go to pricing</NavLink>
</template>

<script setup>
import { NavLink } from '@discue/ui-components'
</script>

The list of currently available components can be found at ui.discue.io.

✨ Theming

To change the default theme, register the module as a Vue Plugin and pass an object with theme properties. Valid theme property keys can be found in theme.js and theme-keys.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

  npm run test:unit

📄 License

MIT