@wordpress/components
Version:
UI components for WordPress.
73 lines (72 loc) • 2.3 kB
JavaScript
import memoize from "memize";
import { colord, extend } from "colord";
import namesPlugin from "colord/plugins/names";
// packages/components/src/utils/colors.ts
let colorComputationNode;
extend([namesPlugin]);
/**
* @return The HTML element for color computation.
*/
function getColorComputationNode() {
if (typeof document === "undefined") return;
if (!colorComputationNode) {
const el = document.createElement("div");
el.setAttribute("data-g2-color-computation-node", "");
document.body.appendChild(el);
colorComputationNode = el;
}
return colorComputationNode;
}
/**
* @param value
*
* @return Whether the value is a valid color.
*/
function isColor(value) {
if (typeof value !== "string") return false;
return colord(value).isValid();
}
/**
* Retrieves the computed background color. This is useful for getting the
* value of a CSS variable color.
*
* @param backgroundColor The background color to compute.
*
* @return The computed background color.
*/
function _getComputedBackgroundColor(backgroundColor) {
if (typeof backgroundColor !== "string") return "";
if (isColor(backgroundColor)) return backgroundColor;
if (!backgroundColor.includes("var(")) return "";
if (typeof document === "undefined") return "";
const el = getColorComputationNode();
if (!el) return "";
el.style.background = backgroundColor;
const computedColor = window?.getComputedStyle(el).background;
el.style.background = "";
return computedColor || "";
}
const getComputedBackgroundColor = memoize(_getComputedBackgroundColor);
/**
* Get the text shade optimized for readability, based on a background color.
*
* @param backgroundColor The background color.
*
* @return The optimized text color (black or white).
*/
function getOptimalTextColor(backgroundColor) {
const background = getComputedBackgroundColor(backgroundColor);
return colord(background).isLight() ? "#000000" : "#ffffff";
}
/**
* Get the text shade optimized for readability, based on a background color.
*
* @param backgroundColor The background color.
*
* @return The optimized text shade (dark or light).
*/
function getOptimalTextShade(backgroundColor) {
return getOptimalTextColor(backgroundColor) === "#000000" ? "dark" : "light";
}
export { getOptimalTextColor, getOptimalTextShade };
//# sourceMappingURL=colors.mjs.map