Variable generatorConfigConst

Type Declaration

• {
      create: (
          pm: Builders,
          parentType: string,
          children: Node[],
      ) => Node & {} | undefined;
      parents: { names: string[]; type: "node" };
  }

  • create: (pm: Builders, parentType: string, children: Node[]) => Node & {} | undefined

    Creates the node. Can return undefined to "terminate" the branch being created, the node will be filtered out of the nodes passed to it's parent.

    Note also, it is not required to use the children. You can ignore them or use a subset or create different ones if needed (some node types require text and if count returns 0 children will be empty, which can cause issues).

  • parents: { names: string[]; type: "node" }

    • names: string[]

      Possible parent nodes that can have the given children. The children need not be direct descendants or real prosemirror nodes since create is what determines how they're created.

    • type: "node"

      The type of the parent (node or "text") where "text" is a string or mark. Determines the call signature of the create function.

• {
      create: (
          pm: Builders,
          parentType: string,
          children: (string | Mark)[],
      ) => any;
      parents: { names: string[]; type: "text" };
  }

  • create: (pm: Builders, parentType: string, children: (string | Mark)[]) => any

    Creates the node. Can return undefined to "terminate" the branch being created, the node will be filtered out of the nodes passed to it's parent.

    Note also, it is not required to use the children. You can ignore them or use a subset or create different ones if needed (some node types require text and if count returns 0 children will be empty, which can cause issues).

  • parents: { names: string[]; type: "text" }

    • names: string[]

      Possible parent nodes that can have the given children. The children need not be direct descendants or real prosemirror nodes since create is what determines how they're created.

    • type: "text"

      The type of the parent (node or "text") where "text" is a string or mark. Determines the call signature of the create function.