PageBuilder Content Integrations
Install npm libraries
In pb-admin root folder run npm install --legacy-peer-deps
Static integrations build
Option 1:
build within the integrations folder: In packages/content-integrations/ folder run npm run build
Option 2:
Build within the pb-admin root: In pb-admin/ run npm run build:integrations
Real time build
In packages/content-integrations run npm run build:watch
Shared components and utilities
These live in the packages/content-integrations/shared/ and consist of the following types of items:
-
components- React components such as checkboxes, selects, etc. -
icons- JSX written SVG icons -
modules- Generic JS functions that can be used across integrations -
services- API calls
Creating new integrations
- Create new folder within
packages/content-integrations/src/folder - Code in here should follow standard ARCXP coding guidelines and practices as a component.
Local development
In a separate terminal go to the folder: packages/content-integrations and run npm run build:watch. This will build the content-integrations package when a change is made in it's structure.
Note: If something doesn't update correctly, delete the folder: packages/content-integrations/dist. Rerun the static build step from above to re-create the dist folder. Alternatively you could also run npm run clean within the packages/content-integrations folder. You may need to restart your pb-admin front end to have it re-detect file changes since the dist folder is what it was aware of.
Publishing your changes
Once you've finished work on your integration and the branch is ready for merging, you will need to update the packages/content-integrations/package.json version number and run an npm publish in that folder to deploy the updated package.
Note: If you have issues publishing, please reach out to the team and someone can help get you set up for this action.
Next, bump the version listed in the pb-admin root package.json to match your newly deployed version and run npm install --legacy-peer-deps to pull it in.