housfy-ui-lib

housfy-ui

Created by sfc-init

Local development

npm run dev to view /dev/storyboard.vue content

npm run build to share changes to other local projects

In each project consuming this lib, you can modify package.json, to point your local housfy-ui-lib folder: "housfy-ui-lib": "../PATH-TO-YOUR-housfy-ui-lib"

Publish

First time: Add npm user to your terminal. Ask sergi.rourera@housfy.com for NPM credentials.

1. Increase version at package.json
2. npm run build
3. npm publish

View components

Add components to /dev/storyboard.vue, to view them on browser, after npm run dev.

Share components

Add components to /src/index.ts, to share them with other projects.

CSS classes

To prevent class conflicts with other projects, components have prefixed classes like .h-ui-ppp-vvv, where:

• h-ui stands for housfy-ui
• ppp should be a prop name (like variant on HousfyButton)
• vvv should be a prop value (like secondary on HousfyButton)

SVG

SVG files must be replicated on every project using this library.

HousfySvg component takes path & svg props to get svg full path. For example:

<HousfySvg path="assets/svg" svg="icons/search" /> will import svg from @/src/assets/svg/icons/search.svg