Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make Vue 2 nodeViewProps compatible with @vue/composition-api #4123

Merged
merged 3 commits into from
Jul 10, 2023
Merged

Make Vue 2 nodeViewProps compatible with @vue/composition-api #4123

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05209c5
Add `vue-ts-types` as dependency for `@tiptap/vue-2`
FloEdelmann Jun 13, 2023
506ff9c
Use `vue-ts-types` for Vue 2 `nodeViewProps`
FloEdelmann Jun 13, 2023
2533e05
Merge branch 'develop' into vue-2-node-view-props
FloEdelmann Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion packages/vue-2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
],
"dependencies": {
"@tiptap/extension-bubble-menu": "^2.1.0-rc.8",
"@tiptap/extension-floating-menu": "^2.1.0-rc.8"
"@tiptap/extension-floating-menu": "^2.1.0-rc.8",
"vue-ts-types": "^1.6.0"
},
"devDependencies": {
"@tiptap/core": "^2.1.0-rc.8",
Expand Down
43 changes: 10 additions & 33 deletions packages/vue-2/src/VueNodeViewRenderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,44 +9,21 @@ import {
import { Node as ProseMirrorNode } from '@tiptap/pm/model'
import { Decoration, NodeView as ProseMirrorNodeView } from '@tiptap/pm/view'
import Vue from 'vue'
import { PropType, VueConstructor } from 'vue/types/umd'
import { VueConstructor } from 'vue/types/umd'
import { booleanProp, functionProp, objectProp } from 'vue-ts-types'

import { Editor } from './Editor'
import { VueRenderer } from './VueRenderer'

export const nodeViewProps = {
editor: {
type: Object as PropType<NodeViewProps['editor']>,
required: true as const,
},
node: {
type: Object as PropType<NodeViewProps['node']>,
required: true as const,
},
decorations: {
type: Object as PropType<NodeViewProps['decorations']>,
required: true as const,
},
selected: {
type: Boolean as PropType<NodeViewProps['selected']>,
required: true as const,
},
extension: {
type: Object as PropType<NodeViewProps['extension']>,
required: true as const,
},
getPos: {
type: Function as PropType<NodeViewProps['getPos']>,
required: true as const,
},
updateAttributes: {
type: Function as PropType<NodeViewProps['updateAttributes']>,
required: true as const,
},
deleteNode: {
type: Function as PropType<NodeViewProps['deleteNode']>,
required: true as const,
},
editor: objectProp<NodeViewProps['editor']>().required,
node: objectProp<NodeViewProps['node']>().required,
decorations: objectProp<NodeViewProps['decorations']>().required,
selected: booleanProp().required,
extension: objectProp<NodeViewProps['extension']>().required,
getPos: functionProp<NodeViewProps['getPos']>().required,
updateAttributes: functionProp<NodeViewProps['updateAttributes']>().required,
deleteNode: functionProp<NodeViewProps['deleteNode']>().required,
}

export interface VueNodeViewRendererOptions extends NodeViewRendererOptions {
Expand Down