yoastseo-dep/src/parse/structure/Paragraph.js

Yoast clientside page analysis

import Node from "./Node";

/**
 * A paragraph in the tree.
 *
 * @see https://html.spec.whatwg.org/dev/dom.html#paragraphs
 */
class Paragraph extends Node {
	/**
	 * Creates a new paragraph.
	 *
	 * @param {Object} attributes The paragraph's attributes.
	 * @param {(Node|Text)[]} childNodes This paragraph's child nodes.
	 * @param {Object} sourceCodeLocationInfo This paragraph's location in the source code, from parse5.
	 * @param {boolean} isImplicit Whether this paragraph is an implicit paragraph, or an explicit paragraph.
	 * @param {boolean} isOverarching Whether this paragraph is overarching text that is separated by double line breaks.
	 */
	constructor( attributes = {}, childNodes = [], sourceCodeLocationInfo = {},
		isImplicit = false, isOverarching = false ) {
		// We rename any overarching `<p>` element to not match it as a stand-alone paragraph downstream.
		const name = isOverarching ? "p-overarching" : "p";
		super( name, attributes, childNodes, sourceCodeLocationInfo );
		/**
		 * Whether this paragraph is explicit (defined by an explicit `<p>` tag within the markup),
		 * or implicit (defined by a run of phrasing content).
		 *
		 * @see https://html.spec.whatwg.org/dev/dom.html#paragraphs
		 *
		 * @type {boolean}
		 */
		this.isImplicit = isImplicit;
	}

	/**
	 * Creates and returns a new implicit paragraph.
	 *
	 * @param {Object} attributes The paragraph's attributes.
	 * @param {(Node|Text)[]} childNodes This paragraph's child nodes.
	 * @param {Object} sourceCodeLocationInfo This paragraph's location in the source code, from parse5.
	 *
	 * @returns {Paragraph} A new implicit paragraph.
	 */
	static createImplicit( attributes = {}, childNodes = [], sourceCodeLocationInfo = {} ) {
		return new Paragraph( attributes, childNodes, sourceCodeLocationInfo, true );
	}
}

export default Paragraph;