brewfyi-embed
v1.1.3
Published
Embed BrewFYI coffee widgets — varieties, brew methods, roast levels, brew timer. Zero dependencies, Shadow DOM, 4 themes.
Downloads
543
Maintainers
Readme
brewfyi-embed
Embed BrewFYI beverage widgets — coffee varieties, recipes, glossary terms, and interactive tools — on any website. 9 widget types, zero dependencies, Shadow DOM style isolation, 4 built-in themes (light, dark, sepia, auto), and live data from the BrewFYI database.
Every widget includes a "Powered by BrewFYI" backlink directing readers to the full beverage reference.
Try the interactive widget builder at widget.brewfyi.com
Quick Start
<!-- Place widget div where you want it to appear -->
<div data-brewfyi="recipe" data-slug="varieties" data-theme="light"></div>
<!-- Load the embed script once, anywhere on the page -->
<script src="https://cdn.jsdelivr.net/npm/brewfyi-embed@1/dist/embed.min.js"></script>That's it. The widget fetches data from the BrewFYI API and renders with full style isolation.
Widget Types
| Type | Usage | Description |
|------|-------|-------------|
| recipe | <div data-brewfyi="recipe" data-slug="..."></div> | Recipe/entity card — ingredients, technique, ABV, glass type |
| compare | <div data-brewfyi="compare" data-slug="..."></div> | Side-by-side comparison of beverages or styles |
| glossary | <div data-brewfyi="glossary" data-slug="..."></div> | Glossary term definition with cross-references |
| faq | <div data-brewfyi="faq" data-slug="..."></div> | FAQ accordion for common beverage questions |
| guide | <div data-brewfyi="guide" data-slug="..."></div> | Tasting, brewing, or pairing guide summary |
| ingredient | <div data-brewfyi="ingredient" data-slug="..."></div> | Ingredient/variety card — spirit, grape, hop, coffee origin |
| pairing | <div data-brewfyi="pairing" data-slug="..."></div> | Food pairing suggestions — "What goes with...?" |
| search | <div data-brewfyi="search" data-slug="..."></div> | Search box linking to the full beverage database |
| brew-timer | <div data-brewfyi="brew-timer" data-slug="..."></div> | Countdown timer with pre-filled brew method parameters |
Widget Options
| Attribute | Values | Default | Description |
|-----------|--------|---------|-------------|
| data-brewfyi | recipe, compare, glossary, faq, guide, ingredient, pairing, search, [tools] | required | Widget type |
| data-slug | e.g. "varieties" | — | Entity slug from the BrewFYI database |
| data-theme | light, dark, sepia, auto | light | Visual theme (auto follows OS preference) |
| data-styleVariant | modern, classic | modern | Widget design style |
| data-size | default, compact, large | default | Widget size |
| data-placeholder | any string | "Search Coffee Varieties..." | Search box placeholder |
Themes
<!-- Light (default) -->
<div data-brewfyi="recipe" data-slug="varieties" data-theme="light"></div>
<!-- Dark -->
<div data-brewfyi="recipe" data-slug="varieties" data-theme="dark"></div>
<!-- Sepia -->
<div data-brewfyi="recipe" data-slug="varieties" data-theme="sepia"></div>
<!-- Auto — follows OS dark/light preference -->
<div data-brewfyi="recipe" data-slug="varieties" data-theme="auto"></div>Web Components (Custom Elements)
As an alternative to data-* attributes, you can use native HTML custom elements:
<!-- Custom element form -->
<brewfyi-recipe slug="varieties" theme="light"></brewfyi-recipe>
<brewfyi-compare slugs="varieties,other-slug"></brewfyi-compare>
<brewfyi-search placeholder="Search Coffee Varieties..."></brewfyi-search>
<script src="https://cdn.jsdelivr.net/npm/brewfyi-embed@1/dist/embed.min.js"></script>Use style-variant (not style) to avoid conflicts with the HTML reserved style attribute.
Examples
Recipe Card
<div data-brewfyi="recipe" data-slug="varieties" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/brewfyi-embed@1/dist/embed.min.js"></script>Side-by-Side Comparison
<div data-brewfyi="compare" data-slugs="varieties,other-slug"></div>
<script src="https://cdn.jsdelivr.net/npm/brewfyi-embed@1/dist/embed.min.js"></script>Search Box
<div data-brewfyi="search" data-placeholder="Search Coffee Varieties..."></div>
<script src="https://cdn.jsdelivr.net/npm/brewfyi-embed@1/dist/embed.min.js"></script>Glossary Term
<div data-brewfyi="glossary" data-slug="example-term" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/brewfyi-embed@1/dist/embed.min.js"></script>CDN Options
jsDelivr (recommended — global CDN, auto-updates with npm)
<script src="https://cdn.jsdelivr.net/npm/brewfyi-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 brewfyi-embedimport 'brewfyi-embed';Technical Details
- Shadow DOM: Complete style isolation — no CSS conflicts with your site
- Zero dependencies: No jQuery, React, or any external library
- Geist Sans: Body text uses Geist Sans for a clean, modern look
- System fonts: Fallback to system-ui — no extra font requests
- CORS: BrewFYI 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: ~10-16KB gzipped (per-site build — only includes tools available on BrewFYI)
Learn More About Coffee Varieties
Visit brewfyi.com — BrewFYI is a comprehensive coffee varieties reference with recipes, tasting notes, interactive tools, and beverage guides.
- API docs: brewfyi.com/developers/
- Widget builder: widget.brewfyi.com
- npm package: npmjs.com/package/brewfyi-embed
- GitHub: github.com/fyipedia/brewfyi-embed
Beverage FYI Family
Part of FYIPedia — open-source developer tools ecosystem. Beverage FYI covers world beverages — cocktails, wine, beer, whiskey, sake, tea, and coffee.
| Site | Domain | Focus | Package | |------|--------|-------|---------| | CocktailFYI | cocktailfyi.com | 636 cocktails, ABV, calories, flavor profiles, glass types | npm | | VinoFYI | vinofyi.com | Wines, grapes, regions, wineries, food pairings | npm | | BeerFYI | beerfyi.com | 113 beer styles, hops, malts, yeast, BJCP guide | npm | | BrewFYI | brewfyi.com | 72 coffee varieties, roasting, 21 brew methods | npm | | WhiskeyFYI | whiskeyfyi.com | 2,200+ whiskey expressions, distilleries, regions | npm | | TeaFYI | teafyi.com | 60+ tea varieties, teaware, brewing guides | npm | | NihonshuFYI | nihonshufyi.com | 80 sake, rice varieties, 50 breweries | npm |
License
MIT — see LICENSE.
Built with care by FYIPedia.
