Events

config:ready

{
  config: ConfigData;
  rules: { [ruleId: string]: Rule };
}

Emitted after after configuration is ready but before DOM is initialized.

dom:load

{
}

Emitted after initialization but before tokenization and parsing occurs. Can be used to initialize state in rules.

dom:ready

{
  document: DOMTree,
}

Emitted after the parsing has finished loading the DOM tree.

doctype

{
  location: Location,
  value: string,
  valueLocation: Location,
}

Emitted when a doctype is encountered. value is the doctype (without <doctype and >).

location refers to the doctype opening tag and valueLocation to the value (as described above)

tag:open

{
  target: Node,
}

Emitted when an opening element is parsed: <div>. target will be newly created Node. The element will not have its attribute nor children yet. Use element:ready to wait for the element to be complete.

tag:close

{
  target: Node,
  previous: Node,
}

Emitted when a closing element is parsed: </div>. target refers to the close-tag itself and previous is the current active element about to be closed.

element:ready

{
  target: Node,
}

Emitted when an element is fully constructed (including its children). target will be the the element.

attr

{
  target: Node,
  location: Location,
  valueLocation: Location,
  key: String,
  value: String|undefined,
  quote: 'single'|'double'|undefined,
  originalAttribute: string;
}

Emitted when an element attribute is parsed: <div foo="bar">.

Target node will not have been updated with the new attribute yet (e.g. node.getAttribute(...) will return undefined or a previous value).

originalAttribute is set when a transformer has modified the attribute and contains the original attribute name, e.g. ng-class or v-bind:class.

whitespace

{
  text: string;
}

Emitted when inter-element, leading and trailing whitespace is parsed.

conditional

{
  condition: string;
}

Emitted when a conditional comment <![conditional]> is parsed. The parser ignores and condition and run all possible branches but raises the event for any rules that wishes to do anything with it.