Welshman Docs / @welshman/editor

@welshman/editor

Classes

• DefaultSuggestionsWrapper
• Editor

Interfaces

• BreakOrSubmitOptions
• ISuggestionsWrapper
• NodeViewProps
• UploadTask
• WelshmanOptions

Type Aliases

ChildExtensionOptions<C, E>

ChildExtensionOptions<C, E> = false | { config: Partial<C>; extend: Partial<E>; }

Defined in: packages/editor/src/extensions/Welshman.ts:41

Type Parameters

C

C = any

E

E = any

---

CodeInlineOptions

CodeInlineOptions = object

Defined in: packages/editor/src/extensions/CodeInline.ts:8

---

CommandAttributes

CommandAttributes = object

Defined in: packages/editor/src/extensions/Command.ts:7

Properties

command

command: string

Defined in: packages/editor/src/extensions/Command.ts:8

pubkey?

optional pubkey: string

Defined in: packages/editor/src/extensions/Command.ts:9

---

CommandSuggestionOptions

CommandSuggestionOptions = Partial<TippySuggestionOptions> & object

Defined in: packages/editor/src/extensions/Command.ts:45

Type declaration

editor

editor: Editor

getAttributes()

getAttributes: (value) => CommandAttributes | undefined

Parameters

value

string

Returns

CommandAttributes | undefined

search()

search: (term) => string[]

Parameters

term

string

Returns

string[]

---

CreateSuggestion()

CreateSuggestion = (item) => HTMLElement

Defined in: packages/editor/src/plugins/TippySuggestion.ts:11

Parameters

item

string

Returns

HTMLElement

---

EmptyOptions

EmptyOptions = object

Defined in: packages/editor/src/extensions/Welshman.ts:48

---

FileAttributes

FileAttributes = ImageAttributes | VideoAttributes

Defined in: node_modules/.pnpm/nostr-editor@1.1.2_@tiptap+core@2.27.2_@tiptap+pm@2.27.2__@tiptap+extension-image@2.11._301d8ad9a3964c518ffb21bbe67e10dd/node_modules/nostr-editor/dist/index.d.ts:73

---

MentionSuggestionOptions

MentionSuggestionOptions = Partial<TippySuggestionOptions> & object

Defined in: packages/editor/src/plugins/TippySuggestion.ts:315

Type declaration

editor

editor: Editor

getRelays()

getRelays: (pubkey) => string[]

Parameters

pubkey

string

Returns

string[]

search()

search: (term) => string[]

Parameters

term

string

Returns

string[]

---

SuggestionRange

SuggestionRange = object

Defined in: packages/editor/src/plugins/TippySuggestion.ts:177

Properties

from

from: number

Defined in: packages/editor/src/plugins/TippySuggestion.ts:177

to

to: number

Defined in: packages/editor/src/plugins/TippySuggestion.ts:177

---

SuggestionsWrapperProps

SuggestionsWrapperProps = object

Defined in: packages/editor/src/plugins/TippySuggestion.ts:21

Properties

allowCreate

allowCreate: boolean

Defined in: packages/editor/src/plugins/TippySuggestion.ts:23

createSuggestion

createSuggestion: CreateSuggestion

Defined in: packages/editor/src/plugins/TippySuggestion.ts:26

search()

search: (term) => string[]

Defined in: packages/editor/src/plugins/TippySuggestion.ts:25

Parameters

term

string

Returns

string[]

select()

select: (value) => void

Defined in: packages/editor/src/plugins/TippySuggestion.ts:24

Parameters

value

string

Returns

void

term

term: string

Defined in: packages/editor/src/plugins/TippySuggestion.ts:22

---

TippySuggestionOptions

TippySuggestionOptions = object

Defined in: packages/editor/src/plugins/TippySuggestion.ts:179

Properties

allow()?

optional allow: (props) => boolean

Defined in: packages/editor/src/plugins/TippySuggestion.ts:191

Parameters

props

range

SuggestionRange

state

EditorState

Returns

boolean

allowCreate?

optional allowCreate: boolean

Defined in: packages/editor/src/plugins/TippySuggestion.ts:186

char

char: string

Defined in: packages/editor/src/plugins/TippySuggestion.ts:180

createSuggestion?

optional createSuggestion: CreateSuggestion

Defined in: packages/editor/src/plugins/TippySuggestion.ts:192

createSuggestionsWrapper()?

optional createSuggestionsWrapper: (target, props) => ISuggestionsWrapper

Defined in: packages/editor/src/plugins/TippySuggestion.ts:193

Parameters

target

HTMLElement

props

SuggestionsWrapperProps

Returns

ISuggestionsWrapper

editor

editor: Editor

Defined in: packages/editor/src/plugins/TippySuggestion.ts:182

name

name: string

Defined in: packages/editor/src/plugins/TippySuggestion.ts:181

search()

search: (term) => string[]

Defined in: packages/editor/src/plugins/TippySuggestion.ts:183

Parameters

term

string

Returns

string[]

select()

select: (value, props) => void

Defined in: packages/editor/src/plugins/TippySuggestion.ts:184

Parameters

value

string

props

any

Returns

void

showOnEmpty?

optional showOnEmpty: boolean

Defined in: packages/editor/src/plugins/TippySuggestion.ts:189

updateSignal?

optional updateSignal: Signal

Defined in: packages/editor/src/plugins/TippySuggestion.ts:185

---

WelshmanExtensionOptions

WelshmanExtensionOptions = object

Defined in: packages/editor/src/extensions/Welshman.ts:50

Properties

bolt11?

optional bolt11: false

Defined in: packages/editor/src/extensions/Welshman.ts:51

breakOrSubmit?

