mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
c2c883885e
* Refactor, Split ADF About component * [ADF-4878] Add documentation * [ADF-4878] Rename Component * [ADF-4878] Implement comments * [ADF-4878] Update documentation for about components
40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
---
|
|
Title: About GitHub Link Component
|
|
Added: v1.0.0
|
|
Status: Experimental
|
|
Last reviewed: 2019-09-09
|
|
---
|
|
|
|
# [About GitHub Link Component](../../../lib/core/about/about-github-link/about-github-link.component.ts "Defined in about-github-link.component.ts")
|
|
|
|
Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application.
|
|
|
|
## Basic Usage
|
|
|
|
With default input values:
|
|
|
|
```html
|
|
<adf-about-github-link></adf-about-github-link>
|
|
```
|
|
|
|
With custom input values:
|
|
|
|
```html
|
|
<adf-about-github-link
|
|
[url]=yourUrl"
|
|
[version]="yourVersion">
|
|
</adf-about-github-link>
|
|
|
|
```
|
|
|
|
### Properties
|
|
|
|
| Name | Type | Default value | Description |
|
|
| ---- | ---- | ------------- | ----------- |
|
|
| url | `string` | | The GitHub commit that corresponds to the version of ADF in use. |
|
|
| version | `string` | "3.x.x" | A number displaying the version of ADF in use. |
|
|
|
|
## Details
|
|
|
|
Use this component to display an overview of the latest GitHub commit and the server settings used by an application.
|