alfresco-ng2-components/docs/core/directives/version-compatibility.directive.md
davidcanonieto 46e4daeef3
[ADF-5158] ECM Version Directive (#5779)
* [ADF-5158] ECM Version Directive

* Update version-compatibility.directive.ts

* Update version-compatibility.directive.ts

* Change name from ecm to acs

* Fix unit tests

* Update docs for Version directive

* Fix unit tests

* Fix unit tests

* Linting

* Update apps-process-cloud.service.spec.ts

* Fix Ecm Service initialization

* Fix unit test

Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
2020-06-23 08:46:17 +01:00

1.6 KiB
Raw Blame History

Version Compatibility Directive

Enables/disables components based on ACS version in use.

Basic usage

<button *adf-acs-version="'6.0.0'">
    My Action
</button>

Class members

Properties

Name Type Default value Description
adf-acs-version string The minimum version required for a given component to work propertly.

Details

Add the directive to a component or HTML element to enable or disable it based on the version of ACS running in the app.

The directive takes the version specified in the html and compares it to the version of Alfresco Content Services running in the app.

This will allow certain features to be only present under specific versions.

Major version

<button *adf-acs-version="'7'">
    My Action
</button>

Major and minor version

<button *adf-acs-version="'6.2'">
    My Action
</button>

Major, minor and patch version

<button *adf-acs-version="'6.0.1'">
    My Action
</button>

It can be set to match major, minor and patches of ACS versions. Fox example, if the version 6 is specifed it will enable the component from 6.0.0 onwards.

If the minimum version required is not matched the component will not be initialized and will disappear from the DOM tree.

Note, if you dont place the * in front, the app wont be able to inject the TemplateRef and ViewContainerRef required for this directive to work.