mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2973] Angular pipe to get application configuration settings (#3301)
* app config pipe * update docs
This commit is contained in:
committed by
Eugenio Romano
parent
7afcd24488
commit
b66154773a
@@ -4,7 +4,8 @@
|
||||
"bpmHost": "http://{hostname}:{port}",
|
||||
"contextRootBpm": "activiti-app",
|
||||
"application": {
|
||||
"name": "Alfresco ADF Application"
|
||||
"name": "Alfresco ADF Application",
|
||||
"copyright": "© 2016 - 2018 Alfresco Software, Inc. All Rights Reserved."
|
||||
},
|
||||
"languages": [
|
||||
{
|
||||
|
@@ -52,7 +52,7 @@
|
||||
[disableCsrf]="disableCsrf"
|
||||
[showLoginActions]="showFooter"
|
||||
[showRememberMe]="showFooter"
|
||||
copyrightText="© 2016 Alfresco Software, Inc. All Rights Reserved. (customised text)"
|
||||
copyrightText="{{ 'application.copyright' | adfAppConfig }}"
|
||||
(success)="onLogin($event)"
|
||||
(error)="onError($event)">
|
||||
<div class="mobile-settings">
|
||||
|
40
docs/core/app-config.pipe.md
Normal file
40
docs/core/app-config.pipe.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
Added: v2.4.0
|
||||
Status: Active
|
||||
---
|
||||
|
||||
# App Config Pipe
|
||||
|
||||
Retrieves values from the application configuration file directly.
|
||||
|
||||
## Examples
|
||||
|
||||
```html
|
||||
<adf-login
|
||||
copyrightText="{{ 'application.copyright' | adfAppConfig }}">
|
||||
</adf-login>
|
||||
```
|
||||
|
||||
## Fallback values
|
||||
|
||||
You can use pipe parameters to pass fallback value:
|
||||
|
||||
```html
|
||||
<adf-login
|
||||
copyrightText="{{ 'application.copyright' | adfAppConfig:'Fallback Text' }}">
|
||||
</adf-login>
|
||||
```
|
||||
|
||||
## Chaining with other pipes
|
||||
|
||||
You can also chain values with other pipes, for example `translation` one:
|
||||
|
||||
```html
|
||||
<adf-login
|
||||
copyrightText="{{ 'application.copyright' | adfAppConfig | translate }}">
|
||||
</adf-login>
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
- [App Config service](app-config.service.md)
|
@@ -18,13 +18,20 @@
|
||||
import { HttpClientModule } from '@angular/common/http';
|
||||
import { NgModule } from '@angular/core';
|
||||
import { AppConfigService } from './app-config.service';
|
||||
import { AppConfigPipe } from './app-config.pipe';
|
||||
|
||||
@NgModule({
|
||||
imports: [
|
||||
HttpClientModule
|
||||
],
|
||||
declarations: [
|
||||
AppConfigPipe
|
||||
],
|
||||
providers: [
|
||||
AppConfigService
|
||||
],
|
||||
exports: [
|
||||
AppConfigPipe
|
||||
]
|
||||
})
|
||||
export class AppConfigModule {
|
||||
|
30
lib/core/app-config/app-config.pipe.ts
Normal file
30
lib/core/app-config/app-config.pipe.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
/*!
|
||||
* @license
|
||||
* Copyright 2016 Alfresco Software, Ltd.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import { Pipe, PipeTransform } from '@angular/core';
|
||||
import { AppConfigService } from './app-config.service';
|
||||
|
||||
@Pipe({
|
||||
name: 'adfAppConfig'
|
||||
})
|
||||
export class AppConfigPipe implements PipeTransform {
|
||||
constructor(private config: AppConfigService) {}
|
||||
|
||||
transform(value: string, fallback: any): any {
|
||||
return this.config.get(value, fallback);
|
||||
}
|
||||
}
|
@@ -16,5 +16,6 @@
|
||||
*/
|
||||
|
||||
export * from './app-config.service';
|
||||
export * from './app-config.pipe';
|
||||
|
||||
export * from './app-config.module';
|
||||
|
Reference in New Issue
Block a user