Distribution Manifest
A client code distribution is a packaged collection of files that must be deployed together to implement your custom page functionality. The distribution is uploaded as a ZIP file containing your code and a manifest file.
Distribution Manifest
Section link for Distribution ManifestEvery distribution requires a distribution-manifest.json file at the root of the ZIP package that defines the distribution metadata.
Schema Reference
Section link for Schema Reference| Property | Type | Required | Description |
|---|---|---|---|
name | String | Yes | Distribution identifier. Must be unique and end with __c |
pages | Array | Yes | Array of Custom Page definitions |
pages[].name | String | Yes | Page identifier. Must be unique and end with __c |
pages[].file | String | Yes | Path to the page's JavaScript file |
pages[].export | String | No | Export name. Defaults to "default" if omitted |
stylesheets | Array | No | Paths to CSS files to attach to the document |
Example Configuration
Section link for Example Configuration{
"name": "sample_distribution__c",
"pages": [
{
"name": "hello_world__c",
"file": "dist/hello-world.js"
},
{
"name": "my_page__c",
"file": "dist/my-page.js",
"export": "mypage"
}
],
"stylesheets": [
"styles/normalize.css",
"styles/styles.css"
]
}This example:
- Defines a distribution named
sample_distribution__c - Includes two pages:
hello_world__cusing the default exportmy_page__cusing a named exportmypage
- Attaches two stylesheets to the document