@ni/nimble-components 21.0.4 → 21.1.0

package/dist/esm/table-column/number-text/models/number-text-unit-format.js

@@ -0,0 +1,82 @@
+import { UnitFormat } from '../../../utilities/unit-format/unit-format';
+import { passthroughUnitScale } from '../../../utilities/unit-format/unit-scale/passthrough-unit-scale';
+import { NumberTextFormat } from '../types';
+import { DefaultUnitFormat } from '../../../utilities/unit-format/default-unit-format';
+import { DecimalUnitFormat } from '../../../utilities/unit-format/decimal-unit-format';
+/**
+ * Format for numbers (with optional units) in a number-text table column.
+ */
+export class NumberTextUnitFormat extends UnitFormat {
+    constructor(locale, options) {
+        super();
+        this._resolvedOptions = this.resolveOptions(options);
+        this.resolvedUnitFormat = this.resolveUnitFormat(locale, this._resolvedOptions);
+    }
+    resolvedOptions() {
+        return { ...this._resolvedOptions };
+    }
+    optionsMatch(targetOptions) {
+        const targetResolvedOptions = this.resolveOptions(targetOptions);
+        return (this._resolvedOptions.decimalDigits
+            === targetResolvedOptions.decimalDigits
+            && this._resolvedOptions.decimalMaximumDigits
+                === targetResolvedOptions.decimalMaximumDigits
+            && this._resolvedOptions.numberTextFormat
+                === targetResolvedOptions.numberTextFormat
+            && this._resolvedOptions.unitScale === targetResolvedOptions.unitScale);
+    }
+    tryFormat(number) {
+        return this.resolvedUnitFormat.format(number);
+    }
+    resolveUnitFormat(locale, options) {
+        const { numberTextFormat, decimalMaximumDigits, decimalDigits, unitScale } = options;
+        if (numberTextFormat === NumberTextFormat.default) {
+            return new DefaultUnitFormat(locale, {
+                unitScale
+            });
+        }
+        if (typeof decimalDigits === 'number') {
+            return new DecimalUnitFormat(locale, {
+                minimumFractionDigits: decimalDigits,
+                maximumFractionDigits: decimalDigits,
+                unitScale
+            });
+        }
+        return new DecimalUnitFormat(locale, {
+            minimumFractionDigits: 0,
+            maximumFractionDigits: decimalMaximumDigits,
+            unitScale
+        });
+    }
+    resolveOptions(options) {
+        if (!options || options.numberTextFormat === NumberTextFormat.default) {
+            return {
+                numberTextFormat: NumberTextFormat.default,
+                decimalDigits: undefined,
+                decimalMaximumDigits: undefined,
+                unitScale: options?.unitScale ?? passthroughUnitScale
+            };
+        }
+        const hasDecimalDigits = typeof options.decimalDigits === 'number';
+        const hasDecimalMaximumDigits = typeof options.decimalMaximumDigits === 'number';
+        if (hasDecimalDigits && hasDecimalMaximumDigits) {
+            throw new Error('decimalDigits and decimalMaximumDigits are mutually exclusive. Do not specify both.');
+        }
+        if (!hasDecimalDigits && !hasDecimalMaximumDigits) {
+            return {
+                numberTextFormat: NumberTextFormat.decimal,
+                decimalDigits: NumberTextUnitFormat.defaultDecimalDigits,
+                decimalMaximumDigits: undefined,
+                unitScale: options.unitScale ?? passthroughUnitScale
+            };
+        }
+        return {
+            numberTextFormat: NumberTextFormat.decimal,
+            decimalDigits: options.decimalDigits,
+            decimalMaximumDigits: options.decimalMaximumDigits,
+            unitScale: options.unitScale ?? passthroughUnitScale
+        };
+    }
+}
+NumberTextUnitFormat.defaultDecimalDigits = 2;
+//# sourceMappingURL=number-text-unit-format.js.map

