mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Documentation fixes (#9995)
This commit is contained in:
Denys Vuika
GitHub
@@ -1,40 +0,0 @@
|
||||
---
|
||||
Title: About Application Modules Component
|
||||
Added: v3.5.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-09-09
|
||||
---
|
||||
|
||||
# [About Application Modules Component](lib/core/src/lib/about/about-application-modules/about-application-modules.component.ts "Defined in about-application-modules.component.ts")
|
||||
|
||||
Shows which ADF libraries and plugins an application is using.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
With default input values:
|
||||
|
||||
```html
|
||||
<adf-about-application-modules></adf-about-application-modules>
|
||||
```
|
||||
|
||||
With custom input values:
|
||||
|
||||
```html
|
||||
<adf-about-application-modules
|
||||
[dependencies]="yourDependencies"
|
||||
[showExtensions]="true"
|
||||
[regexp]="^(@alfresco)">
|
||||
</adf-about-application-modules>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| dependencies | `any` | | The dependencies value defined in the package.json |
|
||||
| showExtensions | `boolean` | true | Toggles showing/hiding of extensions block. |
|
||||
| regexp | `string` | "^(@alfresco)" | Regular expression for filtering dependencies packages. |
|
||||
|
||||
## Details
|
||||
|
||||
Use this component to display an overview of the dependencies and plugins used by an application.
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
Title: About GitHub Link Component
|
||||
Added: v3.5.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-09-09
|
||||
---
|
||||
|
||||
# [About GitHub Link Component](../../../lib/core/src/lib/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.
|
||||
@@ -1,22 +0,0 @@
|
||||
---
|
||||
Title: About Product Version Component
|
||||
Added: v3.5.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-09-09
|
||||
---
|
||||
|
||||
# [About Product Version Component](lib/core/src/lib/about/about-product-version/about-product-version.component.ts "Defined in about-product-version.component.ts")
|
||||
|
||||
Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
With default input values:
|
||||
|
||||
```html
|
||||
<adf-about-product-version></adf-about-product-version>
|
||||
```
|
||||
|
||||
## Details
|
||||
|
||||
Use this component to display an overview of which version of Process Services and Content Services an application is running as well as the associated license information. It also displays application status and any modules running.
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
Title: Host settings component
|
||||
Added: v2.0.0
|
||||
Status: Internal
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Host settings component](../../../lib/core/src/lib/settings/host-settings.component.ts "Defined in host-settings.component.ts")
|
||||
|
||||
Validates the URLs for ACS and APS and saves them in the user's local storage
|
||||
|
||||
**Note:** this is an internal component and is not meant to be used in production.
|
||||
|
||||
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-host-settings>
|
||||
</adf-host-settings>
|
||||
```
|
||||
|
||||
```ts
|
||||
@NgModule({
|
||||
providers: [
|
||||
{ provide: AppConfigService, useClass: DebugAppConfigService },
|
||||
]
|
||||
)]
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| providers | `string[]` | | Tells the component which provider options are available. Possible valid values are "ECM" (Content), "BPM" (Process) , "ALL" (Content and Process), 'OAUTH2' SSO. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the user cancels the changes. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the URL is invalid. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<boolean>` | Emitted when the changes are successfully applied. |
|
||||
Reference in New Issue
Block a user