Documentation v8.2.8

Downloads Preview

Assets

All bundled assets are located in the folder starterkit/lib/assets and you can include the static js, css and media files.

By default, each controller will include all helper functions. These helpers are only accessible on the controller through helpers variable.

This is an example to add a single custom javascript file from the assets folder. The path is point to the assets folder.

helpers.addJavascriptFile('js/custom/intro.js')

This is an example to add a single custom css file from the assets folder.

helpers.addCssFile('plugins/custom/cookiealert/cookiealert.bundle.css')

Here is the example to add single vendor. Refer to config/settings.yml file in KT_THEME_VENDORS and you can find the vendor name.

helpers.addVendor('datatables')

This is an example to add multiple vendors.

helpers.addVendors(['formrepeater', 'fullcalendar'])

Before running the application we need to build theme assets:

Start a command prompt window or terminal and change directory to starterkit/_keenthemes/tools
```
cd starterkit/_keenthemes/tools
```
Install dependencies with either one, yarn or npm:
```
yarn install
```
You can use either one.
```
npm install
```
This command will fetch all dependencies listed in starterkit/_keenthemes/tools/package.json and place them into _keenthemes/tools/node_modules folder.
You can use Gulp or Webpack commands to bundle theme assets. The below command will compile all the assets(sass, js, media) to starterkit/assets folder:
For gulp use command:
```
gulp
```
For webpack use command:
```
npm run build
```
Note on the package.json file. This step is very important for Webpack in Metronic template. The default package.json works for Gulp. To make it work for Webpack, you have to modify tools/package.json and remove "type": "module". Otherwise, it will cause compilation error when running the build command.