BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/affine-inline-footnote

@blocksuite/affine-inline-footnote ​

Classes ​

AffineFootnoteNode ​

Extends ​

Constructors ​

Other ​

styles ​

static styles: CSSResult

Overrides ​

WithDisposable(ShadowlessElement).styles

citationService ​
Get Signature ​

get citationService(): CitationViewService

Returns ​

CitationViewService

config ​
customNodeRenderer ​
Get Signature ​

get customNodeRenderer(): FootNoteNodeRenderer | undefined

Returns ​

FootNoteNodeRenderer | undefined

customPopupRenderer ​
Get Signature ​

get customPopupRenderer(): FootNotePopupRenderer | undefined

Returns ​

FootNotePopupRenderer | undefined

delta ​
disableHoverEffect ​
Get Signature ​

get disableHoverEffect(): boolean | undefined

Returns ​

boolean | undefined

footnote ​
Get Signature ​

get footnote(): { label: string; reference: { blobId?: string; description?: string; docId?: string; favicon?: string; fileName?: string; fileType?: string; title?: string; type: "doc" | "attachment" | "url"; url?: string; }; } | null | undefined

Returns ​

{ label: string; reference: { blobId?: string; description?: string; docId?: string; favicon?: string; fileName?: string; fileType?: string; title?: string; type: "doc" | "attachment" | "url"; url?: string; }; } | null | undefined

hidePopup ​
Get Signature ​

get hidePopup(): boolean | undefined

Returns ​

boolean | undefined

inlineEditor ​
Get Signature ​

get inlineEditor(): InlineEditor<AffineTextAttributes> | undefined

Returns ​

InlineEditor<AffineTextAttributes> | undefined

interactive ​
Get Signature ​

get interactive(): boolean | undefined

Returns ​

boolean | undefined

onPopupClick ​
Get Signature ​

get onPopupClick(): FootNotePopupClickHandler | undefined

Returns ​

FootNotePopupClickHandler | undefined

readonly ​
Get Signature ​

get readonly(): boolean

Returns ​

boolean

selfInlineRange ​
Get Signature ​

get selfInlineRange(): InlineRange | null | undefined

Returns ​

InlineRange | null | undefined

std ​
onFootnoteClick() ​

onFootnoteClick(): void

Returns ​

void

attributes ​

controllers ​

dev-mode ​

lifecycle ​

properties ​

rendering ​

render() ​

render(): TemplateResult<1> | typeof nothing

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html's ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns ​

TemplateResult<1> | typeof nothing

Overrides ​

WithDisposable(ShadowlessElement).render

styles ​

updates ​

FootNoteNodeConfigProvider ​

Constructors ​

Constructor ​

new FootNoteNodeConfigProvider(config, std): FootNoteNodeConfigProvider

Parameters ​
config ​

FootNoteNodeConfig

std ​

BlockStdScope

Returns ​

FootNoteNodeConfigProvider

Properties ​

std ​

readonly std: BlockStdScope

Accessors ​

customNodeRenderer ​
Get Signature ​

get customNodeRenderer(): FootNoteNodeRenderer | undefined

Returns ​

FootNoteNodeRenderer | undefined

customPopupRenderer ​
Get Signature ​

get customPopupRenderer(): FootNotePopupRenderer | undefined

Returns ​

FootNotePopupRenderer | undefined

disableHoverEffect ​
Get Signature ​

get disableHoverEffect(): boolean

Returns ​

boolean

doc ​
Get Signature ​

get doc(): Store

Returns ​

Store

hidePopup ​
Get Signature ​

get hidePopup(): boolean

Returns ​

boolean

interactive ​
Get Signature ​

get interactive(): boolean

Returns ​

boolean

onPopupClick ​
Get Signature ​

get onPopupClick(): FootNotePopupClickHandler | undefined

Returns ​

FootNotePopupClickHandler | undefined

Methods ​

setCustomNodeRenderer() ​

setCustomNodeRenderer(renderer): void

Parameters ​
renderer ​

FootNoteNodeRenderer

Returns ​

void

setCustomPopupRenderer() ​

setCustomPopupRenderer(renderer): void

Parameters ​
renderer ​

FootNotePopupRenderer

Returns ​

void

setDisableHoverEffect() ​

setDisableHoverEffect(disableHoverEffect): void

Parameters ​
disableHoverEffect ​

boolean

Returns ​

void

setHidePopup() ​

setHidePopup(hidePopup): void

Parameters ​
hidePopup ​

boolean

Returns ​

void

setInteractive() ​

setInteractive(interactive): void

Parameters ​
interactive ​

boolean

Returns ​

void

setPopupClick() ​

setPopupClick(onPopupClick): void

Parameters ​
onPopupClick ​

FootNotePopupClickHandler

Returns ​

void

Interfaces ​

FootNoteNodeConfig ​

Properties ​

customNodeRenderer? ​

optional customNodeRenderer: FootNoteNodeRenderer

customPopupRenderer? ​

optional customPopupRenderer: FootNotePopupRenderer

disableHoverEffect? ​

optional disableHoverEffect: boolean

hidePopup? ​

optional hidePopup: boolean

interactive? ​

optional interactive: boolean

onPopupClick? ​

optional onPopupClick: FootNotePopupClickHandler

Type Aliases ​

FootNotePopupClickHandler() ​

FootNotePopupClickHandler = (footnote, abortController) => void

Parameters ​

footnote ​

FootNote

abortController ​

AbortController

Returns ​

void

Variables ​

FootNoteInlineSpecExtension ​

const FootNoteInlineSpecExtension: ExtensionType & object

Type Declaration ​

identifier ​

identifier: ServiceIdentifier<InlineSpecs<AffineTextAttributes>>

FootNoteNodeConfigIdentifier ​

const FootNoteNodeConfigIdentifier: ServiceIdentifier<FootNoteNodeConfigProvider> & <U>(variant) => ServiceIdentifier<U>

footnoteReferenceDeltaToMarkdownAdapterMatcher ​

const footnoteReferenceDeltaToMarkdownAdapterMatcher: ExtensionType & object

Type Declaration ​

identifier ​

identifier: ServiceIdentifier<InlineDeltaToMarkdownAdapterMatcher>

FootnoteReferenceMarkdownPreprocessorExtension ​

const FootnoteReferenceMarkdownPreprocessorExtension: ExtensionType & object

Type Declaration ​

identifier ​

identifier: ServiceIdentifier<MarkdownAdapterPreprocessor>

markdownFootnoteReferenceToDeltaMatcher ​

const markdownFootnoteReferenceToDeltaMatcher: ExtensionType & object

Type Declaration ​

identifier ​

identifier: ServiceIdentifier<MarkdownASTToDeltaMatcher>

Functions ​

FootNoteNodeConfigExtension() ​

FootNoteNodeConfigExtension(config): ExtensionType

Parameters ​

config ​

FootNoteNodeConfig

Returns ​

ExtensionType

preprocessFootnoteReference() ​

preprocessFootnoteReference(content): string

Preprocess footnote references to avoid markdown link parsing Only add space when footnote reference follows a URL

Parameters ​

content ​

string

Returns ​

string

Example ​

md
https://example.com[^label] -> https://example.com [^label]
normal text[^label] -> normal text[^label]

Copyright © 2022-present Toeverything