Don't rerender entire editor for user list

also fixes bug where you are the only person mentionable
This commit is contained in:
Sinclair Chen 2022-08-31 22:11:05 -07:00
parent 42548cea2a
commit cc8de39eff
2 changed files with 37 additions and 42 deletions

View File

@ -18,7 +18,6 @@ import { uploadImage } from 'web/lib/firebase/storage'
import { useMutation } from 'react-query' import { useMutation } from 'react-query'
import { FileUploadButton } from './file-upload-button' import { FileUploadButton } from './file-upload-button'
import { linkClass } from './site-link' import { linkClass } from './site-link'
import { useUsers } from 'web/hooks/use-users'
import { mentionSuggestion } from './editor/mention-suggestion' import { mentionSuggestion } from './editor/mention-suggestion'
import { DisplayMention } from './editor/mention' import { DisplayMention } from './editor/mention'
import Iframe from 'common/util/tiptap-iframe' import Iframe from 'common/util/tiptap-iframe'
@ -68,8 +67,6 @@ export function useTextEditor(props: {
}) { }) {
const { placeholder, max, defaultValue = '', disabled, simple } = props const { placeholder, max, defaultValue = '', disabled, simple } = props
const users = useUsers()
const editorClass = clsx( const editorClass = clsx(
proseClass, proseClass,
!simple && 'min-h-[6em]', !simple && 'min-h-[6em]',
@ -78,32 +75,27 @@ export function useTextEditor(props: {
'[&_.ProseMirror-selectednode]:outline-dotted [&_*]:outline-indigo-300' // selected img, emebeds '[&_.ProseMirror-selectednode]:outline-dotted [&_*]:outline-indigo-300' // selected img, emebeds
) )
const editor = useEditor( const editor = useEditor({
{ editorProps: { attributes: { class: editorClass } },
editorProps: { attributes: { class: editorClass } }, extensions: [
extensions: [ StarterKit.configure({
StarterKit.configure({ heading: simple ? false : { levels: [1, 2, 3] },
heading: simple ? false : { levels: [1, 2, 3] }, horizontalRule: simple ? false : {},
horizontalRule: simple ? false : {}, }),
}), Placeholder.configure({
Placeholder.configure({ placeholder,
placeholder, emptyEditorClass:
emptyEditorClass: 'before:content-[attr(data-placeholder)] before:text-slate-500 before:float-left before:h-0 cursor-text',
'before:content-[attr(data-placeholder)] before:text-slate-500 before:float-left before:h-0 cursor-text', }),
}), CharacterCount.configure({ limit: max }),
CharacterCount.configure({ limit: max }), simple ? DisplayImage : Image,
simple ? DisplayImage : Image, DisplayLink,
DisplayLink, DisplayMention.configure({ suggestion: mentionSuggestion }),
DisplayMention.configure({ Iframe,
suggestion: mentionSuggestion(users), TiptapTweet,
}), ],
Iframe, content: defaultValue,
TiptapTweet, })
],
content: defaultValue,
},
[!users.length] // passed as useEffect dependency. (re-render editor when users load, to update mention menu)
)
const upload = useUploadMutation(editor) const upload = useUploadMutation(editor)

View File

@ -1,21 +1,24 @@
import type { MentionOptions } from '@tiptap/extension-mention' import type { MentionOptions } from '@tiptap/extension-mention'
import { ReactRenderer } from '@tiptap/react' import { ReactRenderer } from '@tiptap/react'
import { User } from 'common/user'
import { searchInAny } from 'common/util/parse' import { searchInAny } from 'common/util/parse'
import { orderBy } from 'lodash' import { memoize, orderBy } from 'lodash'
import tippy from 'tippy.js' import tippy from 'tippy.js'
import { getUsers } from 'web/lib/firebase/users'
import { MentionList } from './mention-list' import { MentionList } from './mention-list'
type Suggestion = MentionOptions['suggestion'] type Suggestion = MentionOptions['suggestion']
const users = memoize(getUsers)
users() // prefetch
const beginsWith = (text: string, query: string) => const beginsWith = (text: string, query: string) =>
text.toLocaleLowerCase().startsWith(query.toLocaleLowerCase()) text.toLocaleLowerCase().startsWith(query.toLocaleLowerCase())
// copied from https://tiptap.dev/api/nodes/mention#usage // copied from https://tiptap.dev/api/nodes/mention#usage
export const mentionSuggestion = (users: User[]): Suggestion => ({ export const mentionSuggestion: Suggestion = {
items: ({ query }) => items: async ({ query }) =>
orderBy( orderBy(
users.filter((u) => searchInAny(query, u.username, u.name)), (await users()).filter((u) => searchInAny(query, u.username, u.name)),
[ [
(u) => [u.name, u.username].some((s) => beginsWith(s, query)), (u) => [u.name, u.username].some((s) => beginsWith(s, query)),
'followerCountCached', 'followerCountCached',
@ -38,7 +41,7 @@ export const mentionSuggestion = (users: User[]): Suggestion => ({
popup = tippy('body', { popup = tippy('body', {
getReferenceClientRect: props.clientRect as any, getReferenceClientRect: props.clientRect as any,
appendTo: () => document.body, appendTo: () => document.body,
content: component.element, content: component?.element,
showOnCreate: true, showOnCreate: true,
interactive: true, interactive: true,
trigger: 'manual', trigger: 'manual',
@ -46,27 +49,27 @@ export const mentionSuggestion = (users: User[]): Suggestion => ({
}) })
}, },
onUpdate(props) { onUpdate(props) {
component.updateProps(props) component?.updateProps(props)
if (!props.clientRect) { if (!props.clientRect) {
return return
} }
popup[0].setProps({ popup?.[0].setProps({
getReferenceClientRect: props.clientRect as any, getReferenceClientRect: props.clientRect as any,
}) })
}, },
onKeyDown(props) { onKeyDown(props) {
if (props.event.key === 'Escape') { if (props.event.key === 'Escape') {
popup[0].hide() popup?.[0].hide()
return true return true
} }
return (component.ref as any)?.onKeyDown(props) return (component?.ref as any)?.onKeyDown(props)
}, },
onExit() { onExit() {
popup[0].destroy() popup?.[0].destroy()
component.destroy() component?.destroy()
}, },
} }
}, },
}) }