Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Selector

The namespace for selector related utilities.

Index

Functions

Functions

calculateSpecificity

  • calculateSpecificity(selector: string): number

  • Calculate the specificity of a single CSS selector.

    Parameters

    • selector: string

      The CSS selector of interest.

    Returns number

    The specificity of the selector.

    Undefined Behavior

    The selector is invalid.

    Notes

    This is based on https://www.w3.org/TR/css3-selectors/#specificity

    A larger number represents a more specific selector.

    The smallest possible specificity is 0.

    The result is represented as a hex number 0x<aa><bb><cc> where each component is the count of the respective selector clause.

    If the selector contains commas, only the first clause is used.

    The computed result is cached, so subsequent calculations for the same selector are extremely fast.

isValid

  • isValid(selector: string): boolean

  • Test whether a selector is a valid CSS selector.

    Parameters

    • selector: string

      The CSS selector of interest.

    Returns boolean

    true if the selector is valid, false otherwise.

    Notes

    The computed result is cached, so subsequent tests for the same selector are extremely fast.

matches

  • matches(element: Element, selector: string): boolean

  • Test whether an element matches a CSS selector.

    Parameters

    • element: Element

      The element of interest.

    • selector: string

      The valid CSS selector of interest.

    Returns boolean

    true if the element is a match, false otherwise.

    Notes

    This function uses the builtin browser capabilities when possible, falling back onto a document query otherwise.

Generated using TypeDoc