mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-03 04:07:03 +00:00
* docs(catalog): put each item page's title, description and Docs text in the server HTML Mintlify renders snippet components in the browser only, so everything inside CatalogDetail (title, standfirst, the Docs tab) was missing from the HTML search engines read: 448 catalog pages served Googlebot no body text. The generator now writes the H1 and standfirst as page markup above the component and the Docs tab as page markup after it, shown with that tab (docs/custom.css). The component no longer draws its own title. Pages patched structurally only; registry drift on 14 pages is left for a regeneration of its own. * docs(catalog): keep the title's top spacing the component gave it * fix(docs): catalog titles and descriptions keep markdown markers literal MDX reads text inside the static <h1> and <p> as inline markdown, so @_blue_sweater_ rendered as italic blue_sweater. mdxText now writes backslash, backtick, * _ [ ] ~ as character references too, with a unit test; the four affected pages are re-escaped.
242 lines
8.7 KiB
Plaintext
242 lines
8.7 KiB
Plaintext
---
|
|
title: "Input Feedback"
|
|
description: "A transitions.dev-inspired input feedback primitive with shake, clear affordance, and success state"
|
|
mode: "frame"
|
|
---
|
|
|
|
import { CatalogDetail, CatalogSlot } from "/snippets/catalog-detail.jsx";
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
|
|
<div className="hf-ve-static-head not-prose">
|
|
<h1>Input Feedback</h1>
|
|
<p>A transitions.dev-inspired input feedback primitive with shake, clear affordance, and success state</p>
|
|
</div>
|
|
|
|
<CatalogDetail
|
|
previewSrc="/public/catalog/components/input-feedback.json"
|
|
compositionId="input-feedback"
|
|
compositionSrc="compositions/components/input-feedback.html"
|
|
title="Input Feedback"
|
|
variables={[{"id":"status","type":"enum","role":"style","label":"Status","description":"Whether the field reads as accepted or rejected, colouring the border, chip and hint.","default":"valid","options":[{"value":"valid","label":"Valid"},{"value":"error","label":"Error"}]},{"id":"value","type":"string","role":"content","label":"Value","description":"Text held by the field.","default":"mia@example.com"},{"id":"hint","type":"string","role":"content","label":"Hint","description":"Helper line under the field.","default":"Looks good."}]}
|
|
meta={{"category":"Effects","badge":"Stable","codeLines":155}}
|
|
attribution={{"path":"registry/components/input-feedback","tags":["transition-primitive","transitions-dev-port","input","feedback"]}}
|
|
hasCode
|
|
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/input-feedback/input-feedback.html"
|
|
>
|
|
|
|
<CatalogSlot slot="code">
|
|
|
|
```html input-feedback.html
|
|
<!--
|
|
Input Feedback - transitions.dev-inspired primitive for HyperFrames.
|
|
|
|
Paste the markup, CSS and script into a composition. Use the timeline
|
|
integration note at the bottom as the starting point for deterministic GSAP
|
|
animation.
|
|
|
|
Variables. The script reads each one, falls back to the declared default on
|
|
anything missing or unrecognised, and writes the text or state attribute the
|
|
CSS below already keys off. The timeline recipe at the bottom is untouched
|
|
by them: it keeps shaking the same shell and popping the same chip.
|
|
|
|
- status (valid | error, default valid): whether the field reads as
|
|
accepted or rejected. valid is the green border, chip and hint; error
|
|
turns all three red and swaps the chip glyph to an exclamation mark.
|
|
Pair it with a matching hint.
|
|
- value (string, default "mia@example.com"): the text held by the field.
|
|
A blank or non-text override keeps the default.
|
|
- hint (string, default "Looks good."): the helper line under the field.
|
|
|
|
On every default the result is identical to the original: a green valid
|
|
field holding mia@example.com over Looks good.
|
|
-->
|
|
|
|
<div
|
|
class="hf-transition-input-feedback"
|
|
data-state="valid"
|
|
data-composition-variables='[
|
|
{ "id": "status", "type": "enum", "role": "style", "label": "Status", "description": "Whether the field reads as accepted or rejected, colouring the border, chip and hint.", "default": "valid", "options": [{ "value": "valid", "label": "Valid" }, { "value": "error", "label": "Error" }] },
|
|
{ "id": "value", "type": "string", "role": "content", "label": "Value", "description": "Text held by the field.", "default": "mia@example.com" },
|
|
{ "id": "hint", "type": "string", "role": "content", "label": "Hint", "description": "Helper line under the field.", "default": "Looks good." }
|
|
]'
|
|
>
|
|
<label>Email</label>
|
|
<div class="hf-transition-input-shell">
|
|
<span class="hf-transition-input-value">mia@example.com</span>
|
|
<button class="hf-transition-input-clear" type="button">x</button>
|
|
<span class="hf-transition-input-check">OK</span>
|
|
</div>
|
|
<p class="hf-transition-input-hint">Looks good.</p>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-transition-input-feedback {
|
|
--hf-fb-border: #d4d4d8;
|
|
--hf-fb-chip-bg: #dcfce7;
|
|
--hf-fb-chip-fg: #166534;
|
|
--hf-fb-hint: #16a34a;
|
|
display: grid;
|
|
gap: 10px;
|
|
width: 430px;
|
|
color: #18181b;
|
|
font-family: Inter, system-ui, sans-serif;
|
|
}
|
|
.hf-transition-input-feedback label {
|
|
color: #52525b;
|
|
font-size: 15px;
|
|
font-weight: 850;
|
|
}
|
|
.hf-transition-input-shell {
|
|
display: flex;
|
|
align-items: center;
|
|
gap: 12px;
|
|
height: 62px;
|
|
padding: 0 16px;
|
|
border: 1px solid var(--hf-fb-border);
|
|
border-radius: 16px;
|
|
background: #ffffff;
|
|
box-shadow: 0 18px 50px rgba(0, 0, 0, 0.08);
|
|
}
|
|
.hf-transition-input-value {
|
|
flex: 1;
|
|
font-size: 20px;
|
|
font-weight: 760;
|
|
}
|
|
.hf-transition-input-clear,
|
|
.hf-transition-input-check {
|
|
display: grid;
|
|
place-items: center;
|
|
height: 28px;
|
|
border-radius: 999px;
|
|
font-size: 12px;
|
|
font-weight: 900;
|
|
}
|
|
.hf-transition-input-clear {
|
|
width: 28px;
|
|
border: 0;
|
|
background: #f4f4f5;
|
|
color: #71717a;
|
|
}
|
|
.hf-transition-input-check {
|
|
min-width: 38px;
|
|
padding: 0 8px;
|
|
background: var(--hf-fb-chip-bg);
|
|
color: var(--hf-fb-chip-fg);
|
|
}
|
|
.hf-transition-input-hint {
|
|
margin: 0;
|
|
color: var(--hf-fb-hint);
|
|
font-size: 14px;
|
|
font-weight: 800;
|
|
}
|
|
.hf-transition-input-feedback[data-state="error"] {
|
|
--hf-fb-border: #fca5a5;
|
|
--hf-fb-chip-bg: #fee2e2;
|
|
--hf-fb-chip-fg: #991b1b;
|
|
--hf-fb-hint: #dc2626;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
function text(value, fallback) {
|
|
return typeof value === "string" && value.trim() !== "" ? value : fallback;
|
|
}
|
|
|
|
var statuses = { valid: "OK", error: "!" };
|
|
|
|
var status = pick(statuses, vars.status, "valid");
|
|
var value = text(vars.value, "mia@example.com");
|
|
var hint = text(vars.hint, "Looks good.");
|
|
|
|
var roots = document.querySelectorAll(".hf-transition-input-feedback");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
var root = roots[i];
|
|
root.setAttribute("data-state", status);
|
|
var valueEl = root.querySelector(".hf-transition-input-value");
|
|
if (valueEl) valueEl.textContent = value;
|
|
var hintEl = root.querySelector(".hf-transition-input-hint");
|
|
if (hintEl) hintEl.textContent = hint;
|
|
var chip = root.querySelector(".hf-transition-input-check");
|
|
if (chip) chip.textContent = statuses[status];
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-transition-input-feedback', { y: 22, opacity: 0 }, { y: 0, opacity: 1, duration: 0.34, ease: 'power2.out' }, 0.3);
|
|
tl.to('.hf-transition-input-shell', { x: -12, duration: 0.06, repeat: 5, yoyo: true, ease: 'none' }, 0.72);
|
|
tl.fromTo('.hf-transition-input-check', { scale: 0, opacity: 0 }, { scale: 1, opacity: 1, duration: 0.28, ease: 'back.out(2)' }, 1.18);
|
|
tl.fromTo('.hf-transition-input-hint', { opacity: 0, y: -6 }, { opacity: 1, y: 0, duration: 0.22, ease: 'power2.out' }, 1.28);
|
|
-->
|
|
```
|
|
|
|
</CatalogSlot>
|
|
|
|
<CatalogSlot slot="install">
|
|
|
|
<InstallCommand command="npx hyperframes add input-feedback" item="input-feedback" />
|
|
|
|
That writes one file: `compositions/components/input-feedback.html`.
|
|
|
|
</CatalogSlot>
|
|
|
|
</CatalogDetail>
|
|
|
|
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/input-feedback.html` and copy what is inside into your own composition.
|
|
The file opens with a comment header that walks you through it.
|
|
|
|
A component has no size or duration of its own. It takes both from the composition
|
|
you paste it into.
|
|
|
|
## Variables
|
|
|
|
Every one of these has a default, so the piece works untouched. Set the ones you
|
|
want to change on the element:
|
|
|
|
| Variable | Default | Accepts | What it does |
|
|
| --- | --- | --- | --- |
|
|
| `status` | `valid` | `valid`, `error` | Whether the field reads as accepted or rejected, colouring the border, chip and hint. |
|
|
| `value` | `mia@example.com` | string | Text held by the field. |
|
|
| `hint` | `Looks good.` | string | Helper line under the field. |
|
|
|
|
Set them with `data-variable-values` on the element that mounts it. These are the
|
|
defaults, so this behaves exactly like the preview above until you change one:
|
|
|
|
```html wrap
|
|
<div
|
|
data-composition-id="input-feedback"
|
|
data-composition-src="compositions/components/input-feedback.html"
|
|
data-variable-values='{"status":"valid","value":"mia@example.com","hint":"Looks good."}'
|
|
></div>
|
|
```
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `transition-primitive` `transitions-dev-port` `input` `feedback`.
|
|
|
|
## Related topics
|
|
|
|
- [Browse the complete Catalog](/catalog)
|
|
- [Add assets and Catalog items in the browser editor](/studio/assets-and-blocks)
|
|
- [Put blocks together into one video](/concepts/compositions)
|
|
|
|
</div>
|