Files
hyperframes/docs/studio/index.mdx
Miguel Ángel 98e8372a0a feat(studio): all panels move onto the dockable, persisted layout (#4192)
* feat(studio): every Studio panel is a dock panel and the shell moves onto it

EditorShell, App.tsx, the left and right panel columns, and the
inspector hooks now render through Dock.Panel instead of the old
fixed-width sidebars and split-pane inspector. usePanelLayout becomes
a thin facade over the dock store; fitPanels, the resize divider and
the split-inspector hook are dead and removed.

* refactor(studio): drop dead inspector flags and stale fallow entries after dock migration

Collapse inspectorButtonActive into inspectorPanelActive, remove unread
layers/design active fields, un-export unused prop types, flatten a nested
ternary, and point fallow ignores at the renamed/deleted files.

* fix(studio): keep right-panel behaviours the dock migration dropped

Block params dismiss on selection or when Design is hidden, the slideshow
panel can be closed, the selection outline follows the inspector intent,
caption editing focuses Design, and a URL slideshow tab opens once the
panel exists.

* refactor(studio): name the inspector-open state once in the header

* fix(studio): right-panel behaviours survive selection, restore and reopen after the dock migration

Block params stay open over an element that was already selected, caption mode wins over block params, the slideshow panel waits for the dock, the Renders tab title survives a reopen, each side column remembers the tab it last showed, tab switches are reported only when the tab changes, and the e2e thumbnail selector follows the dock.

* docs(studio): describe the dock layout and point comments at the renamed right panels

* fix(studio): block params survive a preview reload of the selected element, and panel titles are covered

The dismissal compares the selected element by its target key instead of object identity, because a preview reload rebuilds the selection for the same element. A closed and reopened panel keeps its custom title, with a test, and the e2e selector is formatted.

* fix(studio): block params leave with any other tab pick, and a restored slideshow placement survives loading

Block params are now dismissed by the tab setter the way their old tab was, including a re-pick of the same element, instead of by comparing selections. The slideshow panel is only closed after a file that was a slideshow stops being one, so a restored layout is not discarded while the file loads.

* refactor(studio): drop the duplicate inspector-open computation

The rebase onto main left two identical inspectorButtonActive/inspectorOpen
constants after a conflict resolution; only the first was still referenced.

* chore(studio): allow the dock migration deletions in the guard

StudioLeftSidebar.tsx, LeftSidebar.tsx and its storage test,
TimelineResizeDivider.tsx, useInspectorSplitResize.ts and fitPanels
are replaced by the dock; the CI deletion guard needs each named
with its reason.

* style(studio): oxfmt the deletion-guard entries

* fix(studio): rename Timeline's aria-label so it does not collide with its dock panel wrapper

Every dock panel wrapper now carries aria-label=<title>, matching the "Timeline"
title for the timeline panel. Timeline.tsx also set aria-label="Timeline" on its
own content div, so `document.querySelector('[aria-label=\"Timeline\"]')` found
the dock wrapper first and the timeline viewport gate CI check timed out waiting
for an attribute the real content div actually carried. Renamed to "Timeline
track view" and updated every consumer: the production diagnostics selector,
its tests, and the e2e viewport-gate script.

* fix(studio): restore inspectorButtonActive as a real prop after a rebase regression

Rebasing PR2 onto main replayed an older local commit whose diff did not
textually overlap main's newer inspectorButtonActive prop, so git applied
it with no conflict marker and silently reverted the header to computing
the value itself instead of receiving it. StudioHeader.dom.test.tsx already
asserts the prop is respected; restoring it makes that test meaningful
again. App.tsx now computes it once (panelLayout.rightCollapsed is already
the dock's effective collapse state, no separate railed-by-width case) and
passes it down.

* chore(studio): wrap a long doc comment in useRightPanelIntents
2026-09-19 19:04:16 -04:00

168 lines
6.5 KiB
Plaintext

---
title: "Work on a project in Studio"
sidebarTitle: "Studio overview"
description: "Open a HyperFrames project, understand the workspace, make a safe edit, and finish a version."
---
import { DocsVideo } from "/snippets/docs-video.jsx";
<div className="hf-docs-video-frame">
<DocsVideo
title="A narrated tour of a real HyperFrames Studio project"
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-front-door-v2.mp4"
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-front-door-v2.jpg"
/>
</div>
Studio is the visual editor for the same HTML project your agent and the CLI
use. Any HyperFrames project opens here without an import or conversion. Open any project folder, then run:
```bash
npx hyperframes preview
```
## Know the workspace
<Frame caption="Preview keeps project files, the live frame, the Inspector, and time-based editing in one workspace.">
<img
src="https://static.heygen.ai/hyperframes-oss/docs/images/studio/overview-v1.jpg"
alt="HyperFrames Studio Preview showing project tools, a live composition, the Inspector, and the timeline"
/>
</Frame>
- **Preview** shows the built project. The live frame is in the middle, the
timeline is below, project tools are on the left, and the Inspector is on the
right. Drag any panel tab to move it, and use **Window** in the header to
reopen a closed panel or reset the layout. Studio remembers your layout for
each project.
- **Code**, **Compositions**, **Assets**, and **Catalog** expose the project source,
compositions, media, and reusable visuals. **Design**, **Layers**,
**Variables**, and **Renders** control the selected work.
You do not need to learn every panel. Choose the surface that matches the
problem in front of you.
| You want to change | Start with |
| ----------------------------------------------- | -------------------------------- |
| Something visible in the current frame | Canvas, then Design or Layers |
| When something appears or how long it stays | Timeline |
| One movement or transition | Animation controls and keyframes |
| The story, several scenes, or project structure | Your agent |
## Make one safe edit
Pause where the problem is visible. Click the element on the canvas, or choose
it in **Layers** when several elements overlap. Then change only the property
you meant to change.
<div style={{ maxWidth: "42rem", margin: "1.5rem auto" }}>
<Frame caption="The canvas selects the visible element; Design exposes the properties Studio can edit safely.">
<video
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-direct-edit-loop-v2.mp4"
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-direct-edit-loop-v2.jpg"
alt="Selecting an element and changing it in HyperFrames Studio"
aria-label="Selecting an element and changing it in HyperFrames Studio"
autoPlay
muted
loop
playsInline
preload="metadata"
/>
</Frame>
</div>
Use the canvas to move, resize, rotate, or crop a supported element. Use
**Design** for text, layout, style, media, motion, 3D, or color controls that
apply to the selection. Play through the surrounding moment before accepting
the change; a correct still frame can still create a collision in motion.
<Warning>
Auto-keyframe starts enabled. Turn it off before a normal layout correction that should stay
constant. Leave it on only when the change at the current playhead time should become animation.
</Warning>
For the complete visible-edit workflow, continue to [Edit the
frame](/studio/canvas).
## Change time on the timeline
Drag a clip to move it earlier or later. Drag an edge to change its duration.
Use the razor only when one supported clip must become two.
<div style={{ maxWidth: "42rem", margin: "1.5rem auto" }}>
<Frame caption="Timing changes stay visible beside the frame and neighboring tracks.">
<video
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-timing-loop-v2.mp4"
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-timing-loop-v2.jpg"
alt="Adjusting clip timing in the HyperFrames Studio timeline"
aria-label="Adjusting clip timing in the HyperFrames Studio timeline"
autoPlay
muted
loop
playsInline
preload="metadata"
/>
</Frame>
</div>
Move the playhead through the surrounding cut after every timing change. Use
[the timeline guide](/studio/timeline) when you need trimming, splitting,
beats, nested scenes, or multi-item editing.
## Hand a broader change back to the agent
Studio is best for a change you can point at. Ask the agent when the request
affects the story, several scenes, source research, or unfamiliar project code.
Use **Ask agent** or **Copy to Agent** when Studio offers it, then add the human
intent that the copied context cannot know:
```text
Make the opening feel faster, but keep the current narration and final scene.
```
The agent and Studio edit the same source. There is no export or conversion
between them.
## Check and render the version
Watch the project from the beginning, run **Lint**, and fix the reported issues.
Before delivery, run the project-level browser gate as well:
```bash
npx hyperframes check
```
Then render through Studio, your agent, or the CLI. Open the exported file and
watch it once before sharing it.
<div style={{ maxWidth: "42rem", margin: "1.5rem auto" }}>
<Frame caption="Studio queues and monitors a render from the same project.">
<video
src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-check-render-loop-v2.mp4"
poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-check-render-loop-v2.jpg"
alt="Queuing and monitoring a render in HyperFrames Studio"
aria-label="Queuing and monitoring a render in HyperFrames Studio"
autoPlay
muted
loop
playsInline
preload="metadata"
/>
</Frame>
</div>
## Related topics
<CardGroup cols={2}>
<Card title="Edit the frame" icon="crop" href="/studio/canvas">
Select, style, arrange, group, and replace visible elements.
</Card>
<Card title="Edit timing" icon="timeline" href="/studio/timeline">
Trim, split, move, and retime clips on the project timeline.
</Card>
<Card title="Finish and share" icon="circle-check" href="/guides/export-and-share">
Review, validate, render, and deliver the project.
</Card>
</CardGroup>