package/dist/esm/table-column/number-text/models/number-text-unit-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"number-text-unit-format.js","sourceRoot":"","sources":["../../../../../src/table-column/number-text/models/number-text-unit-format.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,UAAU,EAEb,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kEAAkE,CAAC;AACxG,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAC;AAUvF;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,UAAU;IAKhD,YAAmB,MAAc,EAAE,OAAqC;QACpE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,CAC5C,MAAM,EACN,IAAI,CAAC,gBAAgB,CACxB,CAAC;IACN,CAAC;IAEe,eAAe;QAC3B,OAAO,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACxC,CAAC;IAEM,YAAY,CAAC,aAA2C;QAC3D,MAAM,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACjE,OAAO,CACH,IAAI,CAAC,gBAAgB,CAAC,aAAa;gBAC3B,qBAAqB,CAAC,aAAa;eACxC,IAAI,CAAC,gBAAgB,CAAC,oBAAoB;oBACrC,qBAAqB,CAAC,oBAAoB;eAC/C,IAAI,CAAC,gBAAgB,CAAC,gBAAgB;oBACjC,qBAAqB,CAAC,gBAAgB;eAC3C,IAAI,CAAC,gBAAgB,CAAC,SAAS,KAAK,qBAAqB,CAAC,SAAS,CACzE,CAAC;IACN,CAAC;IAEkB,SAAS,CAAC,MAAc;QACvC,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAEO,iBAAiB,CACrB,MAAc,EACd,OAA4C;QAE5C,MAAM,EACF,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACZ,GAAG,OAAO,CAAC;QAEZ,IAAI,gBAAgB,KAAK,gBAAgB,CAAC,OAAO,EAAE;YAC/C,OAAO,IAAI,iBAAiB,CAAC,MAAM,EAAE;gBACjC,SAAS;aACZ,CAAC,CAAC;SACN;QACD,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACnC,OAAO,IAAI,iBAAiB,CAAC,MAAM,EAAE;gBACjC,qBAAqB,EAAE,aAAa;gBACpC,qBAAqB,EAAE,aAAa;gBACpC,SAAS;aACZ,CAAC,CAAC;SACN;QACD,OAAO,IAAI,iBAAiB,CAAC,MAAM,EAAE;YACjC,qBAAqB,EAAE,CAAC;YACxB,qBAAqB,EAAE,oBAAoB;YAC3C,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAEO,cAAc,CAClB,OAAqC;QAErC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,gBAAgB,KAAK,gBAAgB,CAAC,OAAO,EAAE;YACnE,OAAO;gBACH,gBAAgB,EAAE,gBAAgB,CAAC,OAAO;gBAC1C,aAAa,EAAE,SAAS;gBACxB,oBAAoB,EAAE,SAAS;gBAC/B,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,oBAAoB;aACxD,CAAC;SACL;QACD,MAAM,gBAAgB,GAAG,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,CAAC;QACnE,MAAM,uBAAuB,GAAG,OAAO,OAAO,CAAC,oBAAoB,KAAK,QAAQ,CAAC;QACjF,IAAI,gBAAgB,IAAI,uBAAuB,EAAE;YAC7C,MAAM,IAAI,KAAK,CACX,qFAAqF,CACxF,CAAC;SACL;QACD,IAAI,CAAC,gBAAgB,IAAI,CAAC,uBAAuB,EAAE;YAC/C,OAAO;gBACH,gBAAgB,EAAE,gBAAgB,CAAC,OAAO;gBAC1C,aAAa,EAAE,oBAAoB,CAAC,oBAAoB;gBACxD,oBAAoB,EAAE,SAAS;gBAC/B,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,oBAAoB;aACvD,CAAC;SACL;QACD,OAAO;YACH,gBAAgB,EAAE,gBAAgB,CAAC,OAAO;YAC1C,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;YAClD,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,oBAAoB;SACvD,CAAC;IACN,CAAC;;AAhGuB,yCAAoB,GAAG,CAAC,CAAC"}

package/dist/esm/utilities/unit-format/decimal-unit-format.d.ts

@@ -1,10 +1,9 @@
 import { UnitFormat, UnitFormatOptions } from './unit-format';
-import type { UnitScale } from './unit-scale/unit-scale';
 interface DecimalUnitFormatOptions extends UnitFormatOptions {
     minimumFractionDigits?: number;
     maximumFractionDigits?: number;
-    unitScale?: UnitScale;
 }
+declare type ResolvedDecimalUnitFormatOptions = Required<DecimalUnitFormatOptions>;
 /**
  * Format for decimal numbers with units.
  */
@@ -15,7 +14,7 @@ export declare class DecimalUnitFormat extends UnitFormat<DecimalUnitFormatOptio
     private readonly scaledUnitFormatters;
     private readonly tenPowDecimalDigits;
     constructor(locale: string, { minimumFractionDigits, maximumFractionDigits, unitScale }?: DecimalUnitFormatOptions);
-    resolvedOptions(): Required<DecimalUnitFormatOptions>;
+    resolvedOptions(): ResolvedDecimalUnitFormatOptions;
     protected tryFormat(number: number): string;
     private willRoundToZero;
 }

package/dist/esm/utilities/unit-format/default-unit-format.d.ts

@@ -1,4 +1,7 @@
 import { UnitFormat, UnitFormatOptions } from './unit-format';
