@itxura/vue NPM

@itxura/vue

Vue components for the Itxura Design System

Getting started

To install @itxura/vue in your project, you will need Vue.js version 3+. Run the following command using npm:

npm install -S @itxura/vue

This package requires Sass in order to compile styles.

Usage

The @itxura/vue package provides components for the ITX Design System.

To use a component, you can import it directly from the package:

<!-- App.vue -->
<script>
	import { ItxButton } from '@itxura/vue'
</script>

<ItxButton> My button </ItxButton>

Or import the whole package

import { createApp } from 'vue'
import App from './App.vue'
import ItxComponents from '@itxura/vue'

const app = createApp(App)

app.use(ItxComponents)

To include the styles for a specific component, you can either import all the styles from the project or include the styles for a specific component:

// Bring in all the styles for ITX
@use '@itxura/styles';

// Preferred: bring in the styles for one component
@use '@itxura/vue/scss/components/button';

For a full list of components available, checkout our Storybook.