webapp/src/components/Editor/Editor.tsx

365 lines
14 KiB
TypeScript
Raw Normal View History

import { HocuspocusProvider } from '@hocuspocus/provider'
2024-10-08 19:50:58 +00:00
import { UploadFile } from '@solid-primitives/upload'
import { Editor, EditorOptions, isTextSelection } from '@tiptap/core'
2023-03-08 16:35:13 +00:00
import { BubbleMenu } from '@tiptap/extension-bubble-menu'
import { CharacterCount } from '@tiptap/extension-character-count'
import { Collaboration } from '@tiptap/extension-collaboration'
import { CollaborationCursor } from '@tiptap/extension-collaboration-cursor'
import { FloatingMenu } from '@tiptap/extension-floating-menu'
import { Placeholder } from '@tiptap/extension-placeholder'
2024-10-10 23:20:23 +00:00
import { Accessor, createEffect, createMemo, createSignal, on, onCleanup, onMount } from 'solid-js'
2024-10-09 10:40:20 +00:00
import { isServer } from 'solid-js/web'
2024-10-10 23:20:23 +00:00
import { createEditorTransaction, createTiptapEditor } from 'solid-tiptap'
import uniqolor from 'uniqolor'
2024-10-08 19:50:58 +00:00
import { Doc } from 'yjs'
import { useEditorContext } from '~/context/editor'
import { useLocalize } from '~/context/localize'
import { useSession } from '~/context/session'
2024-06-24 17:50:27 +00:00
import { useSnackbar } from '~/context/ui'
2024-09-15 16:41:02 +00:00
import { Author } from '~/graphql/schema/core.gen'
2024-09-24 06:48:39 +00:00
import { base, custom, extended } from '~/lib/editorExtensions'
2024-07-05 14:08:12 +00:00
import { handleImageUpload } from '~/lib/handleImageUpload'
2024-10-01 19:52:45 +00:00
import { allowedImageTypes, renderUploadedImage } from '../Upload/renderUploadedImage'
2024-10-01 19:39:17 +00:00
import { BlockquoteBubbleMenu } from './Toolbar/BlockquoteBubbleMenu'
import { EditorFloatingMenu } from './Toolbar/EditorFloatingMenu'
import { FigureBubbleMenu } from './Toolbar/FigureBubbleMenu'
2024-10-10 23:20:23 +00:00
import { FullBubbleMenu } from './Toolbar/FullBubbleMenu'
2024-10-01 19:39:17 +00:00
import { IncutBubbleMenu } from './Toolbar/IncutBubbleMenu'
2024-10-10 23:20:23 +00:00
import styles from './Editor.module.scss'
2023-03-08 16:35:13 +00:00
2024-09-16 00:09:07 +00:00
export type EditorComponentProps = {
shoutId: number
2023-03-08 16:35:13 +00:00
initialContent?: string
2023-03-23 17:15:50 +00:00
onChange: (text: string) => void
2023-03-08 16:35:13 +00:00
}
2023-05-05 20:05:50 +00:00
const yDocs: Record<string, Doc> = {}
2023-03-29 15:36:12 +00:00
const providers: Record<string, HocuspocusProvider> = {}
2023-03-08 16:35:13 +00:00
2024-09-16 00:09:07 +00:00
export const EditorComponent = (props: EditorComponentProps) => {
2023-03-08 16:35:13 +00:00
const { t } = useLocalize()
2024-10-08 19:50:58 +00:00
const { session, requireAuthentication } = useSession()
2024-06-24 17:50:27 +00:00
const author = createMemo<Author>(() => session()?.user?.app_data?.profile as Author)
const [isCommonMarkup, setIsCommonMarkup] = createSignal(false)
const [shouldShowTextBubbleMenu, setShouldShowTextBubbleMenu] = createSignal(false)
2024-02-04 17:40:15 +00:00
const { showSnackbar } = useSnackbar()
2024-10-11 01:55:18 +00:00
const { countWords, setEditing, isCollabMode } = useEditorContext()
2024-09-19 16:51:56 +00:00
const [editorOptions, setEditorOptions] = createSignal<Partial<EditorOptions>>({})
2024-09-15 23:41:48 +00:00
const [editorElRef, setEditorElRef] = createSignal<HTMLElement | undefined>()
const [textBubbleMenuRef, setTextBubbleMenuRef] = createSignal<HTMLDivElement | undefined>()
2024-10-08 19:50:58 +00:00
const [incutBubbleMenuRef, setIncutBubbleMenuRef] = createSignal<HTMLDivElement | undefined>()
const [figureBubbleMenuRef, setFigureBubbleMenuRef] = createSignal<HTMLDivElement | undefined>()
const [blockquoteBubbleMenuRef, setBlockquoteBubbleMenuRef] = createSignal<HTMLDivElement | undefined>()
2024-09-15 23:41:48 +00:00
const [floatingMenuRef, setFloatingMenuRef] = createSignal<HTMLDivElement | undefined>()
2024-10-08 19:50:58 +00:00
const [editor, setEditor] = createSignal<Editor | null>(null)
const [menusInitialized, setMenusInitialized] = createSignal(false)
// store tiptap editor in context provider's signal to use it in Panel
createEffect(() => setEditing(editor() || undefined))
/**
* Создает экземпляр редактора с заданными опциями
* @param opts Опции редактора
*/
const createEditorInstance = (opts?: Partial<EditorOptions>) => {
if (!opts?.element) {
console.error('Editor options or element is missing')
return
}
console.log('stage 2: create editor instance without menus', opts)
2024-10-09 10:40:20 +00:00
const old = editor() || { options: {} as EditorOptions }
const uniqueExtensions = [
...new Map(
[...(old?.options?.extensions || []), ...(opts?.extensions || [])].map((ext) => [ext.name, ext])
).values()
]
2024-10-08 19:50:58 +00:00
const fresh = createTiptapEditor(() => ({
...old?.options,
...opts,
2024-10-09 10:40:20 +00:00
element: opts.element as HTMLElement,
extensions: uniqueExtensions
2024-10-08 19:50:58 +00:00
}))
if (old instanceof Editor) old?.destroy()
setEditor(fresh() || null)
}
const handleClipboardPaste = async () => {
try {
2024-10-08 19:50:58 +00:00
const clipboardItems: ClipboardItems = await navigator.clipboard.read()
if (clipboardItems.length === 0) return
const [clipboardItem] = clipboardItems
const { types } = clipboardItem
2024-10-08 19:50:58 +00:00
const imageType: string | undefined = types.find((type) => allowedImageTypes.has(type))
if (!imageType) return
const blob = await clipboardItem.getType(imageType)
const extension = imageType.split('/')[1]
const file = new File([blob], `clipboardImage.${extension}`)
2024-10-08 19:50:58 +00:00
const uplFile: UploadFile = {
source: blob.toString(),
name: file.name,
size: file.size,
2024-06-26 08:22:05 +00:00
file
}
showSnackbar({ body: t('Uploading image') })
2024-10-08 19:50:58 +00:00
const image: { url: string; originalFilename?: string } = await handleImageUpload(
uplFile,
session()?.access_token || ''
)
2024-09-15 16:41:02 +00:00
renderUploadedImage(editor() as Editor, image)
} catch (error) {
console.error('[Paste Image Error]:', error)
}
2024-09-19 16:51:56 +00:00
return false
}
2024-10-08 19:50:58 +00:00
// stage 0: update editor options
const setupEditor = () => {
console.log('stage 0: update editor options')
const options: Partial<EditorOptions> = {
element: editorElRef()!,
editorProps: {
2024-10-10 23:20:23 +00:00
attributes: { class: styles.articleEditor },
2024-10-08 19:50:58 +00:00
transformPastedHTML: (c: string) => c.replaceAll(/<img.*?>/g, ''),
2024-10-10 23:20:23 +00:00
handlePaste: () => {
handleClipboardPaste().then((_) => 0)
2024-09-19 16:51:56 +00:00
}
2024-10-08 19:50:58 +00:00
},
extensions: [
...base,
...custom,
...extended,
Placeholder.configure({
placeholder: t('Add a link or click plus to embed media')
}),
CharacterCount.configure()
],
onTransaction({ transaction, editor }) {
if (transaction.docChanged) {
const html = editor.getHTML()
html && props.onChange(html)
const wordCount: number = editor.storage.characterCount.words()
const charsCount: number = editor.storage.characterCount.characters()
wordCount && countWords({ words: wordCount, characters: charsCount })
}
},
content: props.initialContent ?? null
}
2024-10-09 10:40:20 +00:00
console.log(options)
2024-10-08 19:50:58 +00:00
setEditorOptions(() => options)
2024-10-11 01:55:18 +00:00
return options
2024-10-08 19:50:58 +00:00
}
// stage 1: create editor options when got author profile
createEffect(
on([editorOptions, author], ([opts, a]: [Partial<EditorOptions> | undefined, Author | undefined]) => {
if (isServer) return
console.log('stage 1: create editor options when got author profile', { opts, a })
const noOptions = !opts || Object.keys(opts).length === 0
noOptions && a && setTimeout(setupEditor, 1)
2024-09-19 16:51:56 +00:00
})
2024-09-15 23:41:48 +00:00
)
2024-10-10 23:20:23 +00:00
const isFigcaptionActive = createEditorTransaction(editor as Accessor<Editor | undefined>, (e) =>
e?.isActive('figcaption')
)
createEffect(() => setIsCommonMarkup(!!isFigcaptionActive()))
2024-10-08 19:50:58 +00:00
const initializeMenus = () => {
if (menusInitialized() || !editor()) return
2024-10-09 10:40:20 +00:00
if (blockquoteBubbleMenuRef() && figureBubbleMenuRef() && incutBubbleMenuRef() && floatingMenuRef()) {
console.log('stage 3: initialize menus when editor instance is ready')
const menus = [
BubbleMenu.configure({
pluginKey: 'textBubbleMenu',
element: textBubbleMenuRef()!,
2024-10-10 23:20:23 +00:00
shouldShow: ({ editor: e, state: { doc, selection }, from, to }) => {
2024-10-09 14:11:00 +00:00
const isEmptyTextBlock = doc.textBetween(from, to).length === 0 && isTextSelection(selection)
if (isEmptyTextBlock) {
e?.chain().focus().removeTextWrap({ class: 'highlight-fake-selection' }).run()
}
const hasSelection = !selection.empty && from !== to
2024-10-09 14:11:00 +00:00
const isFootnoteOrFigcaption =
e.isActive('footnote') || (e.isActive('figcaption') && hasSelection)
const result =
2024-10-10 23:20:23 +00:00
e.isFocused &&
2024-10-09 14:11:00 +00:00
hasSelection &&
!e.isActive('image') &&
!e.isActive('figure') &&
(isFootnoteOrFigcaption || !e.isActive('figcaption'))
2024-10-09 14:11:00 +00:00
setShouldShowTextBubbleMenu(result)
return result
},
tippyOptions: {
2024-10-09 14:11:00 +00:00
sticky: true
// onHide: () => { editor()?.commands.focus() }
}
}),
BubbleMenu.configure({
pluginKey: 'blockquoteBubbleMenu',
element: blockquoteBubbleMenuRef()!,
2024-10-09 14:11:00 +00:00
shouldShow: ({ editor: e, state: { selection } }) =>
e.isFocused && !selection.empty && e.isActive('blockquote'),
tippyOptions: {
offset: [0, 0],
placement: 'top',
getReferenceClientRect: () => {
const selectedElement = editor()?.view.dom.querySelector('.has-focus')
return selectedElement?.getBoundingClientRect() || new DOMRect()
}
}
}),
BubbleMenu.configure({
pluginKey: 'figureBubbleMenu',
element: figureBubbleMenuRef()!,
shouldShow: ({ editor: e, view }) => view.hasFocus() && e.isActive('figure')
}),
BubbleMenu.configure({
pluginKey: 'incutBubbleMenu',
element: incutBubbleMenuRef()!,
2024-10-09 14:11:00 +00:00
shouldShow: ({ editor: e, state: { selection } }) =>
e.isFocused && !selection.empty && e.isActive('figcaption'),
tippyOptions: {
offset: [0, -16],
placement: 'top',
getReferenceClientRect: () => {
const selectedElement = editor()?.view.dom.querySelector('.has-focus')
return selectedElement?.getBoundingClientRect() || new DOMRect()
2024-10-09 14:11:00 +00:00
}
}
}),
FloatingMenu.configure({
element: floatingMenuRef()!,
pluginKey: 'floatingMenu',
shouldShow: ({ editor: e, state: { selection } }) => {
const { $anchor, empty } = selection
const isRootDepth = $anchor.depth === 1
if (!(isRootDepth && empty)) return false
return !(e.isActive('codeBlock') || e.isActive('heading'))
},
tippyOptions: {
2024-10-09 14:11:00 +00:00
placement: 'left'
}
})
2024-10-08 19:50:58 +00:00
]
2024-10-09 10:40:20 +00:00
setEditorOptions((prev) => ({ ...prev, extensions: [...(prev.extensions || []), ...menus] }))
2024-10-08 19:50:58 +00:00
setMenusInitialized(true)
} else {
console.error('Some menu references are missing')
}
}
const initializeCollaboration = () => {
if (!editor()) {
console.error('Editor is not initialized')
return
}
2024-10-11 01:55:18 +00:00
setEditorOptions((prev: Partial<EditorOptions>) => {
const extensions = [...(prev.extensions || [])]
2024-10-08 19:50:58 +00:00
2024-10-11 01:55:18 +00:00
try {
if (!isCollabMode()) {
// Remove collaboration extensions and return
2024-10-09 10:40:20 +00:00
const filteredExtensions = extensions.filter(
(ext) => ext.name !== 'collaboration' && ext.name !== 'collaborationCursor'
)
return { ...prev, extensions: filteredExtensions }
}
2024-10-11 01:55:18 +00:00
const docName = `shout-${props.shoutId}`
const token = session()?.access_token || ''
const profile = author()
if (!(token && profile)) {
throw new Error('Missing authentication data')
}
if (!yDocs[docName]) {
yDocs[docName] = new Doc()
}
if (!providers[docName]) {
providers[docName] = new HocuspocusProvider({
url: 'wss://hocuspocus.discours.io',
name: docName,
document: yDocs[docName],
token
})
console.log(`HocuspocusProvider установлен для ${docName}`)
}
2024-10-08 19:50:58 +00:00
extensions.push(
Collaboration.configure({ document: yDocs[docName] }),
CollaborationCursor.configure({
provider: providers[docName],
user: { name: profile.name, color: uniqolor(profile.slug).color }
})
)
2024-10-11 01:55:18 +00:00
} catch (error) {
console.error('Error initializing collaboration:', error)
showSnackbar({ body: t('Failed to initialize collaboration') })
}
console.log('collab extensions added:', extensions)
return { ...prev, extensions }
})
2024-10-08 19:50:58 +00:00
}
const handleFocus = (event: FocusEvent) => {
console.log('handling focus event', event)
if (editor()?.isActive('figcaption')) {
editor()?.commands.focus()
console.log('active figcaption detected, focusing editor')
}
}
2024-10-11 01:55:18 +00:00
onMount(() => {
console.log('Editor component mounted')
editorElRef()?.addEventListener('focus', handleFocus)
requireAuthentication(() => {
setTimeout(() => {
const opts = setupEditor()
createEditorInstance(opts)
initializeMenus()
}, 120)
}, 'edit')
})
// collab mode on/off
2024-10-11 01:55:29 +00:00
createEffect(on(isCollabMode, (x) => !x && initializeCollaboration(), { defer: true }))
2024-10-09 10:40:20 +00:00
onCleanup(() => {
2024-10-08 19:50:58 +00:00
editorElRef()?.removeEventListener('focus', handleFocus)
2024-01-25 19:16:38 +00:00
editor()?.destroy()
})
2023-03-08 16:35:13 +00:00
return (
<>
2023-08-23 22:31:39 +00:00
<div class="row">
<div class="col-md-5" />
2023-08-23 22:31:39 +00:00
<div class="col-md-12">
2024-06-24 17:50:27 +00:00
<div ref={setEditorElRef} id="editorBody" />
2023-08-23 22:31:39 +00:00
</div>
</div>
2024-10-08 19:50:58 +00:00
2024-10-10 23:20:23 +00:00
<FullBubbleMenu
shouldShow={shouldShowTextBubbleMenu}
2024-10-09 20:30:52 +00:00
isCommonMarkup={isCommonMarkup()}
2024-10-10 23:20:23 +00:00
editor={editor as Accessor<Editor | undefined>}
2024-10-09 20:30:52 +00:00
ref={setTextBubbleMenuRef}
/>
<BlockquoteBubbleMenu editor={editor() as Editor} ref={setBlockquoteBubbleMenuRef} />
<FigureBubbleMenu editor={editor() as Editor} ref={setFigureBubbleMenuRef} />
<IncutBubbleMenu editor={editor() as Editor} ref={setIncutBubbleMenuRef} />
<EditorFloatingMenu editor={editor() as Editor} ref={setFloatingMenuRef} />
</>
2023-03-08 16:35:13 +00:00
)
2024-10-09 14:11:00 +00:00
}