utils/parsedimensionwithunit

module

Type Definitions

Functions

tryCastDimensionsToUnit( parentDimensionPx, dimension, targetUnit ) → DimensionWithUnit
internal

Converts dimension between px -> % and % -> px.
See source (with github icon)
Parameters
parentDimensionPx: number
Dimension of parent element that contains measured element.
dimension: DimensionWithUnit
Measured element dimension.
targetUnit: string
Target unit for conversion.
Returns
DimensionWithUnit
Casted dimension.
tryParseDimensionWithUnit( dimension ) → DimensionWithUnit | null
internal
module:utils/parsedimensionwithunit~tryParseDimensionWithUnit
Parses provided string with dimension value and returns extracted numeric value and unit.
```
* If non-string dimension is passed then `null` value is returned.
* If unit is missing then `null` is returned.
* If numeric value part of string is not a number then `null` is returned.
```
Copy code
Example: "222px" => { value: 222, unit: "px" } "99%" => { value: 99, unit: "%" }
See source (with github icon)
Parameters
dimension: string | null | undefined
Unsafe string with dimension.
Returns
DimensionWithUnit | null
Parsed dimension with extracted numeric value and units.