hashbrown

Prose

API

declare class ProseComponent  {
readonly caret:  InputSignal <
  | boolean
  |  TemplateRef < ProseCaretContext >
>;
readonly caretTemplateDirective: import("@angular/core"). Signal <
   ProseRenderCaret  | undefined
>;
protected readonly caretTemplateFromContent: import("@angular/core"). Signal <
  |  TemplateRef < ProseCaretContext >
  | undefined
>;
readonly citationClick: import("@angular/core"). OutputEmitterRef < ProseCitationClickEvent >;
protected readonly citationTemplate: import("@angular/core"). Signal <
  |  TemplateRef < ProseCitationRenderContext >
  | undefined
>;
readonly citationTemplateDirective: import("@angular/core"). Signal <
   ProseRenderCitation  | undefined
>;
readonly className:  InputSignal <string | undefined>;
protected getCaretContext(
  node:  MarkdownNode ,
):  ProseCaretContext; 
protected getChildren(
  node:  MarkdownNode ,
): readonly number[];
protected getCitation(
  node:  ProseCitationNode ,
):  ProseCitationRenderData; 
protected getCitationLabel(
  node:  ProseCitationNode ,
): string;
protected getCitationRenderContext(
  node:  ProseCitationNode ,
):  ProseCitationRenderContext; 
protected getCitationTemplateOutletContext(
  node:  ProseCitationNode ,
): {
  $implicit:  ProseCitationRenderContext ;
  node:  ProseCitationNode ;
  citation:  ProseCitationRenderData ;
  label: string;
  isOpen: boolean;
  isComplete: boolean;
};
protected getNodeById(
  nodeId: number,
):  MarkdownNode  | null;
protected getNodeRenderContext(
  node:  MarkdownNode ,
):  ProseNodeRenderContext; 
protected getNodeTemplate(
  type:  ProseNodeTemplateType ,
):
  |  TemplateRef < ProseNodeRenderContext >
  | undefined;
protected getNodeTemplateOutletContext(
  node:  MarkdownNode ,
): {
  $implicit:  ProseNodeRenderContext ;
  node:  MarkdownNode ;
  isOpen: boolean;
  isComplete: boolean;
  renderChildren: () => unknown;
};
protected getSafeUrl(url: string | undefined): string | undefined;
protected getTextSegments(
  node:  MarkdownTextNode ,
):  TextSegment [];
protected handleCitationClick(
  mouseEvent:  MouseEvent ,
  node:  ProseCitationNode ,
): void;
protected handleLinkClick(
  mouseEvent:  MouseEvent ,
  node:  ProseLinkNode ,
  url: string,
): void;
readonly isComplete:  InputSignal <boolean>;
protected isNodeOpen(node:  MarkdownNode ): boolean;
protected isTableHeaderCell(
  node:  MarkdownTableCellNode ,
): boolean;
readonly linkClick: import("@angular/core"). OutputEmitterRef < ProseLinkClickEvent >;
protected readonly nodeById: import("@angular/core"). Signal <
   Map <number,  MarkdownNode >
>;
protected readonly nodeTemplateMap: import("@angular/core"). Signal <
   Map <
     ProseNodeTemplateType ,
     TemplateRef < ProseNodeRenderContext >
  >
>;
readonly nodeTemplates: import("@angular/core"). Signal <
  readonly  ProseRenderNode []
>;
protected readonly openNodeDepthById: import("@angular/core"). Signal <
   Map <number, number>
>;
protected readonly openNodeId: import("@angular/core"). Signal <
  number | null
>;
readonly parserOptions:  InputSignal <
   PartialMarkdownParserOptions  | undefined
>;
protected renderDisplayMath(
  node:  MarkdownMathDisplayNode ,
): string;
protected renderFullText(
  node:  MarkdownTextNode ,
): string;
protected renderInlineMath(
  node:  MarkdownMathInlineNode ,
): string;
protected renderSegmentText(
  node:  MarkdownTextNode ,
  segment:  TextSegment ,
  index: number,
): string;
protected resolveCaretTemplate(
  defaultTemplate:  TemplateRef < ProseCaretContext >,
):  TemplateRef < ProseCaretContext >;
protected readonly rootNode: import("@angular/core"). Signal <
  | import("@cacheplane/partial-markdown"). MarkdownDocumentNode 
  | null
>;
readonly segmenter:  InputSignal < SegmenterOptions >;
protected shouldRenderCaret(nodeId: number): boolean;
readonly text:  InputSignal <string>;
protected readonly textSegmentTemplate: import("@angular/core"). Signal <
  |  TemplateRef < ProseTextSegmentRenderContext >
  | undefined
>;
readonly textSegmentTemplateDirective: import("@angular/core"). Signal <
   ProseRenderTextSegment  | undefined
>;
}
getCaretContext
MarkdownNode): ProseCaretContext
@paramnode:
MarkdownNode
getChildren
MarkdownNode): readonly number[]
@paramnode:
MarkdownNode
@returns
readonly number[]
getCitation
ProseCitationNode): ProseCitationRenderData
@paramnode:
ProseCitationNode
getCitationLabel
ProseCitationNode): string
@paramnode:
ProseCitationNode
@returns
string
getCitationRenderContext
ProseCitationNode): ProseCitationRenderContext
@paramnode:
ProseCitationNode
getCitationTemplateOutletContext
ProseCitationNode): {
    $implicit: ProseCitationRenderContext;
    node: ProseCitationNode;
    citation: ProseCitationRenderData;
    label: string;
    isOpen: boolean;
    isComplete: boolean;
  }
