@activeprospect/integration-components

leadconduit-integration-components

A Vue component library for LeadConduit integrations.

Migrating to Vue 3

[!IMPORTANT]
The master branch should be used for all Vue 3 development. Releases that depened on Vue3 are versioned 5.x and above.

The vue2 branch is a long-lived branch intended to facilitate development of versions of this library which depend on Vue2 and Vue3 simultaneously. Releases that depend on Vue 3 must be merged into the vue2 branch, and released under version 4.x.x. If new versions of this library need to be released with a Vue2 dependency, you must select the vue2 branch when running the "Publish to npm registry" GitHub Action

How to migrate an integration to Vue 3:

1. Install the latest version of this library, at least 5.x: npm i --save @activeprospect/integration-components@5
2. Install the latest version of integration-dev-dependencies, at least 2.x: npm i --save-dev @activeprospect/integration-dev-dependencies@2
3. Update the integration's dependencies, and make the required changes to the app creation, store creation, and router configuration. See leadconduit-trustedform #108 for an example of the required changes to migrate to Vue 3.

Usage

In your integration's rich UI (RUI) code, add these components inside the <script> tag of your .vue files:

<script>
import { Navigation } from '@activeprospect/integration-components';
// etc.

And then the components can be used in the <template>:

    <section> etc. </section>
    <Navigation :onConfirm="save"></Navigation>

Components

Run Storybook to see them all, and their detailed docs.

• Navigation - footer with navigation (Confirm, Prev, & Cancel)

Testing

To test, run npm run storybook in one window, and npm run cypress:run in another.

Implementation

This library uses the following technologies:

• Vue to write the components
• Rollup for bundling the Vue files
• Storybook as a development and documentation framework
• Cypress as a testing suite

Vue

All Vue components are stored in /src/components. To make sure each Vue component is picked up by Rollup, it must be added to the /src/index.js file like so:

export { default as Navigation } from './Navigation.vue';

Rollup

Rollup bundles our Vue components for distribution. The Rollup config file is located in /build.

To run Rollup and build the Vue components, simply run npm run build. This will take all the Vue components listed in /src/index.js and compile them, outputting the result into /dist.

Storybook

Storybook is used as a development and documentation framework. To read more on Storybook, you can find their docs here. Storybook stories are stored in /src/stories, and the Storybook configuration files are stored in /storybook.

To use storybook, you can run npm run storybook. This will start the storybook server and open a new browser window to localhost:6006. In that new window, you will be able to see the Storybook stories. Storybook does support hot reloading, so any changes to the Vue files should be automatically reflected.

Cypress

Cypress is used to test our components to ensure changes don't break critical functionality. Cypress runs its tests using the Storybook server, so Storybook must be running on port 6006 for the tests to not timeout.

There are two methods to run Cypress tests.

npm run cypress:open - Opens the Cypress GUI

npm run cypress:run - runs the test in the terminal

Cypress tests are located in /cypress/integration. To view more on Cypress, you can find their docs here