Menu
Folio embed-data conventions for folio_embed_data, as: :embed, canonical embed JSON, embed validation, rendering, migrations, and console forms. Use when replacing legacy embed URL, HTML, or source fields, or when changing model-backed Folio embeds.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Folio and host-app testing conventions. Use when adding, changing, debugging, or reviewing tests, test helpers, factories/fixtures, mocks, stubs, ViewComponent tests, JavaScript behavior tests, integration/system coverage, or files under test/ and packs/*/test.
Folio “HTML over wire” JSON APIs: controllers use render_component_json so the response body is JSON with a string "data" key holding rendered ViewComponent HTML; JavaScript uses Folio.Api.apiGet/apiPost and response.data, not pure domain JSON for client-side rendering. Use when adding or changing render_component_json, console/API endpoints that return component fragments, or consumers of response.data as HTML.
JavaScript conventions for Folio: ES6+, StandardJS linting, DOM APIs, Folio.Api fetch wrappers, debounce/throttle, flash events, and when to use Stimulus. Use when writing or editing .js files, adding behavior to components, or when the user asks about JavaScript patterns in Folio.
Folio optional pack boundary and namespace rules. Use when editing files in optional pack directories, adding pack controllers/components/models/lib code, wiring routes to pack code, or moving reusable behavior between a host app, the Folio engine, and an optional pack, including Packwerk verification.
Build or change Folio SimpleForm inputs and extensions: app/inputs classes, SimpleForm::Inputs overrides, register_stimulus wiring, input_controls, custom_html, standalone input JS/Sass assets, and rendered HTML tests.
Slim template formatting and best practices for Folio components and views. Use when writing or editing .slim templates, reviewing Slim formatting, or when the user asks about Slim conventions, multi-line attributes, or template structure in Folio.
| name | folio-embed-data |
| description | Folio embed-data conventions for folio_embed_data, as: :embed, canonical embed JSON, embed validation, rendering, migrations, and console forms. Use when replacing legacy embed URL, HTML, or source fields, or when changing model-backed Folio embeds. |
Persist canonical folio_embed_data JSON; do not substitute a custom string
field or application-specific embed parsing.
Use one normalized active shape:
{ "active": true, "html": "..." }
{ "active": true, "type": "youtube", "url": "..." }
Folio::Embed.normalize_value in model writers. It normalizes inactive,
blank, and malformed input to nil.EmbedInput checks
invalid_reason_for before it normalizes invalid browser input to inactive.data/embed/source/types.json; extend Folio
itself rather than inventing application-specific parsing.default: {} or null: false where the
normalizer represents blank data as nil.Folio::Embed::Validation. For mutually
exclusive image/embed variants, gate or override validate_folio_embed_data
so the image variant can save without embed JSON.folio_embed_data: :unsafe_html in folio_html_sanitization_config.f.input :folio_embed_data, as: :embed; do not build a custom source
textarea or embed controller.EmbedInput owns the preview and serializes JSON into its hidden field.
Browser and controller tests must submit folio_embed_data.to_json and
permit the scalar field for this form contract.Folio::Embed.hash_strong_params_keys; do not assume that shape works for
the console hidden input.Folio::Embed::BoxComponent.