Search...
Toggle theme

Angular Translate

How to incorporate Angular Translate into your project

Minimum Requirements

Please review our Minimum Requirements to ensure a smooth installation. Then follow 3 easy steps:

  1. Update your package.json
  2. Create or update your .npmrc file
  3. Install & Run!

Detailed Instructions

Substitute the Angular Translate dependencies in your package.json with the following

package.json
{
  "dependencies": {
    "angular-translate": "npm:@neverendingsupport/angularjs-essentials@2.19.1-angular-translate-2.20.4"
  },
  "overrides": {
    "angular-translate": { ".": "npm:@neverendingsupport/angularjs-essentials@2.19.1-angular-translate-2.20.4" }
  }
}

Create an .npmrc file with the following

Replace <NES_ACCESS_TOKEN> with either your access token or a valid email

.npmrc
@neverendingsupport:registry=https://registry.nes.herodevs.com/npm/pkg/
//registry.nes.herodevs.com/npm/pkg/:_authToken=<NES_ACCESS_TOKEN>

Install your dependencies and run the service

.npmrc
npm install

And just like that, you can run your integration tests against AngularJS Translate NES!

Additional Information

Configure DOMPurify

DOMPurify is a DOM-only, super-fast, open source, XSS sanitizer for HTML.

AngularJS Translate NES comes bundled with a version of DOMPurify and uses it to sanitize translation keys that contain HTML. However, it is possible to override the bundled version by providing your own.

AngularJS Translate NES will automatically detect DOMPurify and utilize it as needed. For this to happen, DOMPurify must be available on the window object. There are various ways to achieve this depending on your setup.

Option 1

Add the DOMPurify dependency to your package.json with the following:

package.json
{
   "dependencies": {
      // existing dependencies
      "dompurify": "^3.2.0",
   }
}

Then ensure node_modules/dompurify/dist/purify[.min].js is included in your application, either as a standalone script or in your application bundle.

There are many ways in which dependencies are imported and bundled together in applications. You must ensure that your application makes DOMPurify available on the window object in order for it to work properly. Here is an example of how it could be accomplished within an application that uses Webpack.

webpack.config.js

module.exports = {
  // ...
  plugins: [
    // ...
    new webpack.ProvidePlugin({
      'window.DOMPurify': 'dompurify',
    }),
  ],
};

Option 2

Include DOMPurify from a CDN in your HTML template:

index.html
<html lang="en">
  <head>
    <title>Home</title>
    <!-- ... -->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/dompurify/3.2.0/purify.min.js"></script>
    <!-- ... -->

Direct download URLs

The direct download URL for AngularJS Translate NES is:

PackageURL
angular-translate
2.19.1-angular-translate-2.20.4
Download