Update README.md

asamuzaK · Dec 16, 2024 · e7a1265 · e7a1265
1 parent 68b1329
commit e7a1265
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -52,6 +52,13 @@ resolves CSS color
       e.g. `customProperty: { '--some-color': '#008000' }`
     * and/or `callback` function to get the value of the custom property,
       e.g. `customProperty: { callback: someDeclaration.getPropertyValue }`
+  * `opt.dimension` **[object][135]?**
+    * dimension, e.g. for converting relative length to pixels
+    * pair of unit and it's value as a number in pixels,
+      e.g. if `1em === 12px`, `1rem === 16px` and `100vw === 1024px`,
+      then `dimension: { em: 12, rem: 16, vw: 10.24 }`
+    * and/or `callback` function to get the value as a number in pixels,
+      e.g. `dimension: { callback: convertUnitToPixel }`
   * `opt.format` **[string][133]?**
     * output format, one of below
       * `computedValue` (default), [computed value][139] of the color