Method getName

src/material/icon/testing/icon-harness.ts:41–63

Gets the name of the icon.

()

  /** Gets the name of the icon. */
  async getName(): Promise<string | null> {
    const host = await this.host();
    const nameFromDom = await host.getAttribute('data-mat-icon-name');

    // If we managed to figure out the name from the attribute, use it.
    if (nameFromDom) {
      return nameFromDom;
    }

    // Some icons support defining the icon as a ligature.
    // As a fallback, try to extract it from the DOM text.
    if ((await this.getType()) === IconType.FONT) {
      // Other directives may add content to the icon (e.g. `MatBadge`), however only the direct
      // text nodes affect the name of the icon. Exclude all element descendants from the result.
      const text = await host.text({exclude: '*'});

      // There are some internal cases where the icon name is wrapped in another node.
      // Fall back to extracting the entire text if we ended up excluding everything above.
      return text.length > 0 ? text : host.text();
    }

    return null;
  }

  /** Gets the namespace of the icon. */
  async getNamespace(): Promise<string | null> {