@open-xamu-co/ui-nuxt

Nuxt 3 module for the xamu project
4,787 1
vue component system
Install
npm install @open-xamu-co/ui-nuxt
Latest Version:4.0.0
Vue:3
License:MIT
Last Updated:Oct 23, 2026
Links: GitHub  ·  npm
Maintainer: vis97c

Xamu UI, Nuxt Module

npm (scoped) CircleCI

npm i @open-xamu-co/ui-nuxt
# or with yarn
yarn add @open-xamu-co/ui-nuxt

Features

  • I18n support
  • Image optimization with nuxt/image

Usage

Add to modules in nuxt.config.ts:

// nuxt.config.ts, basic setup

export default defineNuxtConfig({
	modules: ["@open-xamu-co/ui-nuxt"],
});

Settings

// nuxt.config.ts, example configuration

export default defineNuxtConfig({
	modules: ["@open-xamu-co/ui-nuxt"],
	xamu: {
		lang: "es",
		country: "co",
	},
});
Name Type Default Description
webComponents boolean false Use web components
globalComponents boolean | tComponent[] true Register all or specific components globally. If true, all components will be registered globally. If an array is provided, only the components specified in the array will be registered globally.
componentPrefix string "xamu" Components prefix. The default value is "xamu".
routerComponent ComponentType | string NuxtLink component from "nuxt" Router component. If a router is used, this component is required for buttons to work.
imageComponent ComponentType | string NuxtImg component from "nuxt/image" Image component. This is an optional image optimization component.
imageHosts string[] [] Hosts that contain images. Any URLs within these hosts will be treated as images.
lang "kr" | "pt" | "nl" | "hr" | "fa" | "de" | "es" | "en" | "fr" | "ja" | "it" | "cn" | "tr" "en" The locale language code. The default value is en (English).
locale tPluginLocale {} en locale from "@open-xamu-co/ui-common-helpers/en" Global locale values. You can implement your own or use the ones provided by @open-xamu-co/ui-common-helpers/locale. The default value is en (English).
mediaQueryPixels { laptop?: number; tablet?: number; mobile?: number; } { laptop: 1080; tablet: 768; mobile: 576; } Object containing the media query limits (in pixels) for laptop, tablet, and mobile devices.
swal { overrides?: SweetAlertOptions; preventOverrides?: SweetAlertOptions; loaderOverrides?: SweetAlertOptions; } {} Swal defaults from "@open-xamu-co/ui-common-helpers/swal" Object containing the overrides for the swal library.
country string undefined ISO 2 code for the default country. When a country is provided, forms will omit the country field.
disableAutoAnimate boolean false A boolean value indicating whether to disable automatic animations.
fontAwesomePro boolean false A boolean value indicating whether to use the Pro version of Font Awesome (regular and light styles).
first number 10 The default pagination limit.

Used types can be imported from @open-xamu-co/ui-common-types or @open-xamu-co/ui-common-enums

Development

# run before development
$ yarn build
# or from the root
$ yarn p:nuxt build

preserveSymlinks could break the module

License

MIT

Related Packages

system-front

总模块前台组件

1,511
system
@open-xamu-co/ui-components-vue

Vue component system for the xamu project

13,558 1
component system vue
@zoov/design-system

Vue implementation of the Zoov Design System

1,500 0
system vue design zoov
wbu-design-system

WhereBy.Design is the nascent design system for WhereBy.Us

32,283
system vue design design system vue.js
@hyone-labs/aurora-vue

Aurora-Vue is UI - Library write in Vue.js

818 2
system vue design lib ui

Version History

Version Released Vue License
4.0.0 ^3.0 MIT
3.1.0 ^3.0 MIT
3.0.0 ^3.0 MIT
2.1.3 ^3.0 MIT
2.1.2 ^3.0 MIT
Pre-releases (33)
Version Released Vue License
4.0.0-next.11 ^3.0 MIT
4.0.0-next.10 ^3.0 MIT
4.0.0-next.9 ^3.0 MIT
4.0.0-next.8 ^3.0 MIT
4.0.0-next.7 ^3.0 MIT