[ADF-4713] Add new DecimalNumber Pipe to transform and localize numbers (#4926)

* [ADF-4713] Add new DecimalNumber Pipe to transform and localize numbers * Unsubscribe from userPreference service * Make Pipe impure * Add documentation in localization page
2025-07-24 17:32:15 +00:00 · 2019-07-18 11:09:50 +01:00
parent 8ee5cd1908
commit a0d4160c11
25 changed files with 457 additions and 66 deletions
--- a/lib/core/pipes/decimal-number.pipe.ts
+++ b/lib/core/pipes/decimal-number.pipe.ts
@@ -0,0 +1,82 @@
+/*!
+ * @license
+ * Copyright 2019 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 { DecimalPipe } from '@angular/common';
+import { Pipe, PipeTransform, OnDestroy } from '@angular/core';
+import { AppConfigService } from '../app-config/app-config.service';
+import { UserPreferencesService, UserPreferenceValues } from '../services/user-preferences.service';
+import { DecimalNumberModel } from '../models/decimal-number.model';
+import { Subject } from 'rxjs';
+import { takeUntil } from 'rxjs/operators';
+
+@Pipe({
+    name: 'adfDecimalNumber',
+    pure: false
+})
+export class DecimalNumberPipe implements PipeTransform, OnDestroy {
+
+    static DEFAULT_LOCALE = 'en-US';
+    static DEFAULT_MIN_INTEGER_DIGITS = 1;
+    static DEFAULT_MIN_FRACTION_DIGITS = 0;
+    static DEFAULT_MAX_FRACTION_DIGITS = 2;
+
+    defaultLocale: string = DecimalNumberPipe.DEFAULT_LOCALE;
+    defaultMinIntegerDigits: number = DecimalNumberPipe.DEFAULT_MIN_INTEGER_DIGITS;
+    defaultMinFractionDigits: number = DecimalNumberPipe.DEFAULT_MIN_FRACTION_DIGITS;
+    defaultMaxFractionDigits: number = DecimalNumberPipe.DEFAULT_MAX_FRACTION_DIGITS;
+
+    onDestroy$: Subject<boolean> = new Subject<boolean>();
+
+    constructor(public userPreferenceService?: UserPreferencesService,
+                public appConfig?: AppConfigService) {
+
+        if (this.userPreferenceService) {
+            this.userPreferenceService.select(UserPreferenceValues.Locale)
+                .pipe(
+                    takeUntil(this.onDestroy$)
+                )
+                .subscribe((locale) => {
+                    if (locale) {
+                        this.defaultLocale = locale;
+                    }
+                });
+        }
+
+        if (this.appConfig) {
+            this.defaultMinIntegerDigits = this.appConfig.get<number>('decimalValues.minIntegerDigits', DecimalNumberPipe.DEFAULT_MIN_INTEGER_DIGITS);
+            this.defaultMinFractionDigits = this.appConfig.get<number>('decimalValues.minFractionDigits', DecimalNumberPipe.DEFAULT_MIN_FRACTION_DIGITS);
+            this.defaultMaxFractionDigits = this.appConfig.get<number>('decimalValues.maxFractionDigits', DecimalNumberPipe.DEFAULT_MAX_FRACTION_DIGITS);
+        }
+    }
+
+    transform(value: any, digitsInfo?: DecimalNumberModel, locale?: string): any {
+        const actualMinIntegerDigits: number = digitsInfo && digitsInfo.minIntegerDigits ? digitsInfo.minIntegerDigits : this.defaultMinIntegerDigits;
+        const actualMinFractionDigits: number = digitsInfo && digitsInfo.minFractionDigits ? digitsInfo.minFractionDigits : this.defaultMinFractionDigits;
+        const actualMaxFractionDigits: number = digitsInfo && digitsInfo.maxFractionDigits ? digitsInfo.maxFractionDigits : this.defaultMaxFractionDigits;
+
+        const actualDigitsInfo = `${actualMinIntegerDigits}.${actualMinFractionDigits}-${actualMaxFractionDigits}`;
+        const actualLocale = locale || this.defaultLocale;
+
+        const datePipe: DecimalPipe = new DecimalPipe(actualLocale);
+        return datePipe.transform(value, actualDigitsInfo);
+    }
+
+    ngOnDestroy(): void {
+        this.onDestroy$.next(true);
+        this.onDestroy$.complete();
+    }
+}