LocoKit - Vue components library

This repository holds VueJS components.

Those components are used in the LocoKit back-office application, and can also be used for front-office applications.

[!IMPORTANT] This package is not yet stabilized. Some evolutions could break backward compatibility through versions until we reach the 1.x .

Getting started

Dependencies

The @locokit/vue-components needs some packages to work.

On a VueJS project, please add these dependencies :

pnpm add primevue @primevue/themes \ # primevue dependencies
  tailwindcss postcss autoprefixer tailwindcss-primeui \ # tailwind dependencies
  @locokit/locales vue-i18n \ # translation dependencies
  @locokit/definitions \ # other @locokit dependencies
  primeicons bootstrap-icons # icons (bootstrap + prime)

TO BE CHANGED WITH PRIMEVUE MORE RECENT AND TAILWIND v4

Create a vue project with the create-vite

pnpm create vite calculator-vite --template vue

pnpm i tailwindcss @tailwincss/vite // + instruction to update vite.config.ts + @import 'tailwindcss'; in style css file primevue @primeuix/themes tailwindcss-primeui // + instruction to add it in main.ts and https://primevue.org/theming/styled vue-router // if router is needed @locokit/definitions // common package vue-i18n @locokit/locales // for translation purpose, mandatory for vue-components as they are translated primeicons bootstrap-icons // icons

Add in the style.css file :

@import 'tailwindcss';
@import 'tailwindcss-primeui';
@source '../node_modules/@locokit/vue-components/dist/lib.js';

https://vite.dev/guide/#scaffolding-your-first-vite-project

Configure files

Some files need to be created or updated :

• src/main.{js,ts}
• src/styles.css (or your CSS root file)
• postcss.config.js
• tailwind.config.js

src/main.{js,ts}

In your src/main.{js,ts} file, configure PrimeVue and vue-i18n as shown below.

/* src/main.js */
import { createApp } from 'vue'

/**
 * Translation
 */
import { createI18n } from 'vue-i18n'
import en from '@locokit/locales/en.json'
import fr from '@locokit/locales/fr.json'

/**
 * PrimeVue
 */
import PrimeVue from 'primevue/config'
import Aura from '@primevue/themes/aura'

import './styles.css'
import App from './App.vue'

const i18n = createI18n({
  locale: 'en',
  fallbackLocale: 'en',
  messages: {
    en, fr
  }
})

const app = createApp(App)
app.use(i18n)
app.use(PrimeVue, {
  theme: {
    preset: Aura,
    options: {
      cssLayer: {
        name: 'primevue',
        order: 'tailwind-base, primevue, tailwind-utilities',
      },
    }
  }
})

app.mount('#app')

• src/styles.css (or your root CSS file)

/* src/styles.css */
@import url('bootstrap-icons/font/bootstrap-icons.css');
@import url('primeicons/primeicons.css');

@layer tailwind-base, primevue, tailwind-utilities;

@layer tailwind-base {
  @tailwind base;
}

@layer tailwind-utilities {
  @tailwind components;
  @tailwind utilities;
}

• postcss.config.js

If you already have installed Tailwind CSS, this file is probably already in your code base.

/* postcss.config.js */
export default {
  plugins: {
    tailwindcss: {},
    autoprefixer: {},
  },
}

• tailwind.config.js

[!WARNING] You need to add the @locokit/vue-components package to the content analyzed by Tailwind CSS to collect classes used in our components.

If you don't do this, vue-components won't be displayed correctly.

/* tailwind.config.js */

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    ...
    // adding the vue-components is mandatory to detect all used classes
    './node_modules/@locokit/vue-components/dist/**/*.js',
  ],
  ...
  plugins: [require('tailwindcss-primeui')],
  ...
}

Use it !

To import components, you can :

// import them separately
import { SingleTag } from '@locokit/vue-components'
// then use it with <single-tag /> or <SingleTag />

// import components & layouts
import { components, layouts } from '@locokit/vue-components'
// then use <components.SingleTag />

Autocomplete for properties and events is provided in IDE like VS Code :

Dependencies

@locokit/definitions

This package contains typings and some helpers.

i18n + @locokit/locales

This library provides vue-i18n and the t function for translation purpose, used in vue-components.

primevue @primevue/themes

vue-components is based on primevue components.

See https://primevue.org/vite/ for further information.

tailwindcss + postcss + autoprefixer + tailwindcss-primeui

vue-components uses also Tailwind CSS, combined with PrimeVue components.

To combine Tailwind CSS and PrimeVue, we use tailwindcss-primeui plugin.

Please see https://tailwindcss.com/docs/guides/vite#vue for further information.

primeicons bootstrap-icons

Icons from these two packages are used, and are available for your project too.

For developers

[!TIP] If you encounter any issue, if a feature is missing or if you have ideas to develop new components, please submit issues first to discuss with us.

A storybook is included in this project.

Run it with pnpm dev.

Contributing

After creating an issue, if you want to implement the new feature / component, please be aware that in case you add a primevue component not already used, you'll have to add it in the vite.config.ts in external rollupOptions, to avoid add them in the final bundle.