blefyi-embed
v1.1.0
Published
Embed BLEFYI Bluetooth Low Energy widgets — chip specs, GATT profiles, frequency spectrum, beacons. Zero dependencies, Shadow DOM, 3 themes.
Maintainers
Readme
blefyi-embed
Embed BLEFYI specification widgets — ble chips, technical standards, glossary terms, and interactive tools — on any website. 8 widget types, zero dependencies, Shadow DOM style isolation, 3 built-in themes (light, dark, sepia), and live data from the BLEFYI database.
Every widget includes a "Powered by BLEFYI" backlink directing readers to the full technical reference.
Try the interactive widget builder at widget.blefyi.com
Quick Start
<!-- Place widget div where you want it to appear -->
<div data-blefyi="spec" data-slug="chips" data-theme="light"></div>
<!-- Load the embed script once, anywhere on the page -->
<script src="https://cdn.jsdelivr.net/npm/blefyi-embed@1/dist/embed.min.js"></script>That's it. The widget fetches data from the BLEFYI API and renders with full style isolation.
Widget Types
| Type | Usage | Description |
|------|-------|-------------|
| spec | <div data-blefyi="spec" data-slug="..."></div> | Technical specification card — protocol, range, data rate, standards |
| compare | <div data-blefyi="compare" data-slug="..."></div> | Side-by-side comparison of two technologies or standards |
| features | <div data-blefyi="features" data-slug="..."></div> | Feature list card — capabilities, supported modes, variants |
| glossary | <div data-blefyi="glossary" data-slug="..."></div> | Glossary term definition with cross-references |
| faq | <div data-blefyi="faq" data-slug="..."></div> | FAQ accordion for common technical questions |
| guide | <div data-blefyi="guide" data-slug="..."></div> | Implementation guide — setup, code examples, best practices |
| search | <div data-blefyi="search" data-slug="..."></div> | Search box linking to the full technology database |
| frequency | <div data-blefyi="frequency" data-slug="..."></div> | BLE frequency / channel spectrum — 2.4 GHz band, advertising channels |
Widget Options
| Attribute | Values | Default | Description |
|-----------|--------|---------|-------------|
| data-blefyi | spec, compare, features, glossary, faq, guide, search, [tools] | required | Widget type |
| data-slug | e.g. "chips" | — | Entity slug from the BLEFYI database |
| data-theme | light, dark, sepia, auto | light | Visual theme (auto follows OS preference) |
| data-styleVariant | technical, modern | technical | Widget design style |
| data-size | default, compact, large | default | Widget size |
| data-placeholder | any string | "Search BLE Chips…" | Search box placeholder |
Themes
<!-- Light (default) -->
<div data-blefyi="spec" data-slug="chips" data-theme="light"></div>
<!-- Dark -->
<div data-blefyi="spec" data-slug="chips" data-theme="dark"></div>
<!-- Sepia -->
<div data-blefyi="spec" data-slug="chips" data-theme="sepia"></div>
<!-- Auto — follows OS dark/light preference -->
<div data-blefyi="spec" data-slug="chips" data-theme="auto"></div>Web Components (Custom Elements)
As an alternative to data-* attributes, you can use native HTML custom elements:
<!-- Custom element form -->
<blefyi-spec slug="chips" theme="light"></blefyi-spec>
<blefyi-compare slug-a="chips" slug-b="other-slug"></blefyi-compare>
<blefyi-search placeholder="Search BLE Chips…"></blefyi-search>
<script src="https://cdn.jsdelivr.net/npm/blefyi-embed@1/dist/embed.min.js"></script>Use style-variant (not style) to avoid conflicts with the HTML reserved style attribute.
Examples
Specification Card
<div data-blefyi="spec" data-slug="chips" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/blefyi-embed@1/dist/embed.min.js"></script>Side-by-Side Comparison
<div data-blefyi="compare" data-slug-a="chips" data-slug-b="other-slug"></div>
<script src="https://cdn.jsdelivr.net/npm/blefyi-embed@1/dist/embed.min.js"></script>Search Box
<div data-blefyi="search" data-placeholder="Search BLE Chips…"></div>
<script src="https://cdn.jsdelivr.net/npm/blefyi-embed@1/dist/embed.min.js"></script>Glossary Term
<div data-blefyi="glossary" data-slug="example-term" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/blefyi-embed@1/dist/embed.min.js"></script>CDN Options
jsDelivr (recommended — global CDN, auto-updates with npm)
<script src="https://cdn.jsdelivr.net/npm/blefyi-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 blefyi-embedimport 'blefyi-embed';Technical Details
- Shadow DOM: Complete style isolation — no CSS conflicts with your site
- Zero dependencies: No jQuery, React, or any external library
- JetBrains Mono: Code blocks use JetBrains Mono loaded from jsDelivr
- System fonts: Body text uses system-ui — no extra font requests
- CORS: BLEFYI 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)
- Bundle size: ~11–16KB gzipped (per-site build — only includes tools available on BLEFYI)
Learn More About BLE Chips
Visit blefyi.com — BLEFYI is a comprehensive ble chips technical reference with specifications, standards, interactive tools, and implementation guides.
- API docs: blefyi.com/developers/
- Widget builder: widget.blefyi.com
- npm package: npmjs.com/package/blefyi-embed
- GitHub: github.com/fyipedia/blefyi-embed
Tag FYI Family
Part of FYIPedia — open-source developer tools ecosystem. Tag FYI covers identification, tagging, and wireless communication technologies.
| Site | Domain | Focus | Package | |------|--------|-------|---------| | BarcodeFYI | barcodefyi.com | Barcode formats, EAN, UPC, ISBN, QR, Code 128 standards | npm | | QRCodeFYI | qrcodefyi.com | QR code generation, scanning, error correction, encoding modes | npm | | NFCFYI | nfcfyi.com | NFC tags, NDEF records, contactless payments, ISO 14443 | npm | | BLEFYI | blefyi.com | Bluetooth Low Energy, GATT profiles, beacons, iBeacon, Eddystone | npm | | RFIDFYI | rfidfyi.com | RFID tags, frequency bands, EPC Gen 2, ISO 18000 standards | npm | | SmartCardFYI | smartcardfyi.com | Smart cards, EMV, APDU commands, Java Card, ISO 7816 | npm |
License
MIT — see LICENSE.
Built with care by FYIPedia.
