symbolfyi-embed

Embed SymbolFYI widgets — symbols, 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, minimal), and live data from the SymbolFYI database.

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

Try the interactive widget builder at widget.symbolfyi.com

Quick Start

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

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

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

Widget Types

| Type | Usage | Description | |------|-------|-------------| | entity | <div data-symbolfyi="entity" data-slug="..."></div> | Entity detail card — color, font, emoji, symbol, or character | | glossary | <div data-symbolfyi="glossary" data-slug="..."></div> | Glossary term definition with cross-references | | guide | <div data-symbolfyi="guide" data-slug="..."></div> | Guide summary card with key takeaways | | compare | <div data-symbolfyi="compare" data-slug="..."></div> | Side-by-side entity comparison | | search | <div data-symbolfyi="search" data-slug="..."></div> | Search box linking to the full database | | encoder | <div data-symbolfyi="encoder" data-slug="..."></div> | Symbol encoder — 11 formats (HTML entity, CSS, JS, UTF-8, URL) | | badge | <div data-symbolfyi="badge" data-slug="..."></div> | Inline symbol badge with codepoint | | tooltip | <div data-symbolfyi="tooltip" data-slug="..."></div> | Glossary tooltip — hover/click shows term definition inline |

Widget Options

| Attribute | Values | Default | Description | |-----------|--------|---------|-------------| | data-symbolfyi | entity, compare, glossary, guide, search, tooltip, [tools] | required | Widget type | | data-slug | e.g. "symbols" | — | Entity slug from the SymbolFYI database | | data-theme | light, dark, sepia, auto | light | Visual theme (auto follows OS preference) | | data-styleVariant | modern, minimal | modern | Widget design style | | data-size | default, compact, large | default | Widget size | | data-placeholder | any string | "Search Symbols..." | Search box placeholder |

Themes

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

<!-- Dark -->
<div data-symbolfyi="entity" data-slug="symbols" data-theme="dark"></div>

<!-- Sepia -->
<div data-symbolfyi="entity" data-slug="symbols" data-theme="sepia"></div>

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

Styles

<!-- Modern (default) — clean lines, rounded corners, accent gradients -->
<div data-symbolfyi="entity" data-slug="symbols" data-styleVariant="modern"></div>

<!-- Minimal — subtle borders, flat design, no gradients -->
<div data-symbolfyi="entity" data-slug="symbols" data-styleVariant="minimal"></div>

Web Components (Custom Elements)

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

<!-- Custom element form -->
<symbolfyi-entity slug="symbols" theme="light"></symbolfyi-entity>
<symbolfyi-compare slugs="symbols,other-slug"></symbolfyi-compare>
<symbolfyi-search placeholder="Search Symbols..."></symbolfyi-search>

<script src="https://cdn.jsdelivr.net/npm/symbolfyi-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-symbolfyi="entity" data-slug="symbols" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/symbolfyi-embed@1/dist/embed.min.js"></script>

Side-by-Side Comparison

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

Search Box

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

Glossary Term

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

CDN Options

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

<script src="https://cdn.jsdelivr.net/npm/symbolfyi-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 symbolfyi-embed

import 'symbolfyi-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 Minimal (flat design)
• 4 themes: Light, Dark, Sepia, Auto (OS preference detection)
• CORS: SymbolFYI 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: ~11-21KB gzipped (per-site build — only includes tools available on SymbolFYI)

Learn More About Symbols

Visit symbolfyi.com — SymbolFYI is a comprehensive symbols reference with interactive tools, guides, and developer resources.

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

Creative FYI Family

Part of FYIPedia — open-source developer tools ecosystem. Creative FYI covers design, typography, characters, and visual encoding.

| Site | Domain | Focus | Package | |------|--------|-------|---------| | ColorFYI | colorfyi.com | Color conversion, WCAG contrast, harmonies — 16.7M hex colors | npm | | FontFYI | fontfyi.com | Google Fonts metadata, CSS generation, font pairings | npm | | EmojiFYI | emojifyi.com | 3,781 emojis, Unicode Emoji 16.0, 8 encodings | npm | | SymbolFYI | symbolfyi.com | Symbol encoding in 11 formats, Unicode properties | npm | | UnicodeFYI | unicodefyi.com | Unicode characters, 17 encodings, text analysis | npm |

License

MIT — see LICENSE.

Built with care by FYIPedia.