https://github.com/statikbe/repair-components
This package contains Vue components for Repair projects, styled with TailwindCSS.
https://github.com/statikbe/repair-components
tailwindcss vuejs
Last synced: 2 months ago
JSON representation
This package contains Vue components for Repair projects, styled with TailwindCSS.
- Host: GitHub
- URL: https://github.com/statikbe/repair-components
- Owner: statikbe
- Created: 2021-04-30T13:55:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T01:11:37.000Z (over 2 years ago)
- Last Synced: 2025-03-22T03:11:56.891Z (about 1 year ago)
- Topics: tailwindcss, vuejs
- Language: Vue
- Homepage:
- Size: 87.3 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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:
```js
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:
```js
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:
```js
@todo check repmap
```
### Options
You can pass some options:
```js
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](https://statikbe.github.io/repair-components/).
## 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](https://semver.org/) guidelines when doing so!