@statikbe/repair-components

repair-components

This package contains Vue components for Repair projects, styled with TailwindCSS.

Installation

Install the package to your Repair project:

yarn add @statikbe/repair-components

Then install the plugin:

import RepairComponents from '@statikbe/repair-components';

Vue.use(RepairComponents);

Make sure to add the vue-i18n instance to your Vue initialization to make translations work:

import { i18n } from '@statikbe/repair-components';

new Vue({
  i18n,
}).$mount('#app');

Alternatively, if using Nuxt, make sure to pass the existing i18n instance from the nuxt-i18n module, will get extended with the necessary translations:

@todo check repmap

Options

You can pass some options:

Vue.use(RepairComponents, {
  i18n, // for Nuxt, see above
  icons: {
    myIcon: '...',
    // key = identifier (as passed to r-icon name prop)
    // value = SVG path "d" attribute as string
  },
});

Documentation

Check out the components and their props at the Storybook documentation.

For developers

Publishing to NPM

First, run yarn build to build this package as a library.

To publish this package to the NPM registry, make sure you are logged in with statikbe credentials (see 1pw) using npm login, then run npx np --no-2fa. Respect the semantic versioning guidelines when doing so!