dinofyi-embed
v1.1.0
Published
Embed DinoFYI paleontology widgets — dinosaur cards, period timelines, diet badges, size comparisons. Zero dependencies, Shadow DOM, 4 themes.
Maintainers
Readme
dinofyi-embed
Embed DinoFYI widgets — dinosaurs, glossary terms, interactive tools, and inline elements — on any website. 11 widget types, zero dependencies, Shadow DOM style isolation, 4 built-in themes (light, dark, sepia, auto), 2 styles (modern, organic), and live data from the DinoFYI database.
Every widget includes a "Powered by DinoFYI" backlink directing readers to the full reference.
Try the interactive widget builder at widget.dinofyi.com
Quick Start
<!-- Place widget div where you want it to appear -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-theme="light"></div>
<!-- Load the embed script once, anywhere on the page -->
<script src="https://cdn.jsdelivr.net/npm/dinofyi-embed@1/dist/embed.min.js"></script>That's it. The widget fetches data from the DinoFYI API and renders with full style isolation.
Widget Types
| Type | Usage | Description |
|------|-------|-------------|
| entity | <div data-dinofyi="entity" data-slug="..."></div> | Entity detail card — species, bird, fish, plant, or dinosaur |
| glossary | <div data-dinofyi="glossary" data-slug="..."></div> | Glossary term definition with cross-references |
| guide | <div data-dinofyi="guide" data-slug="..."></div> | Guide summary card with key takeaways |
| compare | <div data-dinofyi="compare" data-slug="..."></div> | Side-by-side entity comparison |
| search | <div data-dinofyi="search" data-slug="..."></div> | Search box linking to the full database |
| iucn-badge | <div data-dinofyi="iucn-badge" data-slug="..."></div> | IUCN conservation status badge with 9 status levels |
| period-timeline | <div data-dinofyi="period-timeline" data-slug="..."></div> | Geological period bar (Triassic → Jurassic → Cretaceous) |
| diet-badge | <div data-dinofyi="diet-badge" data-slug="..."></div> | Herbivore/Carnivore/Omnivore icon badge |
| iucn-inline | <div data-dinofyi="iucn-inline" data-slug="..."></div> | Inline IUCN status colored pill |
| period-inline | <div data-dinofyi="period-inline" data-slug="..."></div> | Inline geological period colored pill |
| taxonomy-inline | <div data-dinofyi="taxonomy-inline" data-slug="..."></div> | Italic scientific binomial name |
Widget Options
| Attribute | Values | Default | Description |
|-----------|--------|---------|-------------|
| data-dinofyi | entity, compare, glossary, guide, search, [tools] | required | Widget type |
| data-slug | e.g. "dinosaurs" | — | Entity slug from the DinoFYI database |
| data-theme | light, dark, sepia, auto | light | Visual theme (auto follows OS preference) |
| data-styleVariant | modern, organic | modern | Widget design style |
| data-size | default, compact, large | default | Widget size |
| data-placeholder | any string | "Search Dinosaurs..." | Search box placeholder |
Themes
<!-- Light (default) -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-theme="light"></div>
<!-- Dark -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-theme="dark"></div>
<!-- Sepia -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-theme="sepia"></div>
<!-- Auto — follows OS dark/light preference -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-theme="auto"></div>Styles
<!-- Modern (default) — clean lines, rounded corners, accent gradients -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-styleVariant="modern"></div>
<!-- Organic — natural curves, earth-tone aesthetics, field-guide look -->
<div data-dinofyi="entity" data-slug="dinosaurs" data-styleVariant="organic"></div>Web Components (Custom Elements)
As an alternative to data-* attributes, you can use native HTML custom elements:
<!-- Custom element form -->
<dinofyi-entity slug="dinosaurs" theme="light"></dinofyi-entity>
<dinofyi-compare slugs="dinosaurs,other-slug"></dinofyi-compare>
<dinofyi-search placeholder="Search Dinosaurs..."></dinofyi-search>
<script src="https://cdn.jsdelivr.net/npm/dinofyi-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-dinofyi="entity" data-slug="dinosaurs" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/dinofyi-embed@1/dist/embed.min.js"></script>Side-by-Side Comparison
<div data-dinofyi="compare" data-slugs="dinosaurs,other-slug"></div>
<script src="https://cdn.jsdelivr.net/npm/dinofyi-embed@1/dist/embed.min.js"></script>Search Box
<div data-dinofyi="search" data-placeholder="Search Dinosaurs..."></div>
<script src="https://cdn.jsdelivr.net/npm/dinofyi-embed@1/dist/embed.min.js"></script>Glossary Term
<div data-dinofyi="glossary" data-slug="example-term" data-theme="light"></div>
<script src="https://cdn.jsdelivr.net/npm/dinofyi-embed@1/dist/embed.min.js"></script>CDN Options
jsDelivr (recommended — global CDN, auto-updates with npm)
<script src="https://cdn.jsdelivr.net/npm/dinofyi-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 dinofyi-embedimport 'dinofyi-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 Organic (natural curves, field-guide aesthetic)
- 4 themes: Light, Dark, Sepia, Auto (OS preference detection)
- CORS: DinoFYI 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 DinoFYI
Learn More About Dinosaurs
Visit dinofyi.com — DinoFYI is a comprehensive dinosaurs reference with interactive tools, guides, and developer resources.
- API docs: dinofyi.com/developers/
- Widget builder: widget.dinofyi.com
- npm package: npmjs.com/package/dinofyi-embed
- GitHub: github.com/fyipedia/dinofyi-embed
Nature FYI Family
Part of FYIPedia — open-source developer tools ecosystem. Nature FYI covers species taxonomy, ornithology, marine biology, botany, and paleontology. Hub: naturefyi.com.
| Site | Domain | Focus | Package | |------|--------|-------|---------| | SpeciesFYI | speciesfyi.com | Species taxonomy, biodiversity, IUCN conservation status | npm | | BirdFYI | birdfyi.com | 11,251 birds, biometrics, conservation, habitats | npm | | FishFYI | fishfyi.com | 35,729 fish, game fishing, aquarium care, compatibility | npm | | PlantFYI | plantfyi.com | 379,774 plants, hardiness zones, bloom seasons, gardening | npm | | DinoFYI | dinofyi.com | 6,142 dinosaurs, geological periods, paleontology | npm |
License
MIT — see LICENSE.
Built with care by FYIPedia.
