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

feat(richtext-lexical): make decoratorNodes and blocks selectable. Centralize selection and deletion logic #10735

Merged
merged 7 commits into from
Jan 22, 2025
Merged

feat(richtext-lexical): make decoratorNodes and blocks selectable. Centralize selection and deletion logic #10735

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a1b8f57
save WIP - ended adding PR in lexical repo
GermanJablo Jan 20, 2025
15ab1fa
probably finished PR, missing tests
GermanJablo Jan 22, 2025
eba1463
add e2e test
GermanJablo Jan 22, 2025
5eba92c
Merge remote-tracking branch 'origin/main' into issue-10634-temp
GermanJablo Jan 22, 2025
d28e6e7
fix monaco. Add opt-out class
GermanJablo Jan 22, 2025
2f8ae93
clean _community
GermanJablo Jan 22, 2025
b2a025b
fix incorrect triggers of selection
GermanJablo Jan 22, 2025
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
4 changes: 4 additions & 0 deletions packages/richtext-lexical/src/features/blocks/client/component/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
z-index: 1;
}

[data-lexical-decorator='true']:has(.lexical-block) {
width: auto;
}

.lexical-block-not-found {
color: var(--theme-error-500);
font-size: 1.1rem;
Expand Down
9 changes: 2 additions & 7 deletions packages/richtext-lexical/src/features/blocks/client/componentInline/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
@layer payload-default {
.inline-block-container {
display: inline-block;
margin-right: base(0.2);
margin-left: base(0.2);
}

.inline-block.inline-block-not-found {
Expand All @@ -22,8 +24,6 @@
border-radius: $style-radius-s;
max-width: calc(var(--base) * 15);
font-family: var(--font-body);
margin-right: base(0.2);
margin-left: base(0.2);

&::selection {
background: transparent;
Expand All @@ -38,11 +38,6 @@
overflow: hidden;
}

&--selected {
background: var(--theme-success-100);
outline: 1px solid var(--theme-success-400);
}

&__editButton.btn {
margin: 0;
}
Expand Down
72 changes: 3 additions & 69 deletions packages/richtext-lexical/src/features/blocks/client/componentInline/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ const baseClass = 'inline-block'
import type { BlocksFieldClient, Data, FormState } from 'payload'

import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext'
import { useLexicalNodeSelection } from '@lexical/react/useLexicalNodeSelection'
import { mergeRegister } from '@lexical/utils'
import { getTranslation } from '@payloadcms/translations'
import {
Button,
Expand All @@ -24,15 +22,7 @@ import {
useTranslation,
} from '@payloadcms/ui'
import { abortAndIgnore } from '@payloadcms/ui/shared'
import {
$getNodeByKey,
$getSelection,
$isNodeSelection,
CLICK_COMMAND,
COMMAND_PRIORITY_LOW,
KEY_BACKSPACE_COMMAND,
KEY_DELETE_COMMAND,
} from 'lexical'
import { $getNodeByKey } from 'lexical'

import './index.scss'

Expand Down Expand Up @@ -116,7 +106,6 @@ export const InlineBlockComponent: React.FC<Props> = (props) => {
const { toggleDrawer } = useLexicalDrawer(drawerSlug, true)

const inlineBlockElemElemRef = useRef<HTMLDivElement | null>(null)
const [isSelected, setSelected, clearSelection] = useLexicalNodeSelection(nodeKey)
const { id, collectionSlug, getDocPreferences, globalSlug } = useDocumentInfo()

const componentMapRenderedBlockPath = `${schemaPath}.lexical_internal_feature.blocks.lexical_inline_blocks.${formData.blockType}`
Expand Down Expand Up @@ -153,56 +142,6 @@ export const InlineBlockComponent: React.FC<Props> = (props) => {
})
}, [editor, nodeKey])

const $onDelete = useCallback(
(event: KeyboardEvent) => {
const deleteSelection = $getSelection()
if (isSelected && $isNodeSelection(deleteSelection)) {
event.preventDefault()
editor.update(() => {
deleteSelection.getNodes().forEach((node) => {
if ($isInlineBlockNode(node)) {
node.remove()
}
})
})
}
return false
},
[editor, isSelected],
)
const onClick = useCallback(
(payload: MouseEvent) => {
const event = payload
// Check if inlineBlockElemElemRef.target or anything WITHIN inlineBlockElemElemRef.target was clicked
if (
event.target === inlineBlockElemElemRef.current ||
inlineBlockElemElemRef.current?.contains(event.target as Node)
) {
if (event.shiftKey) {
setSelected(!isSelected)
} else {
if (!isSelected) {
clearSelection()
setSelected(true)
}
}
return true
}

return false
},
[isSelected, setSelected, clearSelection],
)

useEffect(() => {
return mergeRegister(
editor.registerCommand<MouseEvent>(CLICK_COMMAND, onClick, COMMAND_PRIORITY_LOW),

editor.registerCommand(KEY_DELETE_COMMAND, $onDelete, COMMAND_PRIORITY_LOW),
editor.registerCommand(KEY_BACKSPACE_COMMAND, $onDelete, COMMAND_PRIORITY_LOW),
)
}, [clearSelection, editor, isSelected, nodeKey, $onDelete, setSelected, onClick])

const blockDisplayName = clientBlock?.labels?.singular
? getTranslation(clientBlock?.labels.singular, i18n)
: clientBlock?.slug
Expand Down Expand Up @@ -362,20 +301,15 @@ export const InlineBlockComponent: React.FC<Props> = (props) => {
() =>
({ children, className }: { children: React.ReactNode; className?: string }) => (
<div
className={[
baseClass,
baseClass + '-' + formData.blockType,
isSelected && `${baseClass}--selected`,
className,
]
className={[baseClass, baseClass + '-' + formData.blockType, className]
.filter(Boolean)
.join(' ')}
ref={inlineBlockElemElemRef}
>
{children}
</div>
),
[formData.blockType, isSelected],
[formData.blockType],
)

const Label = useMemo(() => {
Expand Down
85 changes: 0 additions & 85 deletions packages/richtext-lexical/src/features/horizontalRule/client/component/index.tsx
View file
Open in desktop

This file was deleted.

10 changes: 2 additions & 8 deletions packages/richtext-lexical/src/features/horizontalRule/client/nodes/HorizontalRuleNode.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,6 @@ import type { SerializedHorizontalRuleNode } from '../../server/nodes/Horizontal

import { HorizontalRuleServerNode } from '../../server/nodes/HorizontalRuleNode.js'

const HorizontalRuleComponent = React.lazy(() =>
import('../../client/component/index.js').then((module) => ({
default: module.HorizontalRuleComponent,
})),
)

export class HorizontalRuleNode extends HorizontalRuleServerNode {
static override clone(node: HorizontalRuleServerNode): HorizontalRuleServerNode {
return super.clone(node)
Expand All @@ -33,8 +27,8 @@ export class HorizontalRuleNode extends HorizontalRuleServerNode {
/**
* Allows you to render a React component within whatever createDOM returns.
*/
override decorate(): React.ReactElement {
return <HorizontalRuleComponent nodeKey={this.__key} />
override decorate() {
return null
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HorizontalRuleComponent doesn't do anything anymore. It used to be responsible for node selection and deletion, but that is now done in DecoratorPlugin.

}

override exportJSON(): SerializedLexicalNode {
Expand Down
1 change: 1 addition & 0 deletions packages/richtext-lexical/src/features/horizontalRule/client/plugin/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

@layer payload-default {
.LexicalEditorTheme__hr {
width: auto !important;
padding: 2px 2px;
border: none;
margin: 1rem 0;
Expand Down
77 changes: 4 additions & 73 deletions ...es/richtext-lexical/src/features/relationship/client/components/RelationshipComponent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,16 @@
import type { ElementFormatType } from 'lexical'

import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext.js'
import { useLexicalNodeSelection } from '@lexical/react/useLexicalNodeSelection.js'
import { mergeRegister } from '@lexical/utils'
import { getTranslation } from '@payloadcms/translations'
import { Button, useConfig, usePayloadAPI, useTranslation } from '@payloadcms/ui'
import {
$getNodeByKey,
$getSelection,
$isNodeSelection,
CLICK_COMMAND,
COMMAND_PRIORITY_LOW,
KEY_BACKSPACE_COMMAND,
KEY_DELETE_COMMAND,
} from 'lexical'
import React, { useCallback, useEffect, useReducer, useRef, useState } from 'react'
import { $getNodeByKey } from 'lexical'
import React, { useCallback, useReducer, useRef, useState } from 'react'

import type { RelationshipData } from '../../server/nodes/RelationshipNode.js'

import { useEditorConfigContext } from '../../../../lexical/config/client/EditorConfigProvider.js'
import { useLexicalDocumentDrawer } from '../../../../utilities/fieldsDrawer/useLexicalDocumentDrawer.js'
import { INSERT_RELATIONSHIP_WITH_DRAWER_COMMAND } from '../drawer/commands.js'
import { $isRelationshipNode } from '../nodes/RelationshipNode.js'
import './index.scss'

const baseClass = 'lexical-relationship'
Expand Down Expand Up @@ -53,7 +42,6 @@ const Component: React.FC<Props> = (props) => {
const relationshipElemRef = useRef<HTMLDivElement | null>(null)

const [editor] = useLexicalComposerContext()
const [isSelected, setSelected, clearSelection] = useLexicalNodeSelection(nodeKey!)
const {
fieldProps: { readOnly },
} = useEditorConfigContext()
Expand All @@ -65,9 +53,7 @@ const Component: React.FC<Props> = (props) => {
getEntityConfig,
} = useConfig()

const [relatedCollection, setRelatedCollection] = useState(() =>
getEntityConfig({ collectionSlug: relationTo }),
)
const [relatedCollection] = useState(() => getEntityConfig({ collectionSlug: relationTo }))

const { i18n, t } = useTranslation()
const [cacheBust, dispatchCacheBust] = useReducer((state) => state + 1, 0)
Expand Down Expand Up @@ -97,63 +83,8 @@ const Component: React.FC<Props> = (props) => {
dispatchCacheBust()
}, [cacheBust, setParams, closeDocumentDrawer])

const $onDelete = useCallback(
(payload: KeyboardEvent) => {
const deleteSelection = $getSelection()
if (isSelected && $isNodeSelection(deleteSelection)) {
const event: KeyboardEvent = payload
event.preventDefault()
editor.update(() => {
deleteSelection.getNodes().forEach((node) => {
if ($isRelationshipNode(node)) {
node.remove()
}
})
})
}
return false
},
[editor, isSelected],
)
const onClick = useCallback(
(payload: MouseEvent) => {
const event = payload
// Check if relationshipElemRef.target or anything WITHIN relationshipElemRef.target was clicked
if (
event.target === relationshipElemRef.current ||
relationshipElemRef.current?.contains(event.target as Node)
) {
if (event.shiftKey) {
setSelected(!isSelected)
} else {
if (!isSelected) {
clearSelection()
setSelected(true)
}
}
return true
}

return false
},
[isSelected, setSelected, clearSelection],
)

useEffect(() => {
return mergeRegister(
editor.registerCommand<MouseEvent>(CLICK_COMMAND, onClick, COMMAND_PRIORITY_LOW),

editor.registerCommand(KEY_DELETE_COMMAND, $onDelete, COMMAND_PRIORITY_LOW),
editor.registerCommand(KEY_BACKSPACE_COMMAND, $onDelete, COMMAND_PRIORITY_LOW),
)
}, [clearSelection, editor, isSelected, nodeKey, $onDelete, setSelected, onClick])

return (
<div
className={[baseClass, isSelected && `${baseClass}--selected`].filter(Boolean).join(' ')}
contentEditable={false}
ref={relationshipElemRef}
>
<div className={baseClass} contentEditable={false} ref={relationshipElemRef}>
<div className={`${baseClass}__wrap`}>
<p className={`${baseClass}__label`}>
{t('fields:labelRelationship', {
Expand Down
5 changes: 0 additions & 5 deletions packages/richtext-lexical/src/features/relationship/client/components/index.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,6 @@
overflow: hidden;
}

&--selected {
box-shadow: $focus-box-shadow;
outline: none;
}

&__doc-drawer-toggler {
text-decoration: underline;
pointer-events: all;
Expand Down
Loading
Loading