Files
tiptap/packages/extension-subscript/src/subscript.ts
Philipp Kühn 9afadeb7fe feat!: Replace defaultOptions with addOptions (#2088)
* add new addOptions option

* replace defaultOptions with addOptions for all extensions

* replace defaultOptions with addOptions for all demos

* replace defaultOptions with addOptions in docs

* refactoring

* refactoring

* drop object support for addOptions

* fix optional options

* fix tests
2021-10-26 18:31:13 +02:00

78 lines
1.6 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import { Mark, mergeAttributes } from '@tiptap/core'
export interface SubscriptExtensionOptions {
HTMLAttributes: Object,
}
declare module '@tiptap/core' {
interface Commands<ReturnType> {
subscript: {
/**
* Set a subscript mark
*/
setSubscript: () => ReturnType,
/**
* Toggle a subscript mark
*/
toggleSubscript: () => ReturnType,
/**
* Unset a subscript mark
*/
unsetSubscript: () => ReturnType,
}
}
}
export const Subscript = Mark.create<SubscriptExtensionOptions>({
name: 'subscript',
addOptions() {
return {
HTMLAttributes: {},
}
},
parseHTML() {
return [
{
tag: 'sub',
},
{
style: 'vertical-align',
getAttrs(value) {
// Dont match this rule if the vertical align isnt sub.
if (value !== 'sub') {
return false
}
// If it falls through well match, and this mark will be applied.
},
},
]
},
renderHTML({ HTMLAttributes }) {
return ['sub', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0]
},
addCommands() {
return {
setSubscript: () => ({ commands }) => {
return commands.setMark('subscript')
},
toggleSubscript: () => ({ commands }) => {
return commands.toggleMark('subscript')
},
unsetSubscript: () => ({ commands }) => {
return commands.unsetMark('subscript')
},
}
},
addKeyboardShortcuts() {
return {
'Mod-,': () => this.editor.commands.toggleSubscript(),
}
},
})