optional breakOrSubmit: ChildExtensionOptions<BreakOrSubmitOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:52

codeBlock?

optional codeBlock: ChildExtensionOptions<CodeBlockOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:54

codeInline?

optional codeInline: ChildExtensionOptions<CodeInlineOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:53

document?

optional document: false

Defined in: packages/editor/src/extensions/Welshman.ts:55

dropcursor?

optional dropcursor: ChildExtensionOptions<DropcursorOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:56

fileUpload?

optional fileUpload: object

Defined in: packages/editor/src/extensions/Welshman.ts:57

config?

optional config: Partial<FileUploadOptions> & Pick<FileUploadOptions, "upload">

extend?

optional extend: Partial<any>

gapcursor?

optional gapcursor: false

Defined in: packages/editor/src/extensions/Welshman.ts:61

history?

optional history: ChildExtensionOptions<HistoryOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:62

image?

optional image: ChildExtensionOptions<ImageOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:63

link?

optional link: ChildExtensionOptions<LinkOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:64

naddr?

optional naddr: ChildExtensionOptions<EmptyOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:65

nevent?

optional nevent: ChildExtensionOptions<EmptyOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:66

nprofile?

optional nprofile: ChildExtensionOptions<EmptyOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:67

nsecReject?

optional nsecReject: ChildExtensionOptions<NSecRejectOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:68

paragraph?

optional paragraph: ChildExtensionOptions<ParagraphOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:69

placeholder?

optional placeholder: ChildExtensionOptions<PlaceholderOptions>

Defined in: packages/editor/src/extensions/Welshman.ts:70

tag?

optional tag: false

Defined in: packages/editor/src/extensions/Welshman.ts:71

text?

optional text: false

Defined in: packages/editor/src/extensions/Welshman.ts:72

video?

optional video: false

Defined in: packages/editor/src/extensions/Welshman.ts:73

wordCount?

optional wordCount: false

Defined in: packages/editor/src/extensions/Welshman.ts:74

Variables

BreakOrSubmit

const BreakOrSubmit: Node<BreakOrSubmitOptions, any>

Defined in: packages/editor/src/extensions/BreakOrSubmit.ts:11

---

CodeInline

const CodeInline: Node<CodeOptions, any>

Defined in: packages/editor/src/extensions/CodeInline.ts:10

---

CommandExtension

const CommandExtension: Node<any, any>

Defined in: packages/editor/src/extensions/Command.ts:15

---

editorProps

const editorProps: object

Defined in: node_modules/.pnpm/nostr-editor@1.1.2_@tiptap+core@2.27.2_@tiptap+pm@2.27.2__@tiptap+extension-image@2.11._301d8ad9a3964c518ffb21bbe67e10dd/node_modules/nostr-editor/dist/index.d.ts:66

Type declaration

clipboardTextSerializer

clipboardTextSerializer: typeof clipboardTextSerializer

handlePaste

handlePaste: typeof handlePaste

---

WelshmanExtension

const WelshmanExtension: Extension<WelshmanOptions, NostrStorage>

Defined in: packages/editor/src/extensions/Welshman.ts:82

---

WordCount

const WordCount: Extension<any, any>

Defined in: packages/editor/src/extensions/WordCount.ts:3

Functions

Bolt11NodeView()

Bolt11NodeView(__namedParameters): object

Defined in: packages/editor/src/nodeviews/Bolt11NodeView.ts:3

Parameters

__namedParameters

NodeViewProps

Returns

object

dom

dom: HTMLSpanElement

deselectNode()

deselectNode(): void

Returns

void

selectNode()

selectNode(): void

Returns

void

---

CommandSuggestion()

CommandSuggestion(options): Plugin<any>

Defined in: packages/editor/src/extensions/Command.ts:52

Parameters

options

CommandSuggestionOptions

Returns

Plugin<any>

---

defaultCreateSuggestion()

defaultCreateSuggestion(item): HTMLSpanElement

Defined in: packages/editor/src/plugins/TippySuggestion.ts:13

Parameters

item

string

Returns

HTMLSpanElement

---

EventNodeView()

EventNodeView(__namedParameters): object

Defined in: packages/editor/src/nodeviews/EventNodeView.ts:4

Parameters

__namedParameters

NodeViewProps

Returns

object

dom

dom: HTMLSpanElement

deselectNode()

deselectNode(): void

Returns

void

selectNode()

selectNode(): void

Returns

void

---

MediaNodeView()

MediaNodeView(__namedParameters): object

Defined in: packages/editor/src/nodeviews/MediaNodeView.ts:3

Parameters

__namedParameters

NodeViewProps

Returns

object

dom

dom: HTMLSpanElement

deselectNode()

deselectNode(): void

Returns

void

selectNode()

selectNode(): void

Returns

void

update()

update(node): void

Parameters

node

Node

Returns

void

---

MentionNodeView()

MentionNodeView(__namedParameters): object

Defined in: packages/editor/src/nodeviews/MentionNodeView.ts:3

Parameters

__namedParameters

NodeViewProps

Returns

object

dom

dom: HTMLSpanElement

deselectNode()

deselectNode(): void

Returns

void

selectNode()

selectNode(): void

Returns

void

---

MentionSuggestion()

MentionSuggestion(options): Plugin<any>

Defined in: packages/editor/src/plugins/TippySuggestion.ts:321

Parameters

options

MentionSuggestionOptions

Returns

Plugin<any>

---

TippySuggestion()

TippySuggestion(__namedParameters): Plugin<any>

Defined in: packages/editor/src/plugins/TippySuggestion.ts:199

Parameters

__namedParameters

TippySuggestionOptions

Returns

Plugin<any>