@contentful/ecommerce-app-base / Integration
- Integration
- color
- description
- fetchProductPreviews
- isDisabled
- logo
- makeCTA
- name
- openDialog
- parameterDefinitions
- renderDialog
- validateParameters
• color: string
The app's primary color
• description: string
Short description of the app
• fetchProductPreviews: ProductPreviewsFn
Function that returns a list for a given list of skus. The returned value is used to render a product preview.
param List of skus
param App configuration
returns List of Products which is used to render a preview.
• isDisabled: DisabledPredicateFn
Function that should return true when the button should be disabled.
param Currently selected assets
param App configuration
returns true, if the button in the field location should be disabled. false, if the button should be enabled
• logo: string
Path to the app's logo
• makeCTA: MakeCTAFn
Returns the text that is displayed on the button in the field location.
param Type of the field the app is used for.
returns Text that should be displayed on the button
• name: string
Name of the app
• openDialog: OpenDialogFn
Function that gets called when app wants to open a dialog. Should return an updated list of skus as a Promise.
You probably want to call sdk.openCurrentApp.
example
async function openDialog(sdk, currentValue, config) {
return await sdk.dialogs.openCurrentApp({
parameters: { config, currentValue },
});
}param (https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/)
param Array of currently selected skus
param App configuration
returns Promise containing a list of selected assets
• parameterDefinitions: ParameterDefinition[]
Parameter definition which can be customized on the app configuration page and used in the callback functions.
• renderDialog: RenderDialogFn
Function that gets called within the Iframe when the app is rendered in a dialog location.
example
function renderDialog(sdk) {
const config = sdk.parameters.invocation;
const container = document.createElement('div');
container.innerHTML = `<iframe src="https://example.com/dam?folder=${config.folder}" width="400" height="650" style="border:none;"/>`;
document.body.appendChild(container);
}param (https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/)
• validateParameters: ValidateParametersFn
Custom code that validates installation parameters that is run before saving.
param Object containg the entered parameters.
returns string containing an error message. null if the parameters are valid.