Assets

Assets can be included per component or shared in a component pack. Assets are additional files that should be deployed when a project is published. They are not processed in any way and are simply copied during publish.

Directory structure

All assets should be placed inside a directory named page and will be deployed once to the page's files directory during publish. Here's an example showing where to place the snowstorm.js file.

components
    com.domain.weatherpack.snowmachine
        assets
            page
                snowstorm.js

Currently, page is the only area currently supported. If you need to deploy assets to another area, please visit the forum and let us know.

Usage

To link to an asset in a single component you'll need to do the following;

1. Use the {{assetPath}} macro inside of the index.html Template file. If you need the include to appear in the head (or other areas) of the page you can use the Portal Function.

@portal(headEnd)
    <script src="{{assetPath}}/snowstorm.js"></script>
@endportal

1. Include the following code in the hooks.js to return the assetPath to the page template:

const transformHook = (rw) => {

	// Extract the slider property
	const { assetPath } = rw.component;

	// Set slider and message properties in our template data
	rw.setProps({
		assetPath
	});
}

exports.transformHook = transformHook;