Skip to content

Files

Latest commit

c15a381 · Apr 25, 2025

History

History
This branch is 428 commits ahead of, 199 commits behind angular/angular:main.

angular-html-parser

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Apr 25, 2025
Mar 12, 2025
Apr 25, 2025
Apr 25, 2025
Sep 29, 2024
Mar 12, 2025
Apr 16, 2025
Mar 12, 2025
Mar 12, 2025
Jan 28, 2020
Mar 12, 2025
Apr 25, 2025
Mar 12, 2025
Mar 12, 2025
Mar 12, 2025
Nov 25, 2024
Mar 12, 2025
Mar 12, 2025
Apr 16, 2025

angular-html-parser

npm

An HTML parser extracted from Angular with some modifications

Changelog

Diff from upstream

Link

Tip

Try sync main and dev branch with upstream first

Install

# using npm
npm install --save angular-html-parser

# using yarn
yarn add angular-html-parser

Usage

import { parse } from "angular-html-parser";

const { rootNodes, errors } = parse(`
<!DOCTYPE html>
<html>
  <head>
    <title>Hello world!</title>
  </head>
  <body>
    <div>Hello world!</div>
  </body>
</html>
`);

API

declare function parse(input: string, options?: Options): ng.ParseTreeResult;

interface Options {
  /**
   * any element can self close
   *
   * defaults to false
   */
  canSelfClose?: boolean;
  /**
   * support [`htm`](https://github.com/developit/htm) component closing tags (`<//>`)
   *
   * defaults to false
   */
  allowHtmComponentClosingTags?: boolean;
  /**
   * do not lowercase tag names before querying their tag definitions
   *
   * defaults to false
   */
  isTagNameCaseSensitive?: boolean;
  /**
   * customize tag content type
   *
   * defaults to the content type defined in the HTML spec
   */
  getTagContentType?: (
    tagName: string,
    prefix: string,
    hasParent: boolean,
    attrs: Array<{ prefix: string; name: string; value?: string | undefined }>,
  ) => void | ng.TagContentType;
  /**
   * tokenize angular control flow block syntax
   */
  tokenizeAngularBlocks?: boolean;
  /**
   * tokenize angular let declaration syntax
   */
  tokenizeAngularLetDeclaration?: boolean;
}

Modifications

  • add CDATA node
  • add DocType node
  • add nameSpan field to Element and Attribute
  • allow case-insensitive closing tags for non-foreign elements
  • fix Comment#sourceSpan
  • support bogus comments (<!...>, <?...>)
  • support full named entities (fixed upstream)
  • add type property to nodes
  • value span for attributes includes quotes

Development

# build
yarn run build

# test
yarn run test

License

MIT © Ika