planefyi-embed

Embed PlaneFYI widgets — aircraft, glossary terms, interactive tools, and inline elements — on any website. 7 widget types, zero dependencies, Shadow DOM style isolation, 4 built-in themes (light, dark, sepia, auto), 2 styles (modern, clean), and live data from the PlaneFYI database.

Every widget includes a "Powered by PlaneFYI" backlink directing readers to the full reference.

Try the interactive widget builder at widget.planefyi.com

Quick Start

<!-- Place widget div where you want it to appear -->
<div data-planefyi="entity" data-slug="aircraft-types" data-theme="light"></div>

<!-- Load the embed script once, anywhere on the page -->
<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

That's it. The widget fetches data from the PlaneFYI API and renders with full style isolation.

Widget Types

| Type | Usage | Description | |------|-------|-------------| | entity | <div data-planefyi="entity" data-slug="..."></div> | Entity detail card — airport, airline, aircraft, or station | | glossary | <div data-planefyi="glossary" data-slug="..."></div> | Glossary term definition with cross-references | | faq | <div data-planefyi="faq" data-slug="..."></div> | FAQ accordion with expand/collapse | | search | <div data-planefyi="search" data-slug="..."></div> | Search box linking to the full database | | compare | <div data-planefyi="compare" data-slug="..."></div> | Side-by-side entity comparison | | spec-compare | <div data-planefyi="spec-compare" data-slug="..."></div> | Interactive aircraft spec comparison tool — range, capacity, speed | | seats-badge | <div data-planefyi="seats-badge" data-slug="..."></div> | Inline seat capacity badge with class breakdown |

Widget Options

| Attribute | Values | Default | Description | |-----------|--------|---------|-------------| | data-planefyi | entity, glossary, faq, search, compare, [tools] | required | Widget type | | data-slug | e.g. "aircraft-types" | — | Entity slug from the PlaneFYI database | | data-theme | light, dark, sepia, auto | light | Visual theme (auto follows OS preference) | | data-style | modern, clean | modern | Widget design style | | data-size | default, compact, large | default | Widget size | | data-placeholder | any string | "Search Aircraft..." | Search box placeholder |

Themes

<!-- Light (default) -->
<div data-planefyi="entity" data-slug="aircraft-types" data-theme="light"></div>

<!-- Dark -->
<div data-planefyi="entity" data-slug="aircraft-types" data-theme="dark"></div>

<!-- Sepia -->
<div data-planefyi="entity" data-slug="aircraft-types" data-theme="sepia"></div>

<!-- Auto — follows OS dark/light preference -->
<div data-planefyi="entity" data-slug="aircraft-types" data-theme="auto"></div>

Styles

<!-- Modern (default) — clean lines, rounded corners, accent gradients -->
<div data-planefyi="entity" data-slug="aircraft-types" data-style="modern"></div>

<!-- Clean — minimal borders, utility-focused, data-first aesthetic -->
<div data-planefyi="entity" data-slug="aircraft-types" data-style="clean"></div>

Web Components (Custom Elements)

As an alternative to data-* attributes, you can use native HTML custom elements:

<!-- Custom element form -->
<planefyi-entity slug="aircraft-types" theme="light"></planefyi-entity>
<planefyi-compare slugs="aircraft-types,other-slug"></planefyi-compare>
<planefyi-search placeholder="Search Aircraft..."></planefyi-search>

<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

Use style-variant (not style) to avoid conflicts with the HTML reserved style attribute.

Examples

Entity Card

<div data-planefyi="entity" data-slug="aircraft-types" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

Side-by-Side Comparison

<div data-planefyi="compare" data-slugs="aircraft-types,other-slug"></div>
<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

Search Box

<div data-planefyi="search" data-placeholder="Search Aircraft..."></div>
<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

Glossary Term

<div data-planefyi="glossary" data-slug="example-term" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

CDN Options

jsDelivr (recommended — global CDN, auto-updates with npm)

<script src="https://cdn.jsdelivr.net/npm/planefyi-embed@1/dist/embed.min.js"></script>

Specific version (production stability)

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/embed.min.js"></script>

npm (for bundlers)

npm install planefyi-embed

import 'planefyi-embed';

Technical Details

• Shadow DOM: Complete style isolation — no CSS conflicts with your site
• Zero dependencies: No jQuery, React, or any external library
• 2 styles: Modern (accent gradients) and Clean (minimal, data-first)
• 4 themes: Light, Dark, Sepia, Auto (OS preference detection)
• CORS: PlaneFYI API has CORS enabled for all origins
• MutationObserver: Works with dynamically added elements (SPAs)
• IntersectionObserver: Lazy loading — widgets only fetch when entering viewport (200px margin)
• Rich Snippets: DefinedTerm JSON-LD injected for glossary widgets
• Bundle size: Tree-shaken per site — only includes tools available on PlaneFYI

Learn More About Aircraft

Visit planefyi.com — PlaneFYI is a comprehensive aircraft reference with interactive tools, guides, and developer resources.

• API docs: planefyi.com/developers/
• Widget builder: widget.planefyi.com
• npm package: npmjs.com/package/planefyi-embed
• GitHub: github.com/fyipedia/planefyi-embed

Transport FYI Family

Part of FYIPedia — open-source developer tools ecosystem. Transport FYI covers airports, airlines, aircraft, and railway networks. Hub: transitfyi.com.

| Site | Domain | Focus | Package | |------|--------|-------|---------| | AirportFYI | airportfyi.com | 71,631 airports, IATA/ICAO codes, runways, routes | npm | | AirlineFYI | airlinefyi.com | 6,161 airlines, fleets, alliances, routes | npm | | PlaneFYI | planefyi.com | 81 aircraft types, specs, manufacturers, fleet data | npm | | TrainFYI | trainfyi.com | 51,425 stations, operators, route pairs | npm |

FYIPedia Developer Tools

| Package | PyPI | npm | Description | |---------|------|-----|-------------| | colorfyi | PyPI | npm | Color conversion, WCAG contrast, harmonies — colorfyi.com | | emojifyi | PyPI | npm | Emoji encoding & metadata for 3,953 emojis — emojifyi.com | | unitfyi | PyPI | npm | Unit conversion, 220 units — unitfyi.com | | timefyi | PyPI | npm | Timezone ops & business hours — timefyi.com | | holidayfyi | PyPI | npm | Holiday dates & Easter calculation — holidayfyi.com | | namefyi | PyPI | npm | Korean romanization & Five Elements — namefyi.com | | fyipedia | PyPI | — | Unified CLI for all FYI tools — fyipedia.com |

License

MIT — see LICENSE.

Built with care by FYIPedia.