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

Delete existing empty spans when leaving text edit mode #4266

Merged
merged 10 commits into from
Oct 2, 2023
Merged

Delete existing empty spans when leaving text edit mode #4266

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
426daec
delete existing empty spans
ruggi Sep 28, 2023
5f2cb10
Merge branch 'master' into fix/delete-existing-empty-spans
ruggi Sep 29, 2023
2c67e18
only remove spans
ruggi Sep 29, 2023
ebb4b12
helper
ruggi Sep 29, 2023
29b573f
delete if not styled and has no event handlers
ruggi Sep 29, 2023
2e637dd
style/handlers constraints
ruggi Sep 29, 2023
c467d45
update helper
ruggi Sep 29, 2023
5d69256
when content changes
ruggi Sep 29, 2023
4730c30
drop style constraint
ruggi Sep 29, 2023
d6cba5c
drop outdated test
ruggi Sep 29, 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
250 changes: 242 additions & 8 deletions editor/src/components/text-editor/text-editor.spec.browser2.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,177 @@ describe('Use the text editor', () => {
)`),
)
})
it('deletes existing span elements', async () => {
const editor = await renderTestEditorWithCode(
formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'

export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-uid='span'
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
}}
>
Hello
</span>
</Storyboard>
)
`),
'await-first-dom-report',
)

await enterTextEditMode(editor, 'start', 'span')

deleteTypedText()

await closeTextEditor()
await editor.getDispatchFollowUpActionsFinished()

expect(editor.getEditorState().editor.mode.type).toEqual('select')
expect(getPrintedUiJsCode(editor.getEditorState())).toEqual(
formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'

export var storyboard = (
<Storyboard data-uid='sb' />
)
`),
)
})
it('does not delete span elements with styling', async () => {
const editor = await renderTestEditorWithCode(
formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'

export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-uid='span'
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
border: '1px solid red',
}}
>
Hello
</span>
</Storyboard>
)
`),
'await-first-dom-report',
)

await enterTextEditMode(editor, 'start', 'span')

deleteTypedText()

await closeTextEditor()
await editor.getDispatchFollowUpActionsFinished()

expect(editor.getEditorState().editor.mode.type).toEqual('select')
expect(getPrintedUiJsCode(editor.getEditorState())).toEqual(
formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'

export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-uid='span'
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
border: '1px solid red',
}}
/>
</Storyboard>
)
`),
)
})
it('does not delete span elements with event handlers', async () => {
const editor = await renderTestEditorWithCode(
formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'

export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-uid='span'
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
}}
onClick={() => console.log('click')}
>
Hello
</span>
</Storyboard>
)
`),
'await-first-dom-report',
)

await enterTextEditMode(editor, 'start', 'span')

deleteTypedText()

await closeTextEditor()
await editor.getDispatchFollowUpActionsFinished()

expect(editor.getEditorState().editor.mode.type).toEqual('select')
expect(getPrintedUiJsCode(editor.getEditorState())).toEqual(
formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'

export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-uid='span'
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
}}
onClick={() => console.log('click')}
/>
</Storyboard>
)
`),
)
})
})
describe('collapses runs of text', () => {
it('only when the elements involved are eligible', async () => {
Expand Down Expand Up @@ -1797,23 +1968,26 @@ async function testModifierExpectingWayTooManySavesTheFirstTime(
return { before, after }
}

async function enterTextEditMode(editor: EditorRenderResult): Promise<void> {
async function enterTextEditMode(
editor: EditorRenderResult,
where: 'start' | 'end' = 'end',
testId: string = 'div',
): Promise<void> {
const canvasControlsLayer = editor.renderedDOM.getByTestId(CanvasControlsContainerID)
const div = editor.renderedDOM.getByTestId('div')
const divBounds = div.getBoundingClientRect()
const divCorner = {
x: divBounds.x + 50,
y: divBounds.y + 40,
const element = editor.renderedDOM.getByTestId(testId)
const bounds = element.getBoundingClientRect()
const corner = {
x: bounds.x + (where === 'start' ? 1 : 50),
y: bounds.y + (where === 'start' ? 1 : 40),
}

FOR_TESTS_setNextGeneratedUid('text-span')

await pressKey('t')
await editor.getDispatchFollowUpActionsFinished()
await mouseClickAtPoint(canvasControlsLayer, divCorner)
await mouseClickAtPoint(canvasControlsLayer, corner)
await editor.getDispatchFollowUpActionsFinished()
}

function typeText(text: string) {
document.execCommand('insertText', false, text)
}
Expand Down Expand Up @@ -1923,6 +2097,66 @@ function projectWithoutTextWithExtraStyle(extraStyleProps: { [prop: string]: str
`)
}

