teamculture-ui-components

teamculture-ui-components

Requirements

• Node v14.x.x (make sure that you are using the correct node version)

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Getting started with Lib

Import "styles.scss" from lib

~teamculture-ui-components/src/styles/styles.scss

Development

Creating components

It's recommended to always create components using componentsBaseOptions. To ensure that all components will have default default behaviours (example: i18n texts)

<script>
import { componentsBaseOptions } from '@/helpers/componentsBaseOptions'

export default {
  ...componentsBaseOptions,
  name: 'your-component',
}
</script>

Document with storybook

This project was created to share helpers and components for other modules for all the ecosystem for team culture.
Always try to document all the behaviours, variations and possible interactions for components that you're creating to other developers can understand how your component can be used for these expected situations.
To do this, create a .stories.js file of your component.