ipfyi-embed

Embed IPFYI widgets — networks, glossary terms, interactive tools, and inline elements — on any website. 8 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 IPFYI database.

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

Try the interactive widget builder at widget.ipfyi.com

Quick Start

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

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

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

Widget Types

| Type | Usage | Description | |------|-------|-------------| | entity | <div data-ipfyi="entity" data-slug="..."></div> | Entity detail card — cable, ASN, or status code | | glossary | <div data-ipfyi="glossary" data-slug="..."></div> | Glossary term definition with cross-references | | search | <div data-ipfyi="search" data-slug="..."></div> | Search box linking to the full database | | compare | <div data-ipfyi="compare" data-slug="..."></div> | Side-by-side entity comparison | | faq | <div data-ipfyi="faq" data-slug="..."></div> | FAQ accordion with expand/collapse | | isp | <div data-ipfyi="isp" data-slug="..."></div> | ISP detail card — name, type, country, ASN count, IP blocks | | ip-range | <div data-ipfyi="ip-range" data-slug="..."></div> | IP range card — CIDR, host count, version, ASN | | asn-badge | <div data-ipfyi="asn-badge" data-slug="..."></div> | Inline ASN category colored badge (cloud/isp/cdn/enterprise) |

Widget Options

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

Themes

<!-- Light (default) -->
<div data-ipfyi="entity" data-slug="asn" data-theme="light"></div>

<!-- Dark -->
<div data-ipfyi="entity" data-slug="asn" data-theme="dark"></div>

<!-- Sepia -->
<div data-ipfyi="entity" data-slug="asn" data-theme="sepia"></div>

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

Styles

<!-- Modern (default) — gradient header, rounded cards, accent colors -->
<div data-ipfyi="entity" data-slug="asn" data-style-variant="modern"></div>

<!-- Clean — minimal borders, data-first aesthetic -->
<div data-ipfyi="entity" data-slug="asn" data-style-variant="clean"></div>

Web Components (Custom Elements)

<ipfyi-entity slug="asn" theme="light"></ipfyi-entity>
<ipfyi-compare slug-a="item-a" slug-b="item-b"></ipfyi-compare>
<ipfyi-search placeholder="Search Networks..."></ipfyi-search>

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

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

CDN Options

jsDelivr (recommended)

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

Specific version

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

npm (for bundlers)

npm install ipfyi-embed

import 'ipfyi-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: IPFYI 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 IPFYI

Learn More About Networks

Visit ipfyi.com — IPFYI is a comprehensive networks reference with interactive tools, guides, and developer resources.

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

Network FYI Family

Part of FYIPedia — open-source developer tools ecosystem. Network FYI covers cables, IP networks, and protocol status codes. Hub: wirefyi.com.

| Site | Domain | Focus | Package | |------|--------|-------|---------| | CableFYI | cablefyi.com | 151 cables, connectors, standards, compatibility | npm | | IPFYI | ipfyi.com | ASN, ISP, IP ranges, network infrastructure | npm | | StatusCodeFYI | statuscodefyi.com | HTTP/SMTP/gRPC status codes, protocols, debugging | npm | | TLDFYI | tldfyi.com | TLD registry, domain extensions (coming soon) | Coming soon |

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 | | fyipedia | PyPI | — | Unified CLI for all FYI tools — fyipedia.com |

License

MIT — see LICENSE.

Built with care by FYIPedia.