HyperFrames 레지스트리
레지스트리는 hyperframes add <name> 명령어로 설치 가능한 재사용 가능한 블록과 컴포넌트를 제공합니다.
- 블록 — 독립적인 하위 컴포지션(자체 크기, 지속 시간, 타임라인 보유). 호스트 컴포지션에서
data-composition-src를 통해 포함됩니다. - 컴포넌트 — 효과 스니펫(자체 크기 없음). 호스트 컴포지션의 HTML에 직접 붙여넣습니다.
빠른 참조
hyperframes add data-chart # 블록 설치
hyperframes add grain-overlay # 컴포넌트 설치
hyperframes add captions # 'captions' 태그의 모든 블록 설치
hyperframes add shimmer-sweep --dir . # 특정 프로젝트 지정
hyperframes add data-chart --json # 기계 판독 가능 출력
hyperframes add data-chart --no-clipboard # 클립보드 생략 (CI/헤드리스)
설치 후 CLI는 작성된 파일과 호스트 컴포지션에 붙여넣을 스니펫을 출력합니다. 스니펫은 시작점일 뿐이며, 블록을 연결할 때는 data-composition-id(블록의 내부 컴포지션 ID와 일치해야 함), data-start, data-track-index 속성을 직접 추가해야 합니다.
위치 인자는 먼저 정확한 항목 이름으로 확인됩니다. 일치하는 항목이 없고 값이 태그인 경우, 해당 태그의 모든 블록을 설치합니다. 요청된 항목보다 레지스트리 종속성이 먼저 설치됩니다. hyperframes add 명령어는 블록과 컴포넌트에만 작동하며, 예제를 사용하려면 대신 hyperframes init <dir> --example <name>을 사용하세요.
설치 위치
블록은 기본적으로 compositions/<name>.html에 설치됩니다. 컴포넌트는 기본적으로 compositions/components/<name>.html에 설치됩니다.
이 경로들은 hyperframes.json에서 설정할 수 있습니다:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
자세한 내용은 install-locations.md를 참조하세요.
블록 연결하기
블록은 독립형 컴포지션입니다. 호스트 index.html에서 data-composition-src를 사용하여 포함합니다:
<div
data-composition-id="data-chart"
data-composition-src="compositions/data-chart.html"
data-start="2"
data-duration="15"
data-track-index="1"
data-width="1920"
data-height="1080"
></div>
주요 속성:
data-composition-src— 블록 HTML 파일 경로data-composition-id— 블록의 내부 ID와 일치해야 함data-start— 호스트 타임라인에서 블록이 나타나는 시간(초)data-duration— 블록 재생 시간data-width/data-height— 블록 캔버스 크기data-track-index— 레이어 순서(숫자가 높을수록 앞에 표시)
자세한 내용은 wiring-blocks.md를 참조하세요.
컴포넌트 연결하기
컴포넌트는 스니펫입니다. 해당 HTML을 컴포지션의 마크업에, CSS를 스타일 블록에, JS를 스크립트(있는 경우)에 붙여넣습니다:
- 설치된 파일을 읽습니다 (예:
compositions/components/grain-overlay.html) - HTML 요소를 컴포지션의
<div data-composition-id="...">에 복사합니다 <style>블록을 컴포지션의 스타일에 복사합니다<script>내용을 컴포지션의 스크립트(타임라인 코드 앞)에 복사합니다- 컴포넌트가 GSAP 타임라인 통합을 제공하는 경우(스니펫의 주석 블록 참조), 해당 호출을 타임라인에 추가합니다
자세한 내용은 wiring-components.md를 참조하세요.
검색
CLI를 기본 검색 도구로 사용하십시오. 의도 기반으로 먼저 검색하세요: 레지스트리에는 눈으로 훑기에는 너무 많은 항목이 있으므로, 이름이나 태그로 나열하고 일치시키는 것은 느린 방법이며, 작성자의 용어가 사용자의 용어와 다를 때 실패합니다.
# 전체 카탈로그를 비트의 목적에 따라 순위 지정
npx hyperframes catalog --query "헤드라인을 한 줄씩 표시"
npx hyperframes add caption-clip-wipe
검색은 로컬에서 이루어지며 아무것도 전송하지 않습니다. 기본적으로 항목의 이름, 제목 및 설명과 공유되는 어휘를 기준으로 순위를 매기므로 사용자의 단어를 재사용하는 항목만 찾습니다. --on-device는 일회성 모델 다운로드 후 의미를 기준으로 순위를 매깁니다. --json과 함께 사용하면 응답에 어떤 계층이 순위를 매겼는지 명시되므로, 순위가 발생했다고 가정하지 말고 이를 확인하세요.
설치 가능성은 순위 매기기 전이 아닌 후에 적용됩니다. 벡터가 전달하는 이름이지만 이 레지스트리가 제공할 수 없는 경우 결과에서 제외되고 dropped에 집계되므로, dropped가 0이 아니면 두 항목이 서로 다른 세대임을 의미합니다. 오프라인 계층, 동의 게이트, 오래된 인덱스 새로 고침 방법에 대해서는 /hyperframes-cli를 참조하세요.
검색 대신 탐색 또는 필터링:
npx hyperframes catalog
npx hyperframes catalog --type block
npx hyperframes catalog --type component
npx hyperframes catalog --type block --tag social
npx hyperframes catalog --json
npx hyperframes catalog --human-friendly
일반 테이블 및 --json 모드는 일치하는 항목만 나열합니다. 선택한 이름은 hyperframes add <name>으로 설치하세요. --human-friendly는 대화형 선택기를 열고 선택한 항목을 즉시 설치합니다. CI 또는 에이전트 워크플로우에서는 --json을 먼저 사용하고 명시적으로 add를 호출하는 것을 권장합니다.
CLI가 설정된 레지스트리에 연결할 수 없는 경우, 대체 방법으로 원시 매니페스트를 검사하세요:
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
각 항목의 registry-item.json에는 이름, 유형, 제목, 설명, 태그, 크기(블록만 해당), 지속 시간(블록만 해당), 파일 목록이 포함됩니다.
유형 및 태그별 필터링에 대한 자세한 내용은 discovery.md를 참조하세요.
새 블록 또는 컴포넌트 기여하기
새로운 레지스트리 항목(캡션 스타일, VFX 블록, 전환, 하단 써드, 또는 재사용 가능한 컴포넌트)을 작성하여 업스트림 PR로 제출하려면 — 기존 항목을 설치하는 것이 아니라 — contributing.md의 전체 아이디어 → 스캐폴딩 → 빌드 → 검증 → 미리보기 → 전달 워크플로우를 따르세요. 복사하여 붙여넣을 수 있는 시작 템플릿(캡션 / VFX / 컴포넌트 / registry-item.json)은 templates.md에 있습니다.