Welshman

Appearance

Welshman Docs / @welshman/editor / BreakOrSubmitOptions

Interface: BreakOrSubmitOptions ​

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

Extends ​

  • HardBreakOptions

Properties ​

aggressive? ​

optional aggressive: boolean

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

Whether to call submit on unmodified Enter

HTMLAttributes ​

HTMLAttributes: Record<string, any>

Defined in: node_modules/.pnpm/@tiptap+extension-hard-break@2.27.2_@tiptap+core@2.27.2_@tiptap+pm@2.27.2_/node_modules/@tiptap/extension-hard-break/dist/hard-break.d.ts:14

HTML attributes to add to the hard break element.

Default ​

ts
{}

Example ​

ts
{ class: 'foo' }

Inherited from ​

HardBreakOptions.HTMLAttributes

keepMarks ​

keepMarks: boolean

Defined in: node_modules/.pnpm/@tiptap+extension-hard-break@2.27.2_@tiptap+core@2.27.2_@tiptap+pm@2.27.2_/node_modules/@tiptap/extension-hard-break/dist/hard-break.d.ts:8

Controls if marks should be kept after being split by a hard break.

Default ​

ts
true

Example ​

ts
false

Inherited from ​

HardBreakOptions.keepMarks

submit() ​

submit: () => void

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

Handler for when enter is pressed.

Returns ​

void