@paramnode:
ProseCitationNode
@returns
{
    $implicit: ProseCitationRenderContext;
    node: ProseCitationNode;
    citation: ProseCitationRenderData;
    label: string;
    isOpen: boolean;
    isComplete: boolean;
  }
getNodeById
number): MarkdownNode | null
@paramnodeId:
number
@returns
MarkdownNode | null
getNodeRenderContext
MarkdownNode): ProseNodeRenderContext
@paramnode:
MarkdownNode
getNodeTemplate
ProseNodeTemplateType): TemplateRef<ProseNodeRenderContext> | undefined
@paramtype:
ProseNodeTemplateType
@returns
getNodeTemplateOutletContext
MarkdownNode): {
    $implicit: ProseNodeRenderContext;
    node: MarkdownNode;
    isOpen: boolean;
    isComplete: boolean;
    renderChildren: () => unknown;
  }
@paramnode:
MarkdownNode
@returns
{
    $implicit: ProseNodeRenderContext;
    node: MarkdownNode;
    isOpen: boolean;
    isComplete: boolean;
    renderChildren: () => unknown;
  }
getSafeUrl
string | undefined): string | undefined
@paramurl:
string | undefined
@returns
string | undefined
getTextSegments
MarkdownTextNode): TextSegment[]
@paramnode:
MarkdownTextNode
@returns
TextSegment[]
handleCitationClick
MouseEvent, node: ProseCitationNode): void
@parammouseEvent:
MouseEvent
@paramnode:
ProseCitationNode
@returns
void
handleLinkClick
MouseEvent, node: ProseLinkNode, url: string): void
@parammouseEvent:
MouseEvent
@paramnode:
ProseLinkNode
@paramurl:
string
@returns
void
isNodeOpen
MarkdownNode): boolean
@paramnode:
MarkdownNode
@returns
boolean
isTableHeaderCell
MarkdownTableCellNode): boolean
@paramnode:
MarkdownTableCellNode
@returns
boolean
renderDisplayMath
MarkdownMathDisplayNode): string
@paramnode:
MarkdownMathDisplayNode
@returns
string
renderFullText
MarkdownTextNode): string
@paramnode:
MarkdownTextNode
@returns
string
renderInlineMath
MarkdownMathInlineNode): string
@paramnode:
MarkdownMathInlineNode
@returns
string
renderSegmentText
MarkdownTextNode, segment: TextSegment, index: number): string
@paramnode:
MarkdownTextNode
@paramsegment:
TextSegment
@paramindex:
number
@returns
string
shouldRenderCaret
number): boolean
@paramnodeId:
number
@returns
boolean