b7d9c8684c
This PR moves code between our packages so that: - @tldraw/editor is a “core” library with the engine and canvas but no shapes, tools, or other things - @tldraw/tldraw contains everything particular to the experience we’ve built for tldraw At first look, this might seem like a step away from customization and configuration, however I believe it greatly increases the configuration potential of the @tldraw/editor while also providing a more accurate reflection of what configuration options actually exist for @tldraw/tldraw. ## Library changes @tldraw/editor re-exports its dependencies and @tldraw/tldraw re-exports @tldraw/editor. - users of @tldraw/editor WITHOUT @tldraw/tldraw should almost always only import things from @tldraw/editor. - users of @tldraw/tldraw should almost always only import things from @tldraw/tldraw. - @tldraw/polyfills is merged into @tldraw/editor - @tldraw/indices is merged into @tldraw/editor - @tldraw/primitives is merged mostly into @tldraw/editor, partially into @tldraw/tldraw - @tldraw/file-format is merged into @tldraw/tldraw - @tldraw/ui is merged into @tldraw/tldraw Many (many) utils and other code is moved from the editor to tldraw. For example, embeds now are entirely an feature of @tldraw/tldraw. The only big chunk of code left in core is related to arrow handling. ## API Changes The editor can now be used without tldraw's assets. We load them in @tldraw/tldraw instead, so feel free to use whatever fonts or images or whatever that you like with the editor. All tools and shapes (except for the `Group` shape) are moved to @tldraw/tldraw. This includes the `select` tool. You should use the editor with at least one tool, however, so you now also need to send in an `initialState` prop to the Editor / <TldrawEditor> component indicating which state the editor should begin in. The `components` prop now also accepts `SelectionForeground`. The complex selection component that we use for tldraw is moved to @tldraw/tldraw. The default component is quite basic but can easily be replaced via the `components` prop. We pass down our tldraw-flavored SelectionFg via `components`. Likewise with the `Scribble` component: the `DefaultScribble` no longer uses our freehand tech and is a simple path instead. We pass down the tldraw-flavored scribble via `components`. The `ExternalContentManager` (`Editor.externalContentManager`) is removed and replaced with a mapping of types to handlers. - Register new content handlers with `Editor.registerExternalContentHandler`. - Register new asset creation handlers (for files and URLs) with `Editor.registerExternalAssetHandler` ### Change Type - [x] `major` — Breaking change ### Test Plan - [x] Unit Tests - [x] End to end tests ### Release Notes - [@tldraw/editor] lots, wip - [@tldraw/ui] gone, merged to tldraw/tldraw - [@tldraw/polyfills] gone, merged to tldraw/editor - [@tldraw/primitives] gone, merged to tldraw/editor / tldraw/tldraw - [@tldraw/indices] gone, merged to tldraw/editor - [@tldraw/file-format] gone, merged to tldraw/tldraw --------- Co-authored-by: alex <alex@dytry.ch>
206 lines
4.3 KiB
TypeScript
206 lines
4.3 KiB
TypeScript
import test, { expect } from '@playwright/test'
|
|
import { Editor, TLShapeId, TLShapePartial } from '@tldraw/tldraw'
|
|
import { rename, writeFile } from 'fs/promises'
|
|
import { setupPage } from '../shared-e2e'
|
|
|
|
declare const editor: Editor
|
|
|
|
test.describe('Export snapshots', () => {
|
|
const snapshots = {} as Record<string, TLShapePartial[]>
|
|
|
|
for (const fill of ['none', 'semi', 'solid', 'pattern']) {
|
|
snapshots[`geo fill=${fill}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'geo',
|
|
props: {
|
|
fill,
|
|
color: 'green',
|
|
w: 100,
|
|
h: 100,
|
|
},
|
|
},
|
|
]
|
|
|
|
snapshots[`arrow fill=${fill}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'arrow',
|
|
props: {
|
|
color: 'light-green',
|
|
fill: fill,
|
|
arrowheadStart: 'square',
|
|
arrowheadEnd: 'dot',
|
|
start: { type: 'point', x: 0, y: 0 },
|
|
end: { type: 'point', x: 100, y: 100 },
|
|
bend: 20,
|
|
},
|
|
},
|
|
]
|
|
|
|
snapshots[`draw fill=${fill}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'draw',
|
|
props: {
|
|
color: 'light-violet',
|
|
fill: fill,
|
|
segments: [
|
|
{
|
|
type: 'straight',
|
|
points: [{ x: 0, y: 0 }],
|
|
},
|
|
{
|
|
type: 'straight',
|
|
points: [
|
|
{ x: 0, y: 0 },
|
|
{ x: 100, y: 0 },
|
|
],
|
|
},
|
|
{
|
|
type: 'straight',
|
|
points: [
|
|
{ x: 100, y: 0 },
|
|
{ x: 0, y: 100 },
|
|
],
|
|
},
|
|
{
|
|
type: 'straight',
|
|
points: [
|
|
{ x: 0, y: 100 },
|
|
{ x: 100, y: 100 },
|
|
],
|
|
},
|
|
{
|
|
type: 'straight',
|
|
points: [
|
|
{ x: 100, y: 100 },
|
|
{ x: 0, y: 0 },
|
|
],
|
|
},
|
|
],
|
|
isClosed: true,
|
|
isComplete: true,
|
|
},
|
|
},
|
|
]
|
|
}
|
|
|
|
for (const font of ['draw', 'sans', 'serif', 'mono']) {
|
|
snapshots[`geo font=${font}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'geo',
|
|
props: {
|
|
text: 'test',
|
|
color: 'blue',
|
|
font,
|
|
w: 100,
|
|
h: 100,
|
|
},
|
|
},
|
|
]
|
|
|
|
snapshots[`arrow font=${font}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'arrow',
|
|
props: {
|
|
color: 'blue',
|
|
fill: 'solid',
|
|
arrowheadStart: 'square',
|
|
arrowheadEnd: 'arrow',
|
|
font,
|
|
start: { type: 'point', x: 0, y: 0 },
|
|
end: { type: 'point', x: 100, y: 100 },
|
|
bend: 20,
|
|
text: 'test',
|
|
},
|
|
},
|
|
]
|
|
|
|
snapshots[`arrow font=${font}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'arrow',
|
|
props: {
|
|
color: 'blue',
|
|
fill: 'solid',
|
|
arrowheadStart: 'square',
|
|
arrowheadEnd: 'arrow',
|
|
font,
|
|
start: { type: 'point', x: 0, y: 0 },
|
|
end: { type: 'point', x: 100, y: 100 },
|
|
bend: 20,
|
|
text: 'test',
|
|
},
|
|
},
|
|
]
|
|
|
|
snapshots[`note font=${font}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'note',
|
|
props: {
|
|
color: 'violet',
|
|
font,
|
|
text: 'test',
|
|
},
|
|
},
|
|
]
|
|
|
|
snapshots[`text font=${font}`] = [
|
|
{
|
|
id: 'shape:testShape' as TLShapeId,
|
|
type: 'text',
|
|
props: {
|
|
color: 'red',
|
|
font,
|
|
text: 'test',
|
|
},
|
|
},
|
|
]
|
|
}
|
|
|
|
for (const [name, shapes] of Object.entries(snapshots)) {
|
|
test(`Exports with ${name}`, async ({ browser }) => {
|
|
const page = await browser.newPage()
|
|
await setupPage(page)
|
|
await page.evaluate((shapes) => {
|
|
editor
|
|
.updateInstanceState({ exportBackground: false })
|
|
.selectAll()
|
|
.deleteShapes()
|
|
.createShapes(shapes)
|
|
}, shapes as any)
|
|
|
|
const downloadEvent = page.waitForEvent('download')
|
|
await page.click('[data-testid="main.menu"]')
|
|
await page.click('[data-testid="menu-item.edit"]')
|
|
await page.click('[data-testid="menu-item.export-as"]')
|
|
await page.click('[data-testid="menu-item.export-as-svg"]')
|
|
|
|
const download = await downloadEvent
|
|
const path = (await download.path()) as string
|
|
// assert(path)
|
|
await rename(path, path + '.svg')
|
|
await writeFile(
|
|
path + '.html',
|
|
`
|
|
<!DOCTYPE html>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<img src="${path}.svg" />
|
|
`,
|
|
'utf-8'
|
|
)
|
|
|
|
await page.goto(`file://${path}.html`)
|
|
const clip = await page.$eval('img', (img) => img.getBoundingClientRect())
|
|
await expect(page).toHaveScreenshot({
|
|
omitBackground: true,
|
|
clip,
|
|
})
|
|
})
|
|
}
|
|
})
|