tldraw/apps/examples/e2e/tests/test-style-panel.spec.ts
Taha fcf97958e8
E2E Style Panel Tests (#2878)
This PR adds E2E tests for the style panel.

It checks that: 
- the style panel opens and closes as expected on mobile
- the style panel button is disabled for the eraser tool on mobile
- selecting a style hints the button
- changing a style changes the appearance of the shape
- It also moves a test from the toolbar tests that checks the correct
styles are exposed for the right tools


fixes tld-2222

- [x] `tests` — Changes to any test code only[^2]


### Release Notes

- Add style panel E2E tests

---------

Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2024-02-23 14:37:15 +00:00

142 lines
4.3 KiB
TypeScript

import { expect } from '@playwright/test'
import { Editor } from '@tldraw/tldraw'
import { setup } from '../shared-e2e'
import test from './fixtures/fixtures'
declare const editor: Editor
test.describe('Style selection behaviour', () => {
test.beforeEach(setup)
test('selecting a style hints the button', async ({ isMobile, stylePanel, toolbar }) => {
const { blue, black } = stylePanel.colors
const { pattern, none } = stylePanel.fill
if (isMobile) {
await toolbar.mobileStylesButton.click()
}
// these are hinted by default
await stylePanel.isHinted(black)
await stylePanel.isHinted(none)
// these are not hinted by default
await stylePanel.isNotHinted(pattern)
await stylePanel.isNotHinted(blue)
await blue.click()
await stylePanel.isHinted(blue)
await stylePanel.isNotHinted(black)
await pattern.click()
await stylePanel.isHinted(pattern)
await stylePanel.isNotHinted(none)
// this should not change the hint state of color buttons
await stylePanel.isHinted(blue)
})
test('selecting a style changes the style of the shapes', async ({
page,
stylePanel,
toolbar,
isMobile,
}) => {
const { blue } = stylePanel.colors
const { rectangle } = toolbar.tools
const { popoverRectangle } = toolbar.popOverTools
const { pattern } = stylePanel.fill
if (isMobile) {
await toolbar.mobileStylesButton.click()
}
await blue.click()
if (isMobile) {
await toolbar.moreToolsButton.click()
await popoverRectangle.click()
} else {
await rectangle.click()
}
await page.mouse.click(150, 150)
const shapes1 = await page.evaluate(() => editor.getSelectedShapes())
expect(shapes1.every((s: any) => s.props.color === 'blue' && s.props.fill === 'none')).toBe(
true
)
if (isMobile) {
await toolbar.mobileStylesButton.click()
}
await pattern.click()
await rectangle.click()
await page.mouse.click(250, 150)
await page.mouse.move(100, 100)
await page.mouse.down()
await page.mouse.move(400, 400)
await page.mouse.up()
const shapes2 = await page.evaluate(() => editor.getSelectedShapes())
expect(shapes2.every((s: any) => s.props.color === 'blue' && s.props.fill === 'pattern')).toBe(
true
)
})
test('the correct styles are exposed for the selected tool', async ({
isMobile,
page,
toolbar,
stylePanel,
}) => {
const toolsStylesArr = [
{
name: 'tools.select',
styles: ['style.color', 'style.opacity', 'style.fill', 'style.dash', 'style.size'],
},
{ name: 'tools.more.frame', styles: ['style.opacity'] },
{
name: 'tools.text',
styles: ['style.size', 'style.color', 'style.opacity', 'style.font', 'style.align'],
},
{ name: 'tools.eraser', styles: [] },
]
for (const tool of toolsStylesArr) {
await test.step(`Check tool ${tool.name}`, async () => {
// mobile styles button is disabled for the eraser tool
if (tool.name === 'tools.eraser' && isMobile) return
if (tool.name === 'tools.more.frame') await toolbar.moreToolsButton.click()
await page.getByTestId(tool.name).click()
if (isMobile) await toolbar.mobileStylesButton.click()
for (const style of stylePanel.stylesArray) {
const styleElement = page.getByTestId(style)
const isVisible = await styleElement.isVisible()
const isExpected = tool.styles.includes(style)
expect(isVisible).toBe(isExpected)
}
})
}
})
})
test.describe('mobile style panel', () => {
test.beforeEach(setup)
test('opens and closes as expected', async ({ isMobile, page, toolbar, stylePanel }) => {
test.skip(!isMobile, 'only run on mobile')
await test.step('clicking the mobile styles button', async () => {
await expect(stylePanel.getElement()).toBeHidden()
await toolbar.mobileStylesButton.click()
await expect(stylePanel.getElement()).toBeVisible()
await toolbar.mobileStylesButton.click()
await expect(stylePanel.getElement()).toBeHidden()
})
await test.step('clicking off the panel closes it', async () => {
await toolbar.mobileStylesButton.click()
await expect(stylePanel.getElement()).toBeVisible()
page.mouse.click(200, 200)
await expect(stylePanel.getElement()).toBeHidden()
})
})
test('style menu button is disabled for the eraser tool', async ({ isMobile, toolbar }) => {
test.skip(!isMobile, 'only run on mobile')
const { eraser } = toolbar.tools
await eraser.click()
await expect(toolbar.mobileStylesButton).toBeDisabled()
})
})