Function getAttribute

  • getAttribute<V extends AttributeValue = string, TN extends TagName = "*">(
        target: null | Target<TN>,
        name: AttributeName<TN>,
    ): V | null

  • Attempts to get the attribute name from the target. If the value is found, it is coerced to a boolean if "true" or "false", a number if numeric, or the string value if a string. If not found, returns null.

    Type Parameters

    • V extends AttributeValue = string

      Type of value to return.

    • TN extends TagName = "*"

      Tag name of the Element representation of target.

    Parameters

    • target: null | Target<TN>

      Element, EventTarget, or CSS selector.

    • name: AttributeName<TN>

      Name of the attribute to get.

    Returns V | null

    Value of type V or null if not found.

    Remarks

    We're returning null, rather than undefined to match the Element.getAttribute API.

    Throws

    elements!InvalidElementError if the specified target wasn't found.

    Example

    HTML

    <div
      id="example"
      role="slider"
      aria-valuemax="30"
      aria-label="Example"
      aria-disabled="false"
    >
      ...
    </div>

    Code

    const element = findElement("#example")!;

    getAttribute(element, "aria-label");
    // "Example"

    getAttribute(element, "aria-valuemax");
    // 30

    getAttribute(element, "aria-disabled");
    // false

Settings

Member Visibility