+interface DefaultUnitFormatOptions extends UnitFormatOptions {
+}
+declare type ResolvedDefaultUnitFormatOptions = Required<DefaultUnitFormatOptions>;
 /**
  * Format for numbers with units to show in a tabular form.
  * Large and tiny numbers are shown exponentially and the rest as decimal.
@@ -14,8 +17,9 @@ export declare class DefaultUnitFormat extends UnitFormat {
     private readonly leadingZeroScaledUnitFormatters;
     private readonly exponentialIntlNumberFormatOptions;
     private readonly exponentialScaledUnitFormatter;
-    constructor(locale: string, { unitScale }?: UnitFormatOptions);
-    resolvedOptions(): Required<UnitFormatOptions>;
+    constructor(locale: string, { unitScale }?: DefaultUnitFormatOptions);
+    resolvedOptions(): ResolvedDefaultUnitFormatOptions;
     protected tryFormat(number: number): string;
     private resolveNumberStyle;
 }
+export {};

package/dist/esm/utilities/unit-format/default-unit-format.js.map

@@ -1 +1 @@
-{"version":3,"file":"default-unit-format.js","sourceRoot":"","sources":["../../../../src/utilities/unit-format/default-unit-format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAqB,MAAM,eAAe,CAAC;AAG9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAI3E;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAgD7C,YACI,MAAc,EACd,EAAE,SAAS,GAAG,oBAAoB,KAAwB;QACtD,SAAS,EAAE,oBAAoB;KAClC;QAED,KAAK,EAAE,CAAC;QAvCZ,iGAAiG;QAChF,mCAA8B,GAA6B;YACxE,wBAAwB,EAAE,iBAAiB,CAAC,aAAa;YACzD,WAAW,EAAE,IAAI;SACpB,CAAC;QAEe,gCAA2B,GAAG,IAAI,GAAG,EAGnD,CAAC;QAEJ,8FAA8F;QAC9F,4FAA4F;QAC5F,kDAAkD;QACjC,uCAAkC,GAA6B;YAC5E,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,GAAG,CAAC;YAC1D,WAAW,EAAE,IAAI;SACpB,CAAC;QAEe,oCAA+B,GAAG,IAAI,GAAG,EAGvD,CAAC;QAEJ,mGAAmG;QACnG,6FAA6F;QAC5E,uCAAkC,GAA6B;YAC5E,wBAAwB,EAAE,iBAAiB,CAAC,aAAa;YACzD,QAAQ,EAAE,YAAY;SACzB,CAAC;QAWE,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,oBAAoB,EAAE;YAC/C,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAChC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,uBAAuB,CAAC;gBACzB,MAAM;gBACN,uBAAuB,EAAE,IAAI,CAAC,8BAA8B;aAC/D,CAAC,CACL,CAAC;YACF,IAAI,CAAC,+BAA+B,CAAC,GAAG,CACpC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,uBAAuB,CAAC;gBACzB,MAAM;gBACN,uBAAuB,EACnB,IAAI,CAAC,kCAAkC;aAC9C,CAAC,CACL,CAAC;SACL;QACD,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAC,cAAc,CAAC,uBAAuB,CAAC;YACnF,MAAM;YACN,uBAAuB,EAAE,IAAI,CAAC,kCAAkC;SACnE,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAEe,eAAe;QAC3B,OAAO;YACH,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC;IACN,CAAC;IAES,SAAS,CAAC,MAAc;QAC9B,2BAA2B;QAC3B,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAEnD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAEjF,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACzD,QAAQ,WAAW,EAAE;YACjB,KAAK,SAAS,CAAC,CAAC;gBACZ,MAAM,mBAAmB,GAAG,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAC5D,UAAU,CAAC,WAAW,CACxB,CAAC;gBACH,OAAO,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;aAClD;YACD,KAAK,aAAa,CAAC,CAAC;gBAChB,MAAM,mBAAmB,GAAG,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAChE,UAAU,CAAC,WAAW,CACxB,CAAC;gBACH,OAAO,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;aAClD;YACD,KAAK,aAAa,CAAC,CAAC;gBAChB,MAAM,mBAAmB,GAAG,IAAI,CAAC,8BAA8B,CAAC;gBAChE,OAAO,mBAAmB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;aACvD;YACD;gBACI,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACzD;IACL,CAAC;IAEO,kBAAkB,CAAC,MAAc;QACrC,IAAI,MAAM,KAAK,CAAC,EAAE;YACd,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IACI,aAAa,IAAI,iBAAiB,CAAC,qBAAqB;eACrD,aAAa,GAAG,iBAAiB,CAAC,qBAAqB,EAC5D;YACE,OAAO,aAAa,CAAC;SACxB;QACD,0HAA0H;QAC1H,+HAA+H;QAC/H,2DAA2D;QAC3D,IAAI,aAAa,GAAG,CAAC,EAAE;YACnB,OAAO,aAAa,CAAC;SACxB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;;AApID,4EAA4E;AACpD,+BAAa,GAAG,CAAC,CAAC;AAE1C,wFAAwF;AACxF,0FAA0F;AAC1F,yEAAyE;AACjD,uCAAqB,GAAG,QAAQ,CAAC;AAEzD,uFAAuF;AACvF,yBAAyB;AACD,uCAAqB,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"default-unit-format.js","sourceRoot":"","sources":["../../../../src/utilities/unit-format/default-unit-format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAqB,MAAM,eAAe,CAAC;AAG9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAS3E;;;GAGG;AACH,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IAgD7C,YACI,MAAc,EACd,EAAE,SAAS,GAAG,oBAAoB,KAA+B;QAC7D,SAAS,EAAE,oBAAoB;KAClC;QAED,KAAK,EAAE,CAAC;QAvCZ,iGAAiG;QAChF,mCAA8B,GAA6B;YACxE,wBAAwB,EAAE,iBAAiB,CAAC,aAAa;YACzD,WAAW,EAAE,IAAI;SACpB,CAAC;QAEe,gCAA2B,GAAG,IAAI,GAAG,EAGnD,CAAC;QAEJ,8FAA8F;QAC9F,4FAA4F;QAC5F,kDAAkD;QACjC,uCAAkC,GAA6B;YAC5E,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,GAAG,CAAC;YAC1D,WAAW,EAAE,IAAI;SACpB,CAAC;QAEe,oCAA+B,GAAG,IAAI,GAAG,EAGvD,CAAC;QAEJ,mGAAmG;QACnG,6FAA6F;QAC5E,uCAAkC,GAA6B;YAC5E,wBAAwB,EAAE,iBAAiB,CAAC,aAAa;YACzD,QAAQ,EAAE,YAAY;SACzB,CAAC;QAWE,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,oBAAoB,EAAE;YAC/C,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAChC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,uBAAuB,CAAC;gBACzB,MAAM;gBACN,uBAAuB,EAAE,IAAI,CAAC,8BAA8B;aAC/D,CAAC,CACL,CAAC;YACF,IAAI,CAAC,+BAA+B,CAAC,GAAG,CACpC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,uBAAuB,CAAC;gBACzB,MAAM;gBACN,uBAAuB,EACnB,IAAI,CAAC,kCAAkC;aAC9C,CAAC,CACL,CAAC;SACL;QACD,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAC,cAAc,CAAC,uBAAuB,CAAC;YACnF,MAAM;YACN,uBAAuB,EAAE,IAAI,CAAC,kCAAkC;SACnE,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAEe,eAAe;QAC3B,OAAO;YACH,SAAS,EAAE,IAAI,CAAC,SAAS;SAC5B,CAAC;IACN,CAAC;IAES,SAAS,CAAC,MAAc;QAC9B,2BAA2B;QAC3B,MAAM,gBAAgB,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAEnD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAEjF,MAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACzD,QAAQ,WAAW,EAAE;YACjB,KAAK,SAAS,CAAC,CAAC;gBACZ,MAAM,mBAAmB,GAAG,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAC5D,UAAU,CAAC,WAAW,CACxB,CAAC;gBACH,OAAO,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;aAClD;YACD,KAAK,aAAa,CAAC,CAAC;gBAChB,MAAM,mBAAmB,GAAG,IAAI,CAAC,+BAA+B,CAAC,GAAG,CAChE,UAAU,CAAC,WAAW,CACxB,CAAC;gBACH,OAAO,mBAAmB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;aAClD;YACD,KAAK,aAAa,CAAC,CAAC;gBAChB,MAAM,mBAAmB,GAAG,IAAI,CAAC,8BAA8B,CAAC;gBAChE,OAAO,mBAAmB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;aACvD;YACD;gBACI,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;SACzD;IACL,CAAC;IAEO,kBAAkB,CAAC,MAAc;QACrC,IAAI,MAAM,KAAK,CAAC,EAAE;YACd,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvC,IACI,aAAa,IAAI,iBAAiB,CAAC,qBAAqB;eACrD,aAAa,GAAG,iBAAiB,CAAC,qBAAqB,EAC5D;YACE,OAAO,aAAa,CAAC;SACxB;QACD,0HAA0H;QAC1H,+HAA+H;QAC/H,2DAA2D;QAC3D,IAAI,aAAa,GAAG,CAAC,EAAE;YACnB,OAAO,aAAa,CAAC;SACxB;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;;AApID,4EAA4E;AACpD,+BAAa,GAAG,CAAC,CAAC;AAE1C,wFAAwF;AACxF,0FAA0F;AAC1F,yEAAyE;AACjD,uCAAqB,GAAG,QAAQ,CAAC;AAEzD,uFAAuF;AACvF,yBAAyB;AACD,uCAAqB,GAAG,QAAQ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ni/nimble-components",
-  "version": "21.0.4",
+  "version": "21.1.0",
   "description": "Styled web components for the NI Nimble Design System",
   "scripts": {
     "build": "npm run generate-icons && npm run build-components && npm run bundle-components && npm run generate-scss && npm run build-storybook",