CSS Typed Object Model API

The CSS Typed Object Model API simplifies CSS property manipulation by exposing CSS values as typed JavaScript objects rather than strings. This not only simplifies CSS manipulation, but also lessens the negative impact on performance as compared to style.

Generally, CSS values can be read and written in JavaScript as strings, which can be slow and cumbersome. CSS Typed Object Model API provides interfaces to interact with underlying values, by representing them with specialized JS objects that can be manipulated and understood more easily and more reliably than string parsing and concatenation. This is easier for authors (for example, numeric values are reflected with actual JS numbers, and have unit-aware mathematical operations defined for them). It is also generally faster, as values can be directly manipulated and then cheaply translated back into underlying values without having to both build and parse strings of CSS.

CSS Typed OM both allows for the performant manipulation of values assigned to CSS properties while enabling maintainable code that is both more understandable and easier to write.

Interfaces

CSSStyleValue

The CSSStyleValue interface of the CSS Typed Object Model API is the base class of all CSS values accessible through the Typed OM API. An instance of this class may be used anywhere a string is expected.

• CSSStyleValue.parse()
  • : Method that allows CSSNumericValue to be constructed from a CSS string. It sets a specific CSS property to the specified values and returns the first value as a CSSStyleValue object.
• CSSStyleValue.parseAll()
  • : Method that sets all occurrences of a specific CSS property to the specified value and returns an array of CSSStyleValue objects, each containing one of the supplied values.

StylePropertyMap

The StylePropertyMap interface of the CSS Typed Object Model API provides a representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.

• set()
  • : Method that changes the CSS declaration with the given property to the value given.
• append()
  • : Method that adds a new CSS declaration to the StylePropertyMap with the given property and value.
• delete()
  • : Method that removes the CSS declaration with the given property from the StylePropertyMap.
• clear()
  • : Method that removes all declarations in the StylePropertyMap.

CSSUnparsedValue

The CSSUnparsedValue interface of the CSS Typed Object Model API represents property values that reference custom properties. It consists of a list of string fragments and variable references.

• CSSUnparsedValue() constructor
  • : Creates a new CSSUnparsedValue object which represents property values that reference custom properties.
• entries()
  • : Method returning an array of a given object’s own enumerable property [key, value] pairs in the same order as that provided by a for...in loop (the difference being that a for-in loop enumerates properties in the prototype chain as well).
• forEach()
  • : Method executing a provided function once for each element of the CSSUnparsedValue.
• keys()
  • : Method returning a new array iterator object that contains the keys for each index in the array.

CSSKeywordValue Serialization

The CSSKeywordValue interface of the CSS Typed Object Model API creates an object to represent CSS keywords and other identifiers.

• CSSKeywordValue() constructor
  • : Constructor creates a new CSSKeywordValue() object which represents CSS keywords and other identifiers.
• value()
  • : Property of the CSSKeywordValue interface returning or setting the value of the CSSKeywordValue.

CSSStyleValue Interfaces

CSSStyleValue is the base class through which all CSS values are expressed. Subclasses include:

• CSSImageValue

  • : An interface representing values for properties that take an image, for example background-image, list-style-image, or border-image-source.

• CSSKeywordValue

  • : An interface which creates an object to represent CSS keywords and other identifiers. When used where a string is expected, it will return the value of CSSKeyword.value.

• CSSMathValue

  • : A tree of subclasses representing numeric values that are more complicated than a single value and unit, including:
    • CSSMathMax - represents the CSS max() function.
    • CSSMathMin - represents the CSS min() function.
    • CSSMathClamp - represents the CSS clamp() function.
    • CSSMathNegate - negates the value passed into it.
    • CSSMathInvert - represents a CSS calc() value used as calc(1 / <value>). This type is used internally by div(), to create an appropriate CSSMathProduct.
    • CSSMathProduct - represents the result obtained by calling mul() or div() on CSSNumericValue.
    • CSSMathSum - represents the result obtained by calling add(), sub(), or toSum() on CSSNumericValue.

• CSSNumericValue

  • : An interface representing operations that all numeric values can perform, including:
    • add - Adds supplied numbers to the CSSNumericValue.
    • sub - Subtracts supplied numbers to the CSSNumericValue.
    • mul - Multiplies supplied numbers to the CSSNumericValue.
    • div - Divides the CSSNumericValue by the supplied value, throwing an error if 0.
    • min - Returns the minimum value passed
    • max - Returns the maximum value passed
    • equals - Returns true if all the values are the exact same type and value, in the same order. Otherwise, false
    • to - Converts value into another one with the specified unit.
    • toSum
    • type
    • CSSNumericValue.parse - Returns a number parsed from a CSS string

• CSSPositionValue

  • : Represents values for properties that take a position, for example object-position.

• CSSTransformValue

  • : An interface representing a list of transform list values. They “contain” one or more CSSTransformComponents, which represent individual transform function values.

• CSSUnitValue

  • : An interface representing numeric values that can be represented as a single unit, or a named number and percentage.

• CSSUnparsedValue

  • : Represents property values that reference custom properties. It consists of a list of string fragments and variable references.

Specifications

Browser compatibility

See also

• CSS Painting API
• Using the CSS Typed Object Model
• CSS Houdini