FormatCompositeProps Interface
Defines the units that make up a composite format and their display properties. A composite format allows displaying a single quantity value across multiple units, such as displaying length as "5 feet 6 inches" or angle as "45° 30' 15"".
Properties
| Name | Type | Description | |
|---|---|---|---|
| includeZero Readonly | boolean | undefined | Whether to include unit segments with zero magnitude in the formatted output. | |
| spacer Readonly | string | undefined | Separator character between unit values when formatting composite strings. | |
| units Readonly | FormatUnitSpec[] | Array of units this format is comprised of. |
Defined in
Last Updated: 07 February, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.