Andy Stark 7fe066b068 [ADF-4249] Updates for doc review (#4454)
* [ADF-4249] Updates for doc review

* [ADF-4249] Clarified text slightly
2019-03-19 15:35:59 +00:00

1.4 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
About Component v2.4.0 Experimental 2019-03-19

About Component

Shows a general version and status overview of the installed ADF library.

Basic Usage

With default input values

<adf-about></adf-about>

With custom input values:

<adf-about
    githubUrlCommitAlpha="https://github.com/Alfresco/alfresco-ng2-components/commits/"
    showExtensions="false"
    regexp="^(@alfresco)"
></adf-about>

Class members

Properties

Name Type Default value Description
githubUrlCommitAlpha string Commit corresponding to the version of ADF to be used.
regexp string "^(@alfresco)" Regular expression for filtering dependencies packages.
showExtensions boolean true Toggles showing/hiding of extensions block.

Details

Use this component to get a general overview of the version of ADF installed and the status of the Content service and Process service.

Note that at the moment this component is mostly for internal use and it requires you to:

  • create a version file : npm list --depth=0 --json=true --prod=true > versions.json
  • provide this version file in the dist folder