lynx-api-docs

---
name: lynx-api-docs
description: Authoritative Lynx engine references for generating, reviewing, migrating, or debugging Lynx TSX/TTML pages, CSS, layouts, selectors, and elements. Use for Lynx-specific styling and Web-to-Lynx differences; always retrieve the relevant installed docs before changing code.

---

# Using Lynx API Docs

**MUST read the relevant API docs before writing or editing Lynx code.** Lynx elements and CSS differ from the Web; do not fill gaps with HTML or browser assumptions.

**For repair tasks, diagnose and route each symptom before reading element documentation.** For layout, sizing, wrapping, or stacking symptoms, read the CSS differences index first. Do not infer element-prop defects from visual differences alone.

## Route the Task

| Task | Read first |
| --- | --- |
| **Generate or edit Lynx CSS; migrate Web HTML/CSS; debug a Lynx/Web style difference** | **`lynx-vs-web/css-differences.md`**, then only the linked topic files needed for the diagnosed task |
| Check a CSS property, value, unit, or function | `css/supported-properties.md` and `css/values-and-units.md`; also check the CSS differences index when Web compatibility matters |
| Write or debug selectors | `css/selectors.md` and `css/pseudo-classes.md` |
| Choose or debug a layout | `layout/linear-layout.md` (default), `layout/flex-layout.md`, `layout/grid-layout.md`, or `layout/relative-layout.md` |
| Use or debug an element | `elements/<element-name>.md` |
| Apply theming, responsive design, or animation | `patterns/theming.md`, `patterns/responsive.md`, or `patterns/animation.md` |
| Look for a complete example or performance guidance | `examples/`, `quick-reference.md`, or `best-practices.md` as needed |

For CSS work, the differences index is the generation entry point, not only a migration reference. Follow its exact topic links instead of loading the entire documentation bundle.

## Generation-Critical Defaults

- Use `<view>`, `<text>`, and `<image>`, not HTML elements; wrap text in `<text>`.
- Lynx defaults to Linear layout, not Web block flow.
- `box-sizing` initially uses `auto`, normally with border-box sizing; set an explicit value when compatibility settings may differ.
- Margins do not collapse.

These defaults are shortcuts, not a substitute for the task-specific references above.

## Repair Scope and Output

For debugging and visual-repair tasks:

- Diagnose before expanding retrieval. Read only topics tied to the observed defect; do not survey unrelated element, animation, or visual-effect documentation.
- Start from the observed defect and the smallest affected element or selector. Change only what is required for that defect; do not repair speculative differences or normalize unrelated code.
- Preserve unrelated styles, component props and behavior, content, assets, fonts, and routing. Do not apply a relevant rule, such as `box-sizing`, to other elements unless they share the diagnosed defect.
- Before answering, compare the result with the original and remove every edit not required by the diagnosis.
- Follow the user's output contract exactly. When complete files only are requested, return those files without retrieval notes, status updates, explanations, or other prose.

• SKILL.md 3 KB
• best-practices.md 14 KB
• quick-reference.md 9 KB
• css/pseudo-classes.md 3 KB
• css/selectors.md 5 KB
• css/supported-properties.md 10 KB
• css/values-and-units.md 8 KB
• elements/blur-view.md 7 KB
• elements/image.md 11 KB
• elements/input.md 9 KB
• elements/list.md 3 KB
• elements/overlay.md 4 KB
• elements/page.md 4 KB
• elements/refresh.md 3 KB
• elements/scroll-coordinator.md 4 KB
• elements/scroll-view.md 11 KB
• elements/svg.md 7 KB
• elements/text.md 3 KB
• elements/textarea.md 10 KB
• elements/view.md 2 KB
• elements/viewpager.md 4 KB
• elements/webview.md 5 KB
• examples/bottom-nav.md 2 KB
• examples/card-list.md 2 KB
• examples/sidebar-layout.md 2 KB
• examples/sticky-header.md 2 KB
• examples/waterfall.md 2 KB
• layout/flex-layout.md 11 KB
• layout/grid-layout.md 10 KB
• layout/linear-layout.md 11 KB
• layout/relative-layout.md 7 KB
• lynx-vs-web/css-differences.md 6 KB
• lynx-vs-web/migration-guide.md 17 KB
• lynx-vs-web/unsupported-features.md 8 KB
• lynx-vs-web/css-differences/box-model.md 7 KB
• lynx-vs-web/css-differences/display-and-default-layout.md 5 KB
• lynx-vs-web/css-differences/flex-and-sizing.md 7 KB
• lynx-vs-web/css-differences/migration-pitfalls.md 5 KB
• lynx-vs-web/css-differences/positioning-and-stacking.md 3 KB
• lynx-vs-web/css-differences/text-selectors-and-fonts.md 1 KB
• lynx-vs-web/css-differences/transforms-and-animations.md 3 KB
• patterns/animation.md 3 KB
• patterns/responsive.md 4 KB
• patterns/theming.md 3 KB