-
Notifications
You must be signed in to change notification settings - Fork 79
Description
Description
An editor (panel) for editing the selected component(s) properties.
This defines the first basic version of the panel.
Tier
Plus
License
Proprietary
Motivation
Background
A properties editor is a common feature in visual editing tools, as it allows the user to quickly modify properties that can not be directly manipulated.
Problem
Many components have properties that currently cannot be edited with Copilot, but would be convenient to do so. This becomes particularly apparent with custom components, where a simple text string cannot be edited using Copilot.
Figuring out where each property ends up visually, even in the simple case of a string, can be challenging, making it hard to use “direct manipulation” (e.g double-click or drag & drop).
Solution
A properties editor allows setting many properties while sidestepping many of the challenges.
- Implement as a Copilot panel (we’re considering additional UX improvements later)
- Add editors for simple bean properties such as strings, numbers, booleans, enums
- Consider lists
- Create an issue with a list/backlog of other properties we might want to support
- Stretch goal: Icon selector
Notes
At this stage, we're still aiming to provide a "universal" solution that supports as much as possible w/o requiring anything from the creator of the custom component. Thus we're choosing to first create the easier, more complete solution (e.g properties panel) in favor of the more fancy solution (e.g direct manipulation, custom drop-zones, custom property editors).
Requirements
- Properties editor panel with bean properties for selected component; strings, numbers, booleans, lists, enums
- List ("backlog") of additional (more complex) editors we could/should add later
- Documentation
- License check
Nice-to-haves
- Icon selector
- Reordering of components for setters accepting multiple components
- Better out-of-the-box order for properties (common first)
- Ability to reorder properties
Risks, limitations and breaking changes
Risks
Limitations
Just basic property editors for now.
Breaking changes
(no breaking changes expected)
Out of scope
We're planning a floating/quick-properties editor for the most common things that would appear close to the badge/selected component for quick editing. This PRD does not include that, only the "regular" panel.
Materials
No response
Metrics
No response
Pre-implementation checklist
- Estimated (estimate entered into Estimate custom field)
- Product Manager sign-off
- Engineering Manager sign-off
Pre-release checklist
- Documented (link to documentation provided in sub-issue or comment)
- UX/DX tests conducted and blockers addressed
- Approved for release by Product Manager
Security review
None