const projectWithTextSpan = formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'


export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
}}
>
Hello
</span>
</Storyboard>
)
`)

function projectWithoutTextSpanWithExtraStyle(extraStyleProps: { [prop: string]: string }) {
const styleProps = {
backgroundColor: '#0091FFAA',
position: 'absolute',
left: 0,
top: 0,
width: 288,
height: 362,
...extraStyleProps,
}

return formatTestProjectCode(`
import * as React from 'react'
import { Storyboard } from 'utopia-api'


export var storyboard = (
<Storyboard data-uid='sb'>
<span
data-testid='span'
style={{
position: 'absolute',
wordBreak: 'break-word',
left: 0,
top: 0,
width: 'max-content',
height: 'max-content',
}}
>
Hello
</span>
</Storyboard>
)
`)
}

const emptyProject = formatTestProjectCode(`import * as React from 'react'
import { Storyboard } from 'utopia-api'

Expand Down
49 changes: 47 additions & 2 deletions editor/src/components/text-editor/text-editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import { EditorModes } from '../editor/editor-modes'
import { useDispatch } from '../editor/store/dispatch-context'
import { MainEditorStoreProvider } from '../editor/store/store-context-providers'
import { Substores, useEditorState, useRefEditorState } from '../editor/store/store-hook'
import { printCSSNumber } from '../inspector/common/css-utils'
import { DOMEventHandlerNames, printCSSNumber } from '../inspector/common/css-utils'
import {
toggleTextBold,
toggleTextItalic,
Expand All @@ -43,6 +43,8 @@ import { mapArrayToDictionary } from '../../core/shared/array-utils'
import { TextRelatedProperties } from '../../core/properties/css-properties'
import { assertNever } from '../../core/shared/utils'
import { notice } from '../common/notice'
import type { AllElementProps } from '../editor/store/editor-state'
import { toString } from '../../core/shared/element-path'

export const TextEditorSpanId = 'text-editor'

Expand Down Expand Up @@ -305,6 +307,7 @@ const TextEditor = React.memo((props: TextEditorProps) => {
)

const metadataRef = useRefEditorState((store) => store.editor.jsxMetadata)
const allElementPropsRef = useRefEditorState((store) => store.editor.allElementProps)

const savedContentRef = React.useRef<string | null>(null)

Expand All @@ -330,6 +333,7 @@ const TextEditor = React.memo((props: TextEditorProps) => {

currentElement.focus()
savedContentRef.current = currentElement.textContent
const initialText = currentElement.textContent

const elementCanvasFrame = MetadataUtils.getFrameOrZeroRectInCanvasCoords(
elementPath,
Expand All @@ -339,6 +343,12 @@ const TextEditor = React.memo((props: TextEditorProps) => {
currentElement.style.minWidth = '0.5px'
}

const canDeleteWhenEmpty = canDeleteElementWhenEmpty(
metadataRef.current,
elementPath,
allElementPropsRef.current,
)

return () => {
const content = currentElement.textContent
if (content != null) {
Expand All @@ -349,10 +359,19 @@ const TextEditor = React.memo((props: TextEditorProps) => {
savedContentRef.current = content
requestAnimationFrame(() => dispatch([getSaveAction(elementPath, content, textProp)]))
}
// remove dangling empty spans
if (
content != null &&
initialText !== content &&
content.replace(/^\n/, '').length === 0 &&
canDeleteWhenEmpty
) {
requestAnimationFrame(() => dispatch([deleteView(elementPath)]))
}
}
}
}
}, [dispatch, elementPath, elementState, metadataRef, textProp])
}, [dispatch, elementPath, elementState, textProp, metadataRef, allElementPropsRef])

React.useLayoutEffect(() => {
if (myElement.current == null) {
Expand Down Expand Up @@ -593,3 +612,29 @@ function getSaveAction(
): EditorAction {
return updateText(elementPath, escapeHTML(content, textProp), textProp)
}

function canDeleteElementWhenEmpty(
jsxMetadata: ElementInstanceMetadataMap,
path: ElementPath,
allElementProps: AllElementProps,
): boolean {
const element = MetadataUtils.findElementByElementPath(jsxMetadata, path)
if (element == null) {
return false
}
if (!MetadataUtils.isSpan(element)) {
return false
}

const elementProps = allElementProps[toString(path)]
if (elementProps == null) {
return false
}

// it must not have defined event handlers
if (Object.keys(elementProps).some((prop) => DOMEventHandlerNames.includes(prop as any))) {
return false
}

return true
}
Loading