PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

[improvement] Ui events followup (#1354)

Browse source 
This PR makes several changes to the ui events APIs.

### Change Type

- [ ] `patch` — Bug Fix
- [ ] `minor` — New Feature
- [x] `major` — Breaking Change

### Release Notes

- [ui] Adds source to ui events data object
- [ui] Corrects source for toolbar events
- [ui] Corrects source for clipboard events
- [examples] Updates events example
This commit is contained in:
Steve Ruiz 2023-05-12 09:16:17 +01:00 committed by GitHub
parent a722e3e6f0
commit 03595bc88d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 162 additions and 161 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
apps/examples/src/12-events/EventsExample.tsx
View file

@ -13,11 +13,8 @@ export default function Example() {
const [uiEvents, setUiEvents] = useState<string[]>([])
const handleEvent = useCallback<TLUiEventHandler>((source, name, data) => {
setUiEvents((events) => [
data ? `${source} ${name} ${JSON.stringify(data)}` : `${source} ${name}`,
...events,
])
const handleEvent = useCallback<TLUiEventHandler>((name, data) => {
setUiEvents((events) => [`${name} ${JSON.stringify(data)}`, ...events])
}, [])
useEffect(() => {

4
packages/editor/src/lib/app/App.ts
View file

@ -282,14 +282,14 @@ export class App extends EventEmitter<TLEventMap> {
true
)
this.root.enter(undefined, 'initial')
if (this.instanceState.followingUserId) {
this.stopFollowingUser()
}
this.updateCullingBounds()
this.root.enter(undefined, 'initial')
requestAnimationFrame(() => {
this._tickManager.start()
})

4
packages/ui/api-report.md
View file

@ -799,7 +799,7 @@ export interface ToolItem {
[key: string]: any;
};
// (undocumented)
onSelect: () => void;
onSelect: (source: TLUiEventSource) => void;
// (undocumented)
readonlyOk: boolean;
// (undocumented)
@ -1019,7 +1019,7 @@ export function useLanguages(): {
export function useLocalStorageState<T = any>(key: string, defaultValue: T): readonly [T, (setter: ((value: T) => T) | T) => void];
// @public (undocumented)
export function useMenuClipboardEvents(): {
export function useMenuClipboardEvents(source: TLUiEventSource): {
copy: () => void;
cut: () => void;
paste: (data: ClipboardItem[] | DataTransfer, point?: VecLike) => Promise<void>;

2
packages/ui/src/lib/components/ContextMenu.tsx
View file

@ -61,7 +61,7 @@ function ContextMenuContent() {
const handleSubOpenChange = useMenuIsOpen('context menu sub')
const isReadonly = useReadonly()
const { paste } = useMenuClipboardEvents()
const { paste } = useMenuClipboardEvents('context-menu')
const breakpoint = useBreakpoint()
const container = useContainer()

2
packages/ui/src/lib/components/Menu.tsx
View file

@ -37,7 +37,7 @@ function MenuContent() {
const menuSchema = useMenuSchema()
const breakpoint = useBreakpoint()
const isReadonly = useReadonly()
const { paste } = useMenuClipboardEvents()
const { paste } = useMenuClipboardEvents('menu')
function getMenuItem(app: App, item: MenuChild, parent: MenuChild | null, depth: number) {
switch (item.type) {

6
packages/ui/src/lib/components/Toolbar/Toolbar.tsx
View file

@ -226,7 +226,7 @@ const OverflowToolsContent = track(function OverflowToolsContent({
data-tool={id}
data-geo={meta?.geo ?? ''}
aria-label={label}
onClick={onSelect}
onClick={() => onSelect('toolbar')}
title={label ? `${msg(label)} ${kbd ? kbdStr(kbd) : ''}` : ''}
icon={icon}
/>
@ -255,10 +255,10 @@ function ToolbarButton({
title={title}
icon={item.icon}
data-state={isSelected ? 'selected' : undefined}
onClick={item.onSelect}
onClick={() => item.onSelect('toolbar')}
onTouchStart={(e) => {
preventDefault(e)
item.onSelect()
item.onSelect('toolbar')
}}
/>
)

122
packages/ui/src/lib/hooks/useActions.tsx
View file

@ -73,7 +73,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
const insertMedia = useInsertMedia()
const printSelectionOrPages = usePrint()
const { cut, copy } = useMenuClipboardEvents()
const { cut, copy } = useMenuClipboardEvents('unknown')
const copyAs = useCopyAs()
const exportAs = useExportAs()
@ -88,7 +88,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'link',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'edit-link')
trackEvent('edit-link', { source })
app.mark('edit-link')
addDialog({ component: EditLinkDialog })
},
@ -99,7 +99,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: false,
kbd: '$i',
onSelect(source) {
trackEvent(source, 'insert-embed')
trackEvent('insert-embed', { source })
addDialog({ component: EmbedDialog })
},
},
@ -109,7 +109,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$u',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'insert-media')
trackEvent('insert-media', { source })
insertMedia()
},
},
@ -120,7 +120,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$z',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'undo')
trackEvent('undo', { source })
app.undo()
},
},
@ -131,7 +131,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$!z',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'redo')
trackEvent('redo', { source })
app.redo()
},
},
@ -142,7 +142,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
contextMenuLabel: 'action.export-as-svg.short',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'export-as', { format: 'svg' })
trackEvent('export-as', { format: 'svg', source })
exportAs(app.selectedIds, 'svg')
},
},
@ -153,7 +153,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
contextMenuLabel: 'action.export-as-png.short',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'export-as', { format: 'png' })
trackEvent('export-as', { format: 'png', source })
exportAs(app.selectedIds, 'png')
},
},
@ -164,7 +164,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
contextMenuLabel: 'action.export-as-json.short',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'export-as', { format: 'json' })
trackEvent('export-as', { format: 'json', source })
exportAs(app.selectedIds, 'json')
},
},
@ -176,7 +176,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$!c',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'copy-as', { format: 'svg' })
trackEvent('copy-as', { format: 'svg', source })
copyAs(app.selectedIds, 'svg')
},
},
@ -187,7 +187,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
contextMenuLabel: 'action.copy-as-png.short',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'copy-as', { format: 'png' })
trackEvent('copy-as', { format: 'png', source })
copyAs(app.selectedIds, 'png')
},
},
@ -198,7 +198,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
contextMenuLabel: 'action.copy-as-json.short',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'copy-as', { format: 'json' })
trackEvent('copy-as', { format: 'json', source })
copyAs(app.selectedIds, 'json')
},
},
@ -207,7 +207,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
label: 'action.toggle-auto-size',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'toggle-auto-size')
trackEvent('toggle-auto-size', { source })
app.mark()
app.updateShapes(
app.selectedShapes
@ -231,7 +231,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
label: 'action.open-embed-link',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'open-embed-link')
trackEvent('open-embed-link', { source })
const ids = app.selectedIds
const warnMsg = 'No embed shapes selected'
if (ids.length !== 1) {
@ -252,7 +252,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
label: 'action.convert-to-bookmark',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'convert-to-bookmark')
trackEvent('convert-to-bookmark', { source })
const ids = app.selectedIds
const shapes = ids.map((id) => app.getShapeById(id))
@ -295,7 +295,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
label: 'action.convert-to-embed',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'convert-to-embed')
trackEvent('convert-to-embed', { source })
const ids = app.selectedIds
const shapes = compact(ids.map((id) => app.getShapeById(id)))
@ -347,7 +347,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: false,
onSelect(source) {
if (app.currentToolId !== 'select') return
trackEvent(source, 'duplicate-shapes')
trackEvent('duplicate-shapes', { source })
const ids = app.selectedIds
const commonBounds = Box2d.Common(compact(ids.map((id) => app.getPageBoundsById(id))))
const offset = app.canMoveCamera
@ -370,7 +370,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'ungroup',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'ungroup-shapes')
trackEvent('ungroup-shapes', { source })
app.mark('ungroup')
app.ungroupShapes(app.selectedIds)
},
@ -382,7 +382,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'group',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'group-shapes')
trackEvent('group-shapes', { source })
if (app.selectedShapes.length === 1 && app.selectedShapes[0].type === 'group') {
app.mark('ungroup')
app.ungroupShapes(app.selectedIds)
@ -399,7 +399,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'align-left',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'align-shapes', { operation: 'left' })
trackEvent('align-shapes', { operation: 'left', source })
app.mark('align left')
app.alignShapes('left', app.selectedIds)
},
@ -412,7 +412,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'align-center-horizontal',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'align-shapes', { operation: 'center-horizontal' })
trackEvent('align-shapes', { operation: 'center-horizontal', source })
app.mark('align center horizontal')
app.alignShapes('center-horizontal', app.selectedIds)
},
@ -424,7 +424,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'align-right',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'align-shapes', { operation: 'right' })
trackEvent('align-shapes', { operation: 'right', source })
app.mark('align right')
app.alignShapes('right', app.selectedIds)
},
@ -437,7 +437,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'align-center-vertical',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'align-shapes', { operation: 'center-vertical' })
trackEvent('align-shapes', { operation: 'center-vertical', source })
app.mark('align center vertical')
app.alignShapes('center-vertical', app.selectedIds)
},
@ -449,7 +449,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '?W',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'align-shapes', { operation: 'top' })
trackEvent('align-shapes', { operation: 'top', source })
app.mark('align top')
app.alignShapes('top', app.selectedIds)
},
@ -461,7 +461,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '?S',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'align-shapes', { operation: 'bottom' })
trackEvent('align-shapes', { operation: 'bottom', source })
app.mark('align bottom')
app.alignShapes('bottom', app.selectedIds)
},
@ -473,7 +473,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'distribute-horizontal',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'distribute-shapes', { operation: 'horizontal' })
trackEvent('distribute-shapes', { operation: 'horizontal', source })
app.mark('distribute horizontal')
app.distributeShapes('horizontal', app.selectedIds)
},
@ -485,7 +485,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'distribute-vertical',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'distribute-shapes', { operation: 'vertical' })
trackEvent('distribute-shapes', { operation: 'vertical', source })
app.mark('distribute vertical')
app.distributeShapes('vertical', app.selectedIds)
},
@ -497,7 +497,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'stretch-horizontal',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'stretch-shapes', { operation: 'horizontal' })
trackEvent('stretch-shapes', { operation: 'horizontal', source })
app.mark('stretch horizontal')
app.stretchShapes('horizontal', app.selectedIds)
},
@ -509,7 +509,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'stretch-vertical',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'stretch-shapes', { operation: 'vertical' })
trackEvent('stretch-shapes', { operation: 'vertical', source })
app.mark('stretch vertical')
app.stretchShapes('vertical', app.selectedIds)
},
@ -521,7 +521,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '!h',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'flip-shapes', { operation: 'horizontal' })
trackEvent('flip-shapes', { operation: 'horizontal', source })
app.mark('flip horizontal')
app.flipShapes('horizontal', app.selectedIds)
},
@ -533,7 +533,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '!v',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'flip-shapes', { operation: 'vertical' })
trackEvent('flip-shapes', { operation: 'vertical', source })
app.mark('flip vertical')
app.flipShapes('vertical', app.selectedIds)
},
@ -544,7 +544,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'pack',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'pack-shapes')
trackEvent('pack-shapes', { source })
app.mark('pack')
app.packShapes(app.selectedIds)
},
@ -556,7 +556,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'stack-vertical',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'stack-shapes', { operation: 'vertical' })
trackEvent('stack-shapes', { operation: 'vertical', source })
app.mark('stack-vertical')
app.stackShapes('vertical', app.selectedIds)
},
@ -568,7 +568,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'stack-horizontal',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'stack-shapes', { operation: 'horizontal' })
trackEvent('stack-shapes', { operation: 'horizontal', source })
app.mark('stack-horizontal')
app.stackShapes('horizontal', app.selectedIds)
},
@ -580,7 +580,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'bring-to-front',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'reorder-shapes', { operation: 'toFront' })
trackEvent('reorder-shapes', { operation: 'toFront', source })
app.mark('bring to front')
app.bringToFront()
},
@ -592,7 +592,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '?]',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'reorder-shapes', { operation: 'forward' })
trackEvent('reorder-shapes', { operation: 'forward', source })
app.mark('bring forward')
app.bringForward()
},
@ -604,7 +604,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '?[',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'reorder-shapes', { operation: 'backward' })
trackEvent('reorder-shapes', { operation: 'backward', source })
app.mark('send backward')
app.sendBackward()
},
@ -616,7 +616,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '[',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'reorder-shapes', { operation: 'toBack' })
trackEvent('reorder-shapes', { operation: 'toBack', source })
app.mark('send to back')
app.sendToBack()
},
@ -627,7 +627,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$x',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'cut')
trackEvent('cut', { source })
app.mark('cut')
cut()
},
@ -638,7 +638,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$c',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'copy')
trackEvent('copy', { source })
copy()
},
},
@ -658,7 +658,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$a',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'select-all-shapes')
trackEvent('select-all-shapes', { source })
if (app.currentToolId !== 'select') {
app.cancel()
app.setSelectedTool('select')
@ -673,7 +673,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
label: 'action.select-none',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'select-none-shapes')
trackEvent('select-none-shapes', { source })
app.mark('select none')
app.selectNone()
},
@ -686,7 +686,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: false,
onSelect(source) {
if (app.currentToolId !== 'select') return
trackEvent(source, 'delete-shapes')
trackEvent('delete-shapes', { source })
app.mark('delete')
app.deleteShapes()
},
@ -698,7 +698,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: false,
onSelect(source) {
if (app.selectedIds.length === 0) return
trackEvent(source, 'rotate-cw')
trackEvent('rotate-cw', { source })
app.mark('rotate-cw')
const offset = app.selectionRotation % (TAU / 2)
const dontUseOffset = approximately(offset, 0) || approximately(offset, TAU / 2)
@ -712,7 +712,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: false,
onSelect(source) {
if (app.selectedIds.length === 0) return
trackEvent(source, 'rotate-ccw')
trackEvent('rotate-ccw', { source })
app.mark('rotate-ccw')
const offset = app.selectionRotation % (TAU / 2)
const offsetCloseToZero = approximately(offset, 0)
@ -725,7 +725,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$=',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'zoom-in')
trackEvent('zoom-in', { source })
app.zoomIn(app.viewportScreenCenter, { duration: ANIMATION_MEDIUM_MS })
},
},
@ -735,7 +735,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$-',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'zoom-out')
trackEvent('zoom-out', { source })
app.zoomOut(app.viewportScreenCenter, { duration: ANIMATION_MEDIUM_MS })
},
},
@ -746,7 +746,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '!0',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'reset-zoom')
trackEvent('reset-zoom', { source })
app.resetZoom(app.viewportScreenCenter, { duration: ANIMATION_MEDIUM_MS })
},
},
@ -756,7 +756,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '!1',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'zoom-to-fit')
trackEvent('zoom-to-fit', { source })
app.zoomToFit({ duration: ANIMATION_MEDIUM_MS })
},
},
@ -766,7 +766,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '!2',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'zoom-to-selection')
trackEvent('zoom-to-selection', { source })
app.zoomToSelection({ duration: ANIMATION_MEDIUM_MS })
},
},
@ -776,7 +776,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
menuLabel: 'action.toggle-snap-mode.menu',
readonlyOk: false,
onSelect(source) {
trackEvent(source, 'toggle-snap-mode')
trackEvent('toggle-snap-mode', { source })
app.setSnapMode(!app.isSnapMode)
},
checkbox: true,
@ -788,7 +788,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$/',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'toggle-dark-mode')
trackEvent('toggle-dark-mode', { source })
app.setDarkMode(!app.isDarkMode)
},
checkbox: true,
@ -800,7 +800,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
contextMenuLabel: 'action.toggle-transparent.context-menu',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'toggle-transparent')
trackEvent('toggle-transparent', { source })
app.updateInstanceState(
{
exportBackground: !app.instanceState.exportBackground,
@ -817,7 +817,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: false,
kbd: 'q',
onSelect(source) {
trackEvent(source, 'toggle-tool-lock')
trackEvent('toggle-tool-lock', { source })
app.setToolLocked(!app.isToolLocked)
},
checkbox: true,
@ -834,7 +834,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
// UI to unmount which puts us in a dodgy state
requestAnimationFrame(() => {
app.batch(() => {
trackEvent(source, 'toggle-focus-mode')
trackEvent('toggle-focus-mode', { source })
clearDialogs()
clearToasts()
app.setFocusMode(!app.isFocusMode)
@ -849,7 +849,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
readonlyOk: true,
kbd: "$'",
onSelect(source) {
trackEvent(source, 'toggle-grid-mode')
trackEvent('toggle-grid-mode', { source })
app.setGridMode(!app.isGridMode)
},
checkbox: true,
@ -860,7 +860,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
menuLabel: 'action.toggle-debug-mode.menu',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'toggle-debug-mode')
trackEvent('toggle-debug-mode', { source })
app.updateInstanceState(
{
isDebugMode: !app.instanceState.isDebugMode,
@ -876,7 +876,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
kbd: '$p',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'print')
trackEvent('print', { source })
printSelectionOrPages()
},
},
@ -886,7 +886,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'cross-2',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'exit-pen-mode')
trackEvent('exit-pen-mode', { source })
app.setPenMode(false)
},
},
@ -896,7 +896,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'cross-2',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'stop-following')
trackEvent('stop-following', { source })
app.stopFollowingUser()
},
},
@ -906,7 +906,7 @@ export function ActionsProvider({ overrides, children }: ActionsProviderProps) {
icon: 'arrow-left',
readonlyOk: true,
onSelect(source) {
trackEvent(source, 'zoom-to-content')
trackEvent('zoom-to-content', { source })
app.zoomToContent()
},
},

20
packages/ui/src/lib/hooks/useClipboardEvents.ts
View file

@ -40,7 +40,7 @@ import { compact, isNonNull } from '@tldraw/utils'
import { compressToBase64, decompressFromBase64 } from 'lz-string'
import { useCallback, useEffect } from 'react'
import { useAppIsFocused } from './useAppIsFocused'
import { useEvents } from './useEventsProvider'
import { TLUiEventSource, useEvents } from './useEventsProvider'
/** @public */
export type EmbedInfo = {
@ -968,7 +968,7 @@ const handleNativeClipboardPaste = async (
}
/** @public */
export function useMenuClipboardEvents() {
export function useMenuClipboardEvents(source: TLUiEventSource) {
const app = useApp()
const trackEvent = useEvents()
@ -977,9 +977,9 @@ export function useMenuClipboardEvents() {
if (app.selectedIds.length === 0) return
handleMenuCopy(app)
trackEvent('menu', 'copy')
trackEvent('copy', { source })
},
[app, trackEvent]
[app, trackEvent, source]
)
const cut = useCallback(
@ -988,9 +988,9 @@ export function useMenuClipboardEvents() {
handleMenuCopy(app)
app.deleteShapes()
trackEvent('menu', 'cut')
trackEvent('cut', { source })
},
[app, trackEvent]
[app, trackEvent, source]
)
const paste = useCallback(
@ -1007,7 +1007,7 @@ export function useMenuClipboardEvents() {
// handleScenePaste(app, point)
// }
trackEvent('menu', 'paste')
trackEvent('paste', { source: 'menu' })
},
[app, trackEvent]
)
@ -1032,7 +1032,7 @@ export function useNativeClipboardEvents() {
if (app.selectedIds.length === 0 || app.editingId !== null || disallowClipboardEvents(app))
return
handleMenuCopy(app)
trackEvent('kbd', 'copy')
trackEvent('copy', { source: 'kbd' })
}
function cut() {
@ -1040,7 +1040,7 @@ export function useNativeClipboardEvents() {
return
handleMenuCopy(app)
app.deleteShapes()
trackEvent('kbd', 'cut')
trackEvent('cut', { source: 'kbd' })
}
const paste = (e: ClipboardEvent) => {
@ -1054,7 +1054,7 @@ export function useNativeClipboardEvents() {
}
})
}
trackEvent('kbd', 'paste')
trackEvent('paste', { source: 'kbd' })
}
document.addEventListener('copy', copy)

8
packages/ui/src/lib/hooks/useDialogsProvider.tsx
View file

@ -46,7 +46,7 @@ export function DialogsProvider({ children }: DialogsProviderProps) {
return [...d.filter((m) => m.id !== dialog.id), { ...dialog, id }]
})
trackEvent('dialog', 'open-menu', { id })
trackEvent('open-menu', { source: 'dialog', id })
app.addOpenMenu(id)
return id
@ -68,7 +68,7 @@ export function DialogsProvider({ children }: DialogsProviderProps) {
})
)
trackEvent('dialog', 'open-menu', { id })
trackEvent('open-menu', { source: 'dialog', id })
app.addOpenMenu(id)
return id
@ -88,7 +88,7 @@ export function DialogsProvider({ children }: DialogsProviderProps) {
})
)
trackEvent('dialog', 'close-menu', { id })
trackEvent('close-menu', { source: 'dialog', id })
app.deleteOpenMenu(id)
return id
@ -100,7 +100,7 @@ export function DialogsProvider({ children }: DialogsProviderProps) {
setDialogs((d) => {
d.forEach((m) => {
m.onClose?.()
trackEvent('dialog', 'close-menu', { id: m.id })
trackEvent('close-menu', { source: 'dialog', id: m.id })
app.deleteOpenMenu(m.id)
})
return []

90
packages/ui/src/lib/hooks/useEventsProvider.tsx
View file

@ -17,28 +17,29 @@ export type TLUiEventSource =
| 'dialog'
| 'help-menu'
| 'helper-buttons'
| 'unknown'
/** @public */
export interface TLUiEventMap {
// Actions
undo: undefined
redo: undefined
'group-shapes': undefined
'ungroup-shapes': undefined
'convert-to-embed': undefined
'convert-to-bookmark': undefined
'open-embed-link': undefined
'toggle-auto-size': undefined
undo: null
redo: null
'group-shapes': null
'ungroup-shapes': null
'convert-to-embed': null
'convert-to-bookmark': null
'open-embed-link': null
'toggle-auto-size': null
'copy-as': { format: 'svg' | 'png' | 'json' }
'export-as': { format: 'svg' | 'png' | 'json' }
'edit-link': undefined
'insert-embed': undefined
'insert-media': undefined
'edit-link': null
'insert-embed': null
'insert-media': null
'align-shapes': {
operation: 'left' | 'center-horizontal' | 'right' | 'top' | 'center-vertical' | 'bottom'
}
'duplicate-shapes': undefined
'pack-shapes': undefined
'duplicate-shapes': null
'pack-shapes': null
'stack-shapes': { operation: 'horizontal' | 'vertical' }
'flip-shapes': { operation: 'horizontal' | 'vertical' }
'distribute-shapes': { operation: 'horizontal' | 'vertical' }
@ -46,44 +47,47 @@ export interface TLUiEventMap {
'reorder-shapes': {
operation: 'toBack' | 'toFront' | 'forward' | 'backward'
}
'delete-shapes': undefined
'select-all-shapes': undefined
'select-none-shapes': undefined
'rotate-ccw': undefined
'rotate-cw': undefined
'zoom-in': undefined
'zoom-out': undefined
'zoom-to-fit': undefined
'zoom-to-selection': undefined
'reset-zoom': undefined
'zoom-into-view': undefined
'zoom-to-content': undefined
'delete-shapes': null
'select-all-shapes': null
'select-none-shapes': null
'rotate-ccw': null
'rotate-cw': null
'zoom-in': null
'zoom-out': null
'zoom-to-fit': null
'zoom-to-selection': null
'reset-zoom': null
'zoom-into-view': null
'zoom-to-content': null
'open-menu': { id: string }
'close-menu': { id: string }
'create-new-project': undefined
'save-project-to-file': undefined
'open-file': undefined
'create-new-project': null
'save-project-to-file': null
'open-file': null
'select-tool': { id: string }
print: undefined
copy: undefined
paste: undefined
cut: undefined
'toggle-transparent': undefined
'toggle-snap-mode': undefined
'toggle-tool-lock': undefined
'toggle-grid-mode': undefined
'toggle-dark-mode': undefined
'toggle-focus-mode': undefined
'toggle-debug-mode': undefined
'exit-pen-mode': undefined
'stop-following': undefined
print: null
copy: null
paste: null
cut: null
'toggle-transparent': null
'toggle-snap-mode': null
'toggle-tool-lock': null
'toggle-grid-mode': null
'toggle-dark-mode': null
'toggle-focus-mode': null
'toggle-debug-mode': null
'exit-pen-mode': null
'stop-following': null
}
type Join<T, K> = K extends null
? { [R in keyof T]: T[R] }
: { [R in keyof T]: T[R] } & { [R in keyof K]: K[R] }
/** @public */
export type TLUiEventHandler<T extends keyof TLUiEventMap = keyof TLUiEventMap> = (
source: string,
name: T,
data?: TLUiEventMap[T]
data: Join<{ source: TLUiEventSource }, TLUiEventMap[T]>
) => void
/** @internal */

2
packages/ui/src/lib/hooks/useKeyboardShortcuts.ts
View file

@ -58,7 +58,7 @@ export function useKeyboardShortcuts() {
hot(getHotkeysStringFromKbd(tool.kbd), (event) => {
if (areShortcutsDisabled()) return
preventDefault(event)
tool.onSelect()
tool.onSelect('kbd')
})
}

4
packages/ui/src/lib/hooks/useMenuIsOpen.ts
View file

@ -40,7 +40,7 @@ export function useMenuIsOpen(id: string, cb?: (isOpen: boolean) => void) {
// hook but it's necessary to handle the case where the
// this effect runs twice or re-runs.
if (rIsOpen.current) {
trackEvent('menu', 'open-menu', { id })
trackEvent('open-menu', { source: 'unknown', id })
app.addOpenMenu(id)
}
@ -52,7 +52,7 @@ export function useMenuIsOpen(id: string, cb?: (isOpen: boolean) => void) {
// Close menu and all submenus when the parent is closed
app.openMenus.forEach((menuId) => {
if (menuId.startsWith(id)) {
trackEvent('menu', 'close-menu', { id })
trackEvent('close-menu', { source: 'unknown', id })
app.deleteOpenMenu(menuId)
}
})

52
packages/ui/src/lib/hooks/useTools.tsx
View file

@ -3,7 +3,7 @@ import * as React from 'react'
import { EmbedDialog } from '../components/EmbedDialog'
import { TLUiIconType } from '../icon-types'
import { useDialogs } from './useDialogsProvider'
import { useEvents } from './useEventsProvider'
import { TLUiEventSource, useEvents } from './useEventsProvider'
import { useInsertMedia } from './useInsertMedia'
import { TLTranslationKey } from './useTranslation/TLTranslationKey'
@ -13,7 +13,7 @@ export interface ToolItem {
label: TLTranslationKey
shortcutsLabel?: TLTranslationKey
icon: TLUiIconType
onSelect: () => void
onSelect: (source: TLUiEventSource) => void
kbd?: string
readonlyOk: boolean
meta?: {
@ -53,9 +53,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
icon: 'tool-pointer',
kbd: 'v',
readonlyOk: true,
onSelect() {
onSelect(source) {
app.setSelectedTool('select')
trackEvent('toolbar', 'select-tool', { id: 'select' })
trackEvent('select-tool', { source, id: 'select' })
},
},
{
@ -64,9 +64,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
icon: 'tool-hand',
kbd: 'h',
readonlyOk: true,
onSelect() {
onSelect(source) {
app.setSelectedTool('hand')
trackEvent('toolbar', 'select-tool', { id: 'hand' })
trackEvent('select-tool', { source, id: 'hand' })
},
},
{
@ -75,9 +75,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
icon: 'tool-eraser',
kbd: 'e',
readonlyOk: true,
onSelect() {
onSelect(source) {
app.setSelectedTool('eraser')
trackEvent('toolbar', 'select-tool', { id: 'eraser' })
trackEvent('select-tool', { source, id: 'eraser' })
},
},
{
@ -86,9 +86,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-pencil',
kbd: 'd,b,x',
onSelect() {
onSelect(source) {
app.setSelectedTool('draw')
trackEvent('toolbar', 'select-tool', { id: 'draw' })
trackEvent('select-tool', { source, id: 'draw' })
},
},
...[...TL_GEO_TYPES].map((id) => ({
@ -100,14 +100,14 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
},
kbd: id === 'rectangle' ? 'r' : id === 'ellipse' ? 'o' : undefined,
icon: ('geo-' + id) as TLUiIconType,
onSelect() {
onSelect(source: TLUiEventSource) {
app.batch(() => {
app.updateInstanceState(
{ propsForNextShape: { ...app.instanceState.propsForNextShape, geo: id } },
true
)
app.setSelectedTool('geo')
trackEvent('toolbar', 'select-tool', { id: `geo-${id}` })
trackEvent('select-tool', { source, id: `geo-${id}` })
})
},
})),
@ -117,9 +117,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-arrow',
kbd: 'a',
onSelect() {
onSelect(source) {
app.setSelectedTool('arrow')
trackEvent('toolbar', 'select-tool', { id: 'arrow' })
trackEvent('select-tool', { source, id: 'arrow' })
},
},
{
@ -128,9 +128,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-line',
kbd: 'l',
onSelect() {
onSelect(source) {
app.setSelectedTool('line')
trackEvent('toolbar', 'select-tool', { id: 'line' })
trackEvent('select-tool', { source, id: 'line' })
},
},
{
@ -139,9 +139,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-frame',
kbd: 'f',
onSelect() {
onSelect(source) {
app.setSelectedTool('frame')
trackEvent('toolbar', 'select-tool', { id: 'frame' })
trackEvent('select-tool', { source, id: 'frame' })
},
},
{
@ -150,9 +150,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-text',
kbd: 't',
onSelect() {
onSelect(source) {
app.setSelectedTool('text')
trackEvent('toolbar', 'select-tool', { id: 'text' })
trackEvent('select-tool', { source, id: 'text' })
},
},
{
@ -161,9 +161,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-media',
kbd: '$u',
onSelect() {
onSelect(source) {
insertMedia()
trackEvent('toolbar', 'select-tool', { id: 'media' })
trackEvent('select-tool', { source, id: 'media' })
},
},
{
@ -172,9 +172,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
readonlyOk: true,
icon: 'tool-note',
kbd: 'n',
onSelect() {
onSelect(source) {
app.setSelectedTool('note')
trackEvent('toolbar', 'select-tool', { id: 'note' })
trackEvent('select-tool', { source, id: 'note' })
},
},
{
@ -182,9 +182,9 @@ export function ToolsProvider({ overrides, children }: ToolsProviderProps) {
label: 'tool.embed',
readonlyOk: true,
icon: 'tool-embed',
onSelect() {
onSelect(source) {
addDialog({ component: EmbedDialog })
trackEvent('toolbar', 'select-tool', { id: 'embed' })
trackEvent('select-tool', { source, id: 'embed' })
},
},
])