@placetopay/spartan-vue

Spartan Vue

Spartan Vue is a vue component library that contains the components used in the PlacetoPay web applications based in TailwindCSS.

Migrating from v2.x? Check out the Migration Guide for step-by-step instructions.

Design system

The documentation and interactive component playground live in the docs/ site of this repository. Run it locally with npm run docs:dev.

Installing

Requirements

• NodeJs ^20.19 || >=22.12 (CI runs 20 and 24)
• NPM ^10
• TailwindCSS ^4

Installation

npm install -D @placetopay/spartan-vue

Configuration for Tailwind CSS v4

1. In your main CSS file (e.g., styles.css), add the following:

   @import "@placetopay/spartan-vue/styles.css";
   
   /* Add your content sources */
   @source '../src/**/*.{vue,js,ts,jsx,tsx}';
   

2. Import the CSS in your main entry file:

   import './styles.css';
   

Custom Primary Color (Tailwind v4)

To customize the primary color, override the CSS variables in your stylesheet after the import:

@import "@placetopay/spartan-vue/styles.css";

@source '../src/**/*.{vue,js,ts,jsx,tsx}';

@theme {
  --color-spartan-primary-50:  rgb(228 242 253);
  --color-spartan-primary-100: rgb(187 222 251);
  --color-spartan-primary-200: rgb(144 202 249);
  --color-spartan-primary-300: rgb(100 181 246);
  --color-spartan-primary-400: rgb(66 165 245);
  --color-spartan-primary-500: rgb(33 150 243);
  --color-spartan-primary-600: rgb(30 132 229);
  --color-spartan-primary-700: rgb(25 103 196);
  --color-spartan-primary-800: rgb(21 78 148);
  --color-spartan-primary-900: rgb(13 42 84);
}

Disable Inter Font

To exclude the Inter font, import the plugin directly instead of the full styles:

@import "tailwindcss";
@import "@placetopay/spartan-vue/styles/plugin.css";
@import "@placetopay/spartan-vue/styles/spartan-vue.css";

@source '../src/**/*.{vue,js,ts,jsx,tsx}';

Spartan Vue 3.x requires TailwindCSS v4. The legacy JavaScript Tailwind plugin (@placetopay/spartan-vue/plugin) was removed in 3.0 — all configuration now happens in CSS. See the Migration Guide.

Usage

<script setup>
import { SButton } from '@placetopay/spartan-vue';
</script>

<template>
   <SButton>Create</SButton>
</template>

Using Components with Translation

Some components come with integrated texts. For these components, Spartan-vue provides translations in five languages:

• Spanish
• English
• Italian
• Portuguese
• French

It is essential to have vue-i18n installed and correctly add the translation JSON files. These translations are entirely customizable, and the functionality can be expanded to include more languages.

Installation of vue-i18n

Before utilizing components with integrated texts and translations, ensure that the vue-i18n library is installed in your project. You can install it using the following command:

npm install vue-i18n

Once the installation is successfully completed, proceed with the configuration in the main.ts file.

Setting up vue-i18n for Spartan-vue Components

In your main file, import vue-i18n and the necessary locales provided by Spartan-vue:

import './styles.css'; // Your CSS file with @import "@placetopay/spartan-vue/styles.css"
import { createApp } from 'vue';
import { createI18n } from 'vue-i18n';
import App from './App.vue';
import { es, en } from '@placetopay/spartan-vue/locales';

const i18n = createI18n({
    locale: 'en',
    fallbackLocale: 'en',
    legacy: false,
    messages: {
        es,
        en 
    }
});

const app = createApp(App);

app.use(i18n);
app.mount('#app');

This configuration sets up vue-i18n with English (en) as the default language and Spanish (es) as an additional language. You can add more languages as needed.

That's it! You've now successfully set up vue-i18n for Spartan-vue components in your project.

Feel free to adjust the instructions to match your project's structure and requirements. If you have any questions or need further assistance, please don't hesitate to ask!

Using Icons

In most cases you will have slots where you can put the icons of your choice. The recommended way to use icons is to use the Iconsax Vue library. You can install it using the following command:

npm install @placetopay/iconsax-vue

Those icons are exported as functional components that are recognized in spartan components:

<script setup>
import { SButton } from '@placetopay/spartan-vue';
import { AddCircleIcon } from '@placetopay/iconsax-vue/bold';
</script>

<template>
   <SButton :left-icon="AddCircleIcon">Create</SButton>
</template>

Using Flag Icons

The flag icons are also available in the Flagicons Vue library. You can install it using the following command:

npm install @placetopay/flagicons-vue