Introduction

In this section, you will find the general documentation for the NPM packages within Codey. Before you can install any of these, you first need to follow the installation guide hereopen in new window.

Version tags

Packages can published with 2 different tags:

@latest: latest production version release of a package
@next: pre-release of a package, that will later move to production once QA approved

These tags can be used when installing a codey packages e.g. npm i @xerius/codey-style@next. The @latest tag is the default used by npm.

Vue 2 Support

While we are migrating application to Vue 3, we decided to keep a Vue 2 version of our packages and available. Once migrations are complete, we will deprecate the Vue 2 packages and remove them from the registry.

Packages

The Vue 2 packages names are suffixed with -vue2 and require a separate installation if they are needed.

Update your package.json with the following change to switch to the Vue 2 packages:

"dependencies": {
  - "@xerius/codey-style": "^1.0.0",
  + "@xerius/codey-style-vue2": "^1.0.0"
}

The version numbers of all packages is kept the same and will continue to uphold the semver standard.

Documentation

The documentation for Vue 2 will not be published online. Most features will be directly ported to codey Vue 3 and this documentation will be updated accordingly.

If required, the Vue 2 documentation can be run locally by checking out the vue2 branch of the codey repository and running the following commands:

npm install
npm run app:docs

CDN Resources

The CDN resources for Vue 2 are available at the following location: https://cdn.xerius.be/vue2/

This folder contains the current available resources:

style
cookiebot
hello-customer

# Introduction

# Version tags

# Vue 2 Support

# Packages