Developing with ENgrid

Upgrading from engrid-common

The ENgrid Scripts package got renamed fom @4site/engrid-common to @4site/engrid-scripts. If you are upgrading from an older version, you will need to update your package.json file to reflect the new package name.

Upgrading the core ENgrid Scripts Package

First, you will need to remove the old package and install the new one:

npm uninstall @4site/engrid-common
npm install @4site/engrid-scripts --save-dev

Next, you will need to search your ENgrid Theme for any references to @4site/engrid-common and update them to @4site/engrid-scripts.

You should know!

If you want to get the latest ENgrid Scripts package when using the npm run rebuild command, you will need to update your package.json file to add an "*" to the version number like so:

"@4site/engrid-scripts": "*"

Once you have replaced all references to @4site/engrid-common with @4site/engrid-scripts, you can run the following command to rebuild your assets:

npm run rebuild

If you need to use a specific version of the ENgrid Scripts package, you can run:

npm uninstall @4site/engrid-styles @4site/engrid-scripts
npm install @4site/engrid-styles@your-version-number
npm install @4site/engrid-scripts@your-version-number

You can always view your current ENgrid version in the banner at the start of your compiled JS and CSS assets.

If you want to know what's new in the latest version of ENgrid, you can check out the release notes.

Previous
Submitting ENgrid Upstream Pull Requests