External Components For Sitecore's Content Hub Solution Example

This is a template example to use when building a solution for managing external components inside Sitecore's Content Hub. For more information please visit https://doc.sitecore.com/ch/en/developers/42/cloud-dev/integration-components--external-page-component--overview.html

Installation

npm install

Usage

Build your dist specific components feature

npm run build --component=ComponentFolderName

Watch build while developing

npm run watch --component=ComponentFolderName

Run you dev server

npm run dev --component=ComponentFolderName

How to test in Content Hub

1. Go to page and create external component
2. Edit the component select "From Path"
3. Paste dev server url in box (E.g https://localhost:5173/dist/entitydetails.js)
4. Save and navigate to the page with external component

How to upload bundle as an asset to Content Hub

1. Wait for all the renditions to be processed. You can view their progress on your Background processes page.
2. On the page where your external component is, click the name of the component.
3. On the component detail page, under JS bundle, click From asset.
4. In the drop-down list, click the name of your bundle asset.
5. Click Save.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT