Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@activeprospect/integration-components
Advanced tools
A Vue component library for LeadConduit integrations
Readme
A Vue component library for LeadConduit integrations.
[!IMPORTANT]
Themaster
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 thevue2
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 thevue2
branch when running the "Publish to npm registry" GitHub Action
How to migrate an integration to Vue 3:
npm i --save @activeprospect/integration-components@5
npm i --save-dev @activeprospect/integration-dev-dependencies@2
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>
Run Storybook to see them all, and their detailed docs.
Navigation
- footer with navigation (Confirm, Prev, & Cancel)To test, run npm run storybook
in one window, and npm run cypress:run
in another.
This library uses the following technologies:
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 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 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 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
FAQs
A Vue component library for LeadConduit integrations
The npm package @activeprospect/integration-components receives a total of 2,258 weekly downloads. As such, @activeprospect/integration-components popularity was classified as popular.
We found that @activeprospect/integration-components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 32 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.