mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-01-18 06:03:22 +08:00
add command scope
This commit is contained in:
parent
87beee25b0
commit
ca8d1a4245
@ -14,10 +14,12 @@ export interface AnnotationOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
annotation: {
|
||||
addAnnotation: (content: any) => Command,
|
||||
deleteAnnotation: (id: number) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const Annotation = Extension.create({
|
||||
|
@ -8,12 +8,14 @@ export interface IframeOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
iframe: {
|
||||
/**
|
||||
* Add an iframe
|
||||
*/
|
||||
setIframe: (options: { src: string }) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default Node.create({
|
||||
|
@ -35,7 +35,8 @@ export default class CommandManager {
|
||||
.entries(commands)
|
||||
.map(([name, command]) => {
|
||||
const method = (...args: any) => {
|
||||
const callback = command(...args)(props)
|
||||
// TODO: fix any
|
||||
const callback = command(...args as any)(props)
|
||||
|
||||
if (!tr.getMeta('preventDispatch')) {
|
||||
view.dispatch(tr)
|
||||
@ -85,7 +86,7 @@ export default class CommandManager {
|
||||
public createCan(startTr?: Transaction): CanCommands {
|
||||
const { commands, editor } = this
|
||||
const { state } = editor
|
||||
const dispatch = false
|
||||
const dispatch = undefined
|
||||
const tr = startTr || state.tr
|
||||
const props = this.buildProps(tr, dispatch)
|
||||
const formattedCommands = Object.fromEntries(Object
|
||||
@ -118,10 +119,14 @@ export default class CommandManager {
|
||||
: undefined,
|
||||
chain: () => this.createChain(tr),
|
||||
can: () => this.createCan(tr),
|
||||
// TODO: fix
|
||||
// @ts-ignore
|
||||
get commands() {
|
||||
return Object.fromEntries(Object
|
||||
.entries(commands)
|
||||
.map(([name, command]) => {
|
||||
// TODO: fix
|
||||
// @ts-ignore
|
||||
return [name, (...args: any[]) => command(...args)(props)]
|
||||
})) as SingleCommands
|
||||
},
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
blur: {
|
||||
/**
|
||||
* Removes focus from the editor.
|
||||
*/
|
||||
blur: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const blur: Commands['blur'] = () => ({ view }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
clearContent: {
|
||||
/**
|
||||
* Clear the whole document.
|
||||
*/
|
||||
clearContent: (emitUpdate: Boolean) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const clearContent: Commands['clearContent'] = (emitUpdate = false) => ({ commands }) => {
|
||||
|
@ -2,12 +2,14 @@ import { liftTarget } from 'prosemirror-transform'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
clearNodes: {
|
||||
/**
|
||||
* Normalize nodes to a simple paragraph.
|
||||
*/
|
||||
clearNodes: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const clearNodes: Commands['clearNodes'] = () => ({ state, tr, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
command: {
|
||||
/**
|
||||
* Define a command inline.
|
||||
*/
|
||||
command: (fn: (props: Parameters<Command>[0]) => boolean) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const command: Commands['command'] = fn => props => {
|
||||
|
@ -2,12 +2,14 @@ import { createParagraphNear as originalCreateParagraphNear } from 'prosemirror-
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
createParagraphNear: {
|
||||
/**
|
||||
* Create a paragraph nearby.
|
||||
*/
|
||||
createParagraphNear: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const createParagraphNear: Commands['createParagraphNear'] = () => ({ state, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands, Range } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
deleteRange: {
|
||||
/**
|
||||
* Delete a given range.
|
||||
*/
|
||||
deleteRange: (range: Range) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const deleteRange: Commands['deleteRange'] = range => ({ tr, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { deleteSelection as originalDeleteSelection } from 'prosemirror-commands
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
deleteSelection: {
|
||||
/**
|
||||
* Delete the selection, if there is one.
|
||||
*/
|
||||
deleteSelection: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const deleteSelection: Commands['deleteSelection'] = () => ({ state, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
enter: {
|
||||
/**
|
||||
* Trigger enter.
|
||||
*/
|
||||
enter: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const enter: Commands['enter'] = () => ({ commands }) => {
|
||||
|
@ -2,12 +2,14 @@ import { exitCode as originalExitCode } from 'prosemirror-commands'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
exitCode: {
|
||||
/**
|
||||
* Exit from a code block.
|
||||
*/
|
||||
exitCode: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const exitCode: Commands['exitCode'] = () => ({ state, dispatch }) => {
|
||||
|
@ -5,12 +5,14 @@ import getMarkType from '../helpers/getMarkType'
|
||||
import getMarkRange from '../helpers/getMarkRange'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
extendMarkRange: {
|
||||
/**
|
||||
* Extends the text selection to the current mark.
|
||||
*/
|
||||
extendMarkRange: (typeOrName: string | MarkType) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const extendMarkRange: Commands['extendMarkRange'] = typeOrName => ({ tr, state, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
first: {
|
||||
/**
|
||||
* Runs one command after the other and stops at the first which returns true.
|
||||
*/
|
||||
first: (commands: Command[] | ((props: Parameters<Command>[0]) => Command[])) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const first: Commands['first'] = commands => props => {
|
||||
|
@ -31,12 +31,14 @@ function resolveSelection(state: EditorState, position: FocusPosition = null) {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
focus: {
|
||||
/**
|
||||
* Focus the editor at the given position.
|
||||
*/
|
||||
focus: (position?: FocusPosition) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const focus: Commands['focus'] = (position = null) => ({
|
||||
|
@ -18,12 +18,14 @@ function selectionToInsertionEnd(tr: Transaction, startLen: number, bias: number
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
insertHTML: {
|
||||
/**
|
||||
* Insert a string of HTML at the current position.
|
||||
*/
|
||||
insertHTML: (value: string) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const insertHTML: Commands['insertHTML'] = value => ({ tr, state, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
insertText: {
|
||||
/**
|
||||
* Insert a string of text at the current position.
|
||||
*/
|
||||
insertText: (value: string) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const insertText: Commands['insertText'] = value => ({ tr, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { joinBackward as originalJoinBackward } from 'prosemirror-commands'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
joinBackward: {
|
||||
/**
|
||||
* Join two nodes backward.
|
||||
*/
|
||||
joinBackward: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const joinBackward: Commands['joinBackward'] = () => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { joinForward as originalJoinForward } from 'prosemirror-commands'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
joinForward: {
|
||||
/**
|
||||
* Join two nodes forward.
|
||||
*/
|
||||
joinForward: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const joinForward: Commands['joinForward'] = () => ({ state, dispatch }) => {
|
||||
|
@ -57,12 +57,14 @@ function normalizeKeyName(name: string) {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
keyboardShortcut: {
|
||||
/**
|
||||
* Trigger a keyboard shortcut.
|
||||
*/
|
||||
keyboardShortcut: (name: string) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const keyboardShortcut: Commands['keyboardShortcut'] = name => ({
|
||||
|
@ -5,12 +5,14 @@ import isNodeActive from '../helpers/isNodeActive'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
lift: {
|
||||
/**
|
||||
* Removes an existing wrap.
|
||||
*/
|
||||
lift: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const lift: Commands['lift'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { liftEmptyBlock as originalLiftEmptyBlock } from 'prosemirror-commands'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
liftEmptyBlock: {
|
||||
/**
|
||||
* Lift block if empty.
|
||||
*/
|
||||
liftEmptyBlock: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const liftEmptyBlock: Commands['liftEmptyBlock'] = () => ({ state, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import { Command, Commands } from '../types'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
liftListItem: {
|
||||
/**
|
||||
* Lift the list item into a wrapping list.
|
||||
*/
|
||||
liftListItem: (typeOrName: string | NodeType) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const liftListItem: Commands['liftListItem'] = typeOrName => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { newlineInCode as originalNewlineInCode } from 'prosemirror-commands'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
newlineInCode: {
|
||||
/**
|
||||
* Add a newline character in code.
|
||||
*/
|
||||
newlineInCode: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const newlineInCode: Commands['newlineInCode'] = () => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { NodeType } from 'prosemirror-model'
|
||||
import { Command, Commands, AnyObject } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
replace: {
|
||||
/**
|
||||
* Replaces text with a node.
|
||||
*/
|
||||
replace: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const replace: Commands['replace'] = (typeOrName, attributes = {}) => ({ state, commands }) => {
|
||||
|
@ -8,12 +8,14 @@ import {
|
||||
} from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
replaceRange: {
|
||||
/**
|
||||
* Replaces text with a node within a range.
|
||||
*/
|
||||
replaceRange: (range: Range, typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const replaceRange: Commands['replaceRange'] = (range, typeOrName, attributes = {}) => ({ tr, state, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import deleteProps from '../utilities/deleteProps'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
resetNodeAttributes: {
|
||||
/**
|
||||
* Resets node attributes to the default value.
|
||||
*/
|
||||
resetNodeAttributes: (typeOrName: string | NodeType, attributes: string | string[]) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const resetNodeAttributes: Commands['resetNodeAttributes'] = (typeOrName, attributes) => ({ tr, state, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
scrollIntoView: {
|
||||
/**
|
||||
* Scroll the selection into view.
|
||||
*/
|
||||
scrollIntoView: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const scrollIntoView: Commands['scrollIntoView'] = () => ({ tr, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { selectAll as originalSelectAll } from 'prosemirror-commands'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
selectAll: {
|
||||
/**
|
||||
* Select the whole document.
|
||||
*/
|
||||
selectAll: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const selectAll: Commands['selectAll'] = () => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { selectNodeBackward as originalSelectNodeBackward } from 'prosemirror-co
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
selectNodeBackward: {
|
||||
/**
|
||||
* Select a node backward.
|
||||
*/
|
||||
selectNodeBackward: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const selectNodeBackward: Commands['selectNodeBackward'] = () => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { selectNodeForward as originalSelectNodeForward } from 'prosemirror-comm
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
selectNodeForward: {
|
||||
/**
|
||||
* Select a node forward.
|
||||
*/
|
||||
selectNodeForward: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const selectNodeForward: Commands['selectNodeForward'] = () => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { selectParentNode as originalSelectParentNode } from 'prosemirror-comman
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
selectParentNode: {
|
||||
/**
|
||||
* Select the parent node.
|
||||
*/
|
||||
selectParentNode: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const selectParentNode: Commands['selectParentNode'] = () => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { TextSelection } from 'prosemirror-state'
|
||||
import { AnyObject, Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
setContent: {
|
||||
/**
|
||||
* Replace the whole document with new content.
|
||||
*/
|
||||
setContent: (content: string, emitUpdate?: Boolean, parseOptions?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const setContent: Commands['setContent'] = (content, emitUpdate = false, parseOptions = {}) => ({ tr, editor, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import getMarkType from '../helpers/getMarkType'
|
||||
import getMarkAttributes from '../helpers/getMarkAttributes'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
setMark: {
|
||||
/**
|
||||
* Add a mark with new attributes.
|
||||
*/
|
||||
setMark: (typeOrName: string | MarkType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const setMark: Commands['setMark'] = (typeOrName, attributes = {}) => ({ tr, state, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import { AnyObject, Command, Commands } from '../types'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
setNode: {
|
||||
/**
|
||||
* Replace a given range with a node.
|
||||
*/
|
||||
setNode: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const setNode: Commands['setNode'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import { Command, Commands } from '../types'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
sinkListItem: {
|
||||
/**
|
||||
* Sink the list item down into an inner list.
|
||||
*/
|
||||
sinkListItem: (typeOrName: string | NodeType) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const sinkListItem: Commands['sinkListItem'] = typeOrName => ({ state, dispatch }) => {
|
||||
|
@ -25,12 +25,14 @@ function ensureMarks(state: EditorState) {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
splitBlock: {
|
||||
/**
|
||||
* Forks a new node from an existing node.
|
||||
*/
|
||||
splitBlock: (options?: { keepMarks?: boolean }) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const splitBlock: Commands['splitBlock'] = ({ keepMarks = true } = {}) => ({
|
||||
|
@ -11,12 +11,14 @@ import getNodeType from '../helpers/getNodeType'
|
||||
import getSplittedAttributes from '../helpers/getSplittedAttributes'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
splitListItem: {
|
||||
/**
|
||||
* Splits one list item into two list items.
|
||||
*/
|
||||
splitListItem: (typeOrName: string | NodeType) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const splitListItem: Commands['splitListItem'] = typeOrName => ({
|
||||
|
@ -5,12 +5,14 @@ import findParentNode from '../helpers/findParentNode'
|
||||
import isList from '../helpers/isList'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
toggleList: {
|
||||
/**
|
||||
* Toggle between different list types.
|
||||
*/
|
||||
toggleList: (listTypeOrName: string | NodeType, itemTypeOrName: string | NodeType) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const toggleList: Commands['toggleList'] = (listTypeOrName, itemTypeOrName) => ({
|
||||
|
@ -4,12 +4,14 @@ import getMarkType from '../helpers/getMarkType'
|
||||
import isMarkActive from '../helpers/isMarkActive'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
toggleMark: {
|
||||
/**
|
||||
* Toggle a mark on and off.
|
||||
*/
|
||||
toggleMark: (typeOrName: string | MarkType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const toggleMark: Commands['toggleMark'] = (typeOrName, attributes = {}) => ({ state, commands }) => {
|
||||
|
@ -4,12 +4,14 @@ import isNodeActive from '../helpers/isNodeActive'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
toggleNode: {
|
||||
/**
|
||||
* Toggle a node with another node.
|
||||
*/
|
||||
toggleNode: (typeOrName: string | NodeType, toggleTypeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const toggleNode: Commands['toggleNode'] = (typeOrName, toggleTypeOrName, attributes = {}) => ({ state, commands }) => {
|
||||
|
@ -5,12 +5,14 @@ import isNodeActive from '../helpers/isNodeActive'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
toggleWrap: {
|
||||
/**
|
||||
* Wraps nodes in another node, or removes an existing wrap.
|
||||
*/
|
||||
toggleWrap: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const toggleWrap: Commands['toggleWrap'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
|
||||
|
@ -2,12 +2,14 @@ import { undoInputRule as originalUndoInputRule } from 'prosemirror-inputrules'
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
undoInputRule: {
|
||||
/**
|
||||
* Undo an input rule.
|
||||
*/
|
||||
undoInputRule: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const undoInputRule: Commands['undoInputRule'] = () => ({ state, dispatch }) => {
|
||||
|
@ -1,12 +1,14 @@
|
||||
import { Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
unsetAllMarks: {
|
||||
/**
|
||||
* Remove all marks in the current selection.
|
||||
*/
|
||||
unsetAllMarks: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const unsetAllMarks: Commands['unsetAllMarks'] = () => ({ tr, state, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import getMarkType from '../helpers/getMarkType'
|
||||
import getMarkRange from '../helpers/getMarkRange'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
unsetMark: {
|
||||
/**
|
||||
* Remove all marks in the current selection.
|
||||
*/
|
||||
unsetMark: (typeOrName: string | MarkType) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const unsetMark: Commands['unsetMark'] = typeOrName => ({ tr, state, dispatch }) => {
|
||||
|
@ -3,12 +3,14 @@ import getNodeType from '../helpers/getNodeType'
|
||||
import { AnyObject, Command, Commands } from '../types'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
updateNodeAttributes: {
|
||||
/**
|
||||
* Update attributes of a node.
|
||||
*/
|
||||
updateNodeAttributes: (typeOrName: string | NodeType, attributes: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const updateNodeAttributes: Commands['updateNodeAttributes'] = (typeOrName, attributes = {}) => ({ tr, state, dispatch }) => {
|
||||
|
@ -5,12 +5,14 @@ import isNodeActive from '../helpers/isNodeActive'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
wrapIn: {
|
||||
/**
|
||||
* Wraps nodes in another node.
|
||||
*/
|
||||
wrapIn: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const wrapIn: Commands['wrapIn'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
|
||||
|
@ -4,12 +4,14 @@ import { AnyObject, Command, Commands } from '../types'
|
||||
import getNodeType from '../helpers/getNodeType'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
wrapInList: {
|
||||
/**
|
||||
* Wrap a node in a list.
|
||||
*/
|
||||
wrapInList: (typeOrName: string | NodeType, attributes?: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const wrapInList: Commands['wrapInList'] = (typeOrName, attributes = {}) => ({ state, dispatch }) => {
|
||||
|
@ -22,4 +22,4 @@ export { default as isCellSelection } from './helpers/isCellSelection'
|
||||
export { default as findParentNodeClosestToPos } from './helpers/findParentNodeClosestToPos'
|
||||
|
||||
export interface AllExtensions {}
|
||||
export interface Commands {}
|
||||
export interface AllCommands {}
|
||||
|
@ -14,9 +14,9 @@ import { Extension } from './Extension'
|
||||
import { Node } from './Node'
|
||||
import { Mark } from './Mark'
|
||||
import { Editor } from './Editor'
|
||||
import { Commands } from '.'
|
||||
import { AllCommands } from '.'
|
||||
|
||||
export { Commands }
|
||||
export { AllCommands }
|
||||
|
||||
export type Extensions = (Extension | Node | Mark)[]
|
||||
|
||||
@ -120,6 +120,13 @@ export type NodeViewRenderer = (props: NodeViewRendererProps) => (NodeView | {})
|
||||
|
||||
export type ValuesOf<T> = T[keyof T];
|
||||
export type KeysWithTypeOf<T, Type> = ({[P in keyof T]: T[P] extends Type ? P : never })[keyof T]
|
||||
export type UnionCommands = UnionToIntersection<ValuesOf<Pick<AllCommands, KeysWithTypeOf<AllCommands, {}>>>>
|
||||
|
||||
export type Commands = {
|
||||
[Item in keyof UnionCommands]: UnionCommands[Item] extends (...args: any[]) => any
|
||||
? (...args: Parameters<UnionCommands[Item]>) => Command
|
||||
: never
|
||||
}
|
||||
|
||||
export type SingleCommands = {
|
||||
[Item in keyof Commands]: Commands[Item] extends (...args: any[]) => any
|
||||
|
@ -8,7 +8,8 @@ export interface BlockquoteOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
blockQuote: {
|
||||
/**
|
||||
* Set a blockquote node
|
||||
*/
|
||||
@ -22,6 +23,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetBlockquote: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /^\s*>\s$/gm
|
||||
|
@ -13,7 +13,8 @@ export interface BoldOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
bold: {
|
||||
/**
|
||||
* Set a bold mark
|
||||
*/
|
||||
@ -27,6 +28,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetBold: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const starInputRegex = /(?:^|\s)((?:\*\*)((?:[^*]+))(?:\*\*))$/gm
|
||||
|
@ -8,12 +8,14 @@ export interface BulletListOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
bulletList: {
|
||||
/**
|
||||
* Toggle a bullet list
|
||||
*/
|
||||
toggleBulletList: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /^\s*([-+*])\s$/
|
||||
|
@ -9,7 +9,8 @@ export interface CodeBlockOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
codeBlock: {
|
||||
/**
|
||||
* Set a code block
|
||||
*/
|
||||
@ -19,6 +20,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
toggleCodeBlock: (attributes?: { language: string }) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const backtickInputRegex = /^```(?<language>[a-z]*)? $/
|
||||
|
@ -13,7 +13,8 @@ export interface CodeOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
code: {
|
||||
/**
|
||||
* Set a code mark
|
||||
*/
|
||||
@ -27,6 +28,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetCode: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /(?:^|\s)((?:`)((?:[^`]+))(?:`))$/gm
|
||||
|
@ -9,12 +9,14 @@ export interface CollaborationCursorOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
collaborationCursor: {
|
||||
/**
|
||||
* Update details of the current user
|
||||
*/
|
||||
user: (attributes: AnyObject) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const awarenessStatesToArray = (states: Map<number, { [key: string]: any }>) => {
|
||||
|
@ -7,7 +7,8 @@ import {
|
||||
} from 'y-prosemirror'
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
collaboration: {
|
||||
/**
|
||||
* Undo recent changes
|
||||
*/
|
||||
@ -17,6 +18,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
redo: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export interface CollaborationOptions {
|
||||
|
@ -6,7 +6,8 @@ type FontFamilyOptions = {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
fontFamily: {
|
||||
/**
|
||||
* Set the font family
|
||||
*/
|
||||
@ -16,6 +17,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetFontFamily: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const FontFamily = Extension.create<FontFamilyOptions>({
|
||||
|
@ -8,12 +8,14 @@ export interface HardBreakOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
hardBreak: {
|
||||
/**
|
||||
* Add a hard break
|
||||
*/
|
||||
setHardBreak: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const HardBreak = Node.create<HardBreakOptions>({
|
||||
|
@ -11,7 +11,8 @@ export interface HeadingOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
heading: {
|
||||
/**
|
||||
* Set a heading node
|
||||
*/
|
||||
@ -21,6 +22,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
toggleHeading: (attributes: { level: Level }) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const Heading = Node.create<HeadingOptions>({
|
||||
|
@ -14,7 +14,8 @@ export interface HighlightOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
highlight: {
|
||||
/**
|
||||
* Set a highlight mark
|
||||
*/
|
||||
@ -28,6 +29,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetHighlight: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /(?:^|\s)((?:==)((?:[^~]+))(?:==))$/gm
|
||||
|
@ -7,7 +7,8 @@ export interface HistoryOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
history: {
|
||||
/**
|
||||
* Undo recent changes
|
||||
*/
|
||||
@ -17,6 +18,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
redo: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const History = Extension.create<HistoryOptions>({
|
||||
|
@ -12,12 +12,14 @@ export interface HorizontalRuleOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
horizontalRule: {
|
||||
/**
|
||||
* Add a horizontal rule
|
||||
*/
|
||||
setHorizontalRule: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const HorizontalRule = Node.create<HorizontalRuleOptions>({
|
||||
|
@ -13,12 +13,14 @@ export interface ImageOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
image: {
|
||||
/**
|
||||
* Add an image
|
||||
*/
|
||||
setImage: (options: { src: string, alt?: string, title?: string }) => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /!\[(.+|:?)]\((\S+)(?:(?:\s+)["'](\S+)["'])?\)/
|
||||
|
@ -13,7 +13,8 @@ export interface ItalicOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
italic: {
|
||||
/**
|
||||
* Set an italic mark
|
||||
*/
|
||||
@ -27,6 +28,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetItalic: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const starInputRegex = /(?:^|\s)((?:\*)((?:[^*]+))(?:\*))$/gm
|
||||
|
@ -14,7 +14,8 @@ export interface LinkOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
link: {
|
||||
/**
|
||||
* Set a link mark
|
||||
*/
|
||||
@ -28,6 +29,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetLink: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const pasteRegex = /https?:\/\/(?:www\.)?[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z]{2,}\b(?:[-a-zA-Z0-9@:%._+~#=?!&/]*)(?:[-a-zA-Z0-9@:%._+~#=?!&/]*)/gi
|
||||
|
@ -8,12 +8,14 @@ export interface OrderedListOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
orderedList: {
|
||||
/**
|
||||
* Toggle an ordered list
|
||||
*/
|
||||
toggleOrderedList: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /^(\d+)\.\s$/
|
||||
|
@ -7,12 +7,14 @@ export interface ParagraphOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
paragraph: {
|
||||
/**
|
||||
* Toggle a paragraph
|
||||
*/
|
||||
setParagraph: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const Paragraph = Node.create<ParagraphOptions>({
|
||||
|
@ -13,7 +13,8 @@ export interface StrikeOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
strike: {
|
||||
/**
|
||||
* Set a strike mark
|
||||
*/
|
||||
@ -27,6 +28,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetStrike: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const inputRegex = /(?:^|\s)((?:~~)((?:[^~]+))(?:~~))$/gm
|
||||
|
@ -42,7 +42,8 @@ export interface TableOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
table: {
|
||||
insertTable: (options?: { rows?: number, cols?: number, withHeaderRow?: boolean }) => Command,
|
||||
addColumnBefore: () => Command,
|
||||
addColumnAfter: () => Command,
|
||||
@ -62,6 +63,7 @@ declare module '@tiptap/core' {
|
||||
goToPreviousCell: () => Command,
|
||||
fixTables: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const Table = Node.create<TableOptions>({
|
||||
|
@ -7,12 +7,14 @@ export interface TaskListOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
taskList: {
|
||||
/**
|
||||
* Toggle a task list
|
||||
*/
|
||||
toggleTaskList: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const TaskList = Node.create<TaskListOptions>({
|
||||
|
@ -7,7 +7,8 @@ type TextAlignOptions = {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
textAlign: {
|
||||
/**
|
||||
* Set the text align attribute
|
||||
*/
|
||||
@ -17,6 +18,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetTextAlign: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const TextAlign = Extension.create<TextAlignOptions>({
|
||||
|
@ -12,12 +12,14 @@ export interface TextStyleOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
textStyle: {
|
||||
/**
|
||||
* Remove spans without inline style attributes.
|
||||
*/
|
||||
removeEmptyTextStyle: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const TextStyle = Mark.create<TextStyleOptions>({
|
||||
|
@ -7,7 +7,8 @@ export interface UnderlineOptions {
|
||||
}
|
||||
|
||||
declare module '@tiptap/core' {
|
||||
interface Commands {
|
||||
interface AllCommands {
|
||||
underline: {
|
||||
/**
|
||||
* Set an underline mark
|
||||
*/
|
||||
@ -21,6 +22,7 @@ declare module '@tiptap/core' {
|
||||
*/
|
||||
unsetUnderline: () => Command,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export const Underline = Mark.create<UnderlineOptions>({
|
||||
|
Loading…
Reference in New Issue
Block a user