aem-react-js

AEM React integration module

This npm module is required by the AEM React Integration project. This library is written in TypeScript.

Documentation

The combined documentation for this javascript subproject and the main AEM packages have moved to aem-react.

Browser compatibility

This library uses the following new features:

function.name (compatibility)

Please use a polyfill.

window.fetch (caniuse)

Pass an object with method fetch() to ClientSling constructor or use a polyfill.

Promise (caniuse)

Please use a polyfill.

Development

Linting the commit message and the sources

node run lint

Checking the formatting of the sources

node run check

Compiling the sources

node run compile

Dependencies: node run lint, node run check

Running the unit tests

node test

Dependencies: node run compile

Formatting the sources

node run format

Committing a new change

npm run cz

Releasing a new version

node run release

This script does the following:

1. bumps the version in package.json (based on your commit history)
2. uses conventional-changelog to update CHANGELOG.md
3. commits package.json and CHANGELOG.md
4. tags a new release

Dependencies: node run test

Publishing a new release

git push --follow-tags origin master && npm publish