ac0259a6af
This PR refactors our menu systems and provides an interface to hide or
replace individual user interface elements.
# Background
Previously, we've had two types of overrides:
- "schema" overrides that would allow insertion or replacement of items
in the different menus
- "component" overrides that would replace components in the editor's
user interface
This PR is an attempt to unify the two and to provide for additional
cases where the "schema-based" user interface had begun to break down.
# Approach
This PR makes no attempt to change the `actions` or `tools`
overrides—the current system seems to be correct for those because they
are not reactive. The challenge with the other ui schemas is that they
_are_ reactive, and thus the overrides both need to a) be fed in from
outside of the editor as props, and b) react to changes from the editor,
which is an impossible situation.
The new approach is to use React to declare menu items. (Surprise!)
```tsx
function CustomHelpMenuContent() {
return (
<>
<DefaultHelpMenuContent />
<TldrawUiMenuGroup id="custom stuff">
<TldrawUiMenuItem
id="about"
label="Like my posts"
icon="external-link"
readonlyOk
onSelect={() => {
window.open('https://x.com/tldraw', '_blank')
}}
/>
</TldrawUiMenuGroup>
</>
)
}
const components: TLComponents = {
HelpMenuContent: CustomHelpMenuContent,
}
export default function CustomHelpMenuContentExample() {
return (
<div className="tldraw__editor">
<Tldraw components={components} />
</div>
)
}
```
We use a `components` prop with the combined editor and ui components.
- [ ] Create a "layout" component?
- [ ] Make UI components more isolated? If possible, they shouldn't
depend on styles outside of themselves, so that they can be used in
other layouts. Maybe we wait on this because I'm feeling a slippery
slope toward presumptions about configurability.
- [ ] OTOH maybe we go hard and consider these things as separate
components, even packages, with their own interfaces for customizability
/ configurability, just go all the way with it, and see what that looks
like.
# Pros
Top line: you can customize tldraw's user interface in a MUCH more
granular / powerful way than before.
It solves a case where menu items could not be made stateful from
outside of the editor context, and provides the option to do things in
the menus that we couldn't allow previously with the "schema-based"
approach.
It also may (who knows) be more performant because we can locate the
state inside of the components for individual buttons and groups,
instead of all at the top level above the "schema". Because items /
groups decide their own state, we don't have to have big checks on how
many items are selected, or whether we have a flippable state. Items and
groups themselves are allowed to re-build as part of the regular React
lifecycle. Menus aren't constantly being rebuilt, if that were ever an
issue.
Menu items can be shared between different menu types. We'll are
sometimes able to re-use items between, for example, the menu and the
context menu and the actions menu.
Our overrides no longer mutate anything, so there's less weird searching
and finding.
# Cons
This approach can make customization menu contents significantly more
complex, as an end user would need to re-declare most of a menu in order
to make any change to it. Luckily a user can add things to the top or
bottom of the context menu fairly easily. (And who knows, folks may
actually want to do deep customization, and this allows for it.)
It's more code. We are shipping more react components, basically one for
each menu item / group.
Currently this PR does not export the subcomponents, i.e. menu items. If
we do want to export these, then heaven help us, it's going to be a
_lot_ of exports.
# Progress
- [x] Context menu
- [x] Main menu
- [x] Zoom menu
- [x] Help menu
- [x] Actions menu
- [x] Keyboard shortcuts menu
- [x] Quick actions in main menu? (new)
- [x] Helper buttons? (new)
- [x] Debug Menu
And potentially
- [x] Toolbar
- [x] Style menu
- [ ] Share zone
- [x] Navigation zone
- [ ] Other zones
### Change Type
- [x] `major` — Breaking change
### Test Plan
1. use the context menu
2. use the custom context menu example
3. use cursor chat in the context menu
- [x] Unit Tests
- [ ] End to end tests
### Release Notes
- Add a brief release note for your PR here.
62 lines
1.8 KiB
TypeScript
62 lines
1.8 KiB
TypeScript
import glob from 'glob'
|
|
import isCI from 'is-ci'
|
|
import path from 'path'
|
|
import { rimraf } from 'rimraf'
|
|
import { exec } from './lib/exec'
|
|
import { sortUnions } from './lib/sort-unions'
|
|
|
|
async function buildApi(sourcePackageDir: string) {
|
|
// this depends on `build-types` being run first, but we'll rely on turbo to
|
|
// make that happen.
|
|
|
|
const relativeSourcePackageDir = path.relative(path.resolve(__dirname, '../..'), sourcePackageDir)
|
|
|
|
// we need to copy the .tsbuild dir to another location so we can edit it without busting the cache
|
|
await rimraf(path.join(sourcePackageDir, '.tsbuild-api'))
|
|
await exec('cp', ['-R', './.tsbuild', './.tsbuild-api'], { pwd: sourcePackageDir })
|
|
|
|
sortUnions(path.join(sourcePackageDir, '.tsbuild-api'))
|
|
|
|
// clear api-extractor build files
|
|
rimraf.sync(glob.sync(path.join(sourcePackageDir, 'api')))
|
|
// extract public api
|
|
try {
|
|
await exec('yarn', ['run', '-T', 'api-extractor', 'run', isCI ? null : '--local'], {
|
|
pwd: sourcePackageDir,
|
|
processStderrLine: (line) => {
|
|
process.stderr.write(`${line}\n`)
|
|
|
|
if (process.env.PRINT_GITHUB_ANNOTATIONS) {
|
|
const errorMatch = line.match(
|
|
// eslint-disable-next-line no-control-regex
|
|
/^(?:\u001b\[33m)?(Warning|Error): (.+?):(\d+):(\d+) - \((.*)\) (.*)(?:\u001b\[39m)?$/
|
|
)
|
|
if (errorMatch) {
|
|
const [, errorType, file, line, column, messageTitle, message] = errorMatch
|
|
|
|
process.stdout.write(
|
|
`::${errorType.toLowerCase()} file=${relativeSourcePackageDir}/${file},line=${line},col=${column},title=${messageTitle}::${message}}\n`
|
|
)
|
|
}
|
|
}
|
|
},
|
|
})
|
|
} catch (e) {
|
|
// get git diff
|
|
await exec('git', [
|
|
'diff',
|
|
'--no-color',
|
|
'--no-ext-diff',
|
|
'--no-index',
|
|
'api-report.md',
|
|
'api/temp/api-report.md',
|
|
])
|
|
|
|
// @ts-expect-error
|
|
console.error(e.message)
|
|
|
|
process.exit(1)
|
|
}
|
|
}
|
|
|
|
buildApi(process.cwd())
|