Files
hyperframes/packages/core
Miguel Angel Simon Sierra 74b421c10f feat(studio): element groups
Wrap selected elements in a <div data-hf-group> in the composition source, with
coordinate rebasing so the members' on-screen positions are unchanged. Supports
create (Cmd+G) / ungroup (Cmd+Shift+G or an inspector button), select-as-unit,
canvas + layer-tree drill-in with a back breadcrumb, move/scale by reusing the
single-element drag/resize intercepts, grouping inside sub-compositions, and
member-union bounds shared across the selection, hover, and off-canvas overlays.

Core: wrapElementsInHtml / unwrapElementsFromHtml mirror splitElementInHtml
(round-trip identity, handles left/top declared in a CSS rule), plus wrap-elements
/ unwrap-elements file-mutation routes with finite-number coordinate validation.

Also polishes the 3D transform widget (tangential to groups): depth via
scroll-over-cube instead of a redundant perspective slider, a depth-scaled cube
for realistic Z feedback, and a screen-Y-down orientation fix so the gizmo
mirrors the element's rotation.
2026-06-26 01:14:14 -04:00
..
2026-06-26 01:14:14 -04:00
2026-06-25 21:32:51 -04:00
2026-03-21 22:43:56 -07:00

@hyperframes/core

Types, parsers, generators, compiler, linter, runtime, and frame adapters for the Hyperframes video framework.

Install

npm install @hyperframes/core

Most users don't need to install core directly — the CLI, producer, and studio packages depend on it internally.

What's inside

Module Description
Types TimelineElement, CompositionSpec, Asset, canvas dimensions, defaults
Parsers parseHtml — extract timeline elements from HTML; parseGsapScript — parse GSAP animations
Generators generateHyperframesHtml — produce valid Hyperframes HTML from a composition spec
Compiler compileTimingAttrs — resolve data-start / data-duration into absolute times
Linter lintHyperframeHtml — validate Hyperframes HTML (missing attributes, overlapping tracks, etc.)
Runtime IIFE script injected into the browser — manages seek, media playback, and the window.__hf protocol
Frame Adapters Pluggable animation drivers (GSAP, Lottie, CSS, or custom)

Frame Adapters

A frame adapter tells the engine how to seek your animation to a specific frame:

import { createGSAPFrameAdapter } from "@hyperframes/core";

const adapter = createGSAPFrameAdapter({
  getTimeline: () => gsap.timeline(),
  compositionId: "my-video",
});

Implement FrameAdapter for custom animation runtimes:

import type { FrameAdapter } from "@hyperframes/core";

const myAdapter: FrameAdapter = {
  id: "my-adapter",
  getDurationFrames: () => 300,
  seekFrame: (frame) => {
    /* seek your animation */
  },
};

Parsing and generating HTML

import { parseHtml, generateHyperframesHtml } from "@hyperframes/core";

const { elements, metadata } = parseHtml(htmlString);
const html = generateHyperframesHtml(spec);

Linting

import { lintHyperframeHtml } from "@hyperframes/core/lint";

const result = lintHyperframeHtml(htmlString);
// result.findings: { severity, message, elementId }[]

Documentation

Full documentation: hyperframes.heygen.com/packages/core