An open API service indexing awesome lists of open source software.

https://github.com/bmlt-enabled/crumb-widget

An embeddable NA meeting finder widget for any platform
https://github.com/bmlt-enabled/crumb-widget

Last synced: 4 days ago
JSON representation

An embeddable NA meeting finder widget for any platform

Awesome Lists containing this project

README

          


Crumb Widget logo

Crumb Widget


test
codecov
npm
docs


🌐 English | Español | Português (Brasil) | Français | Deutsch | Italiano | Svenska | Dansk | Polski | Ελληνικά | Русский | 日本語 | فارسی


👉 Live demo: crumb.bmlt.app/meetings.html


Crumb Widget — list, map, and meeting detail views

An embeddable NA meeting finder widget. Built with Svelte 5, distributed as a single self-contained JavaScript file. Available as a [WordPress plugin](https://wordpress.org/plugins/crumb/), [Drupal module](https://github.com/bmlt-enabled/crumb-drupal), [Joomla extension](https://github.com/bmlt-enabled/crumb-joomla), [CDN script](https://cdn.aws.bmlt.app/crumb-widget.js), or [npm package](https://www.npmjs.com/package/crumb-widget).

## Which version should I use?

| Your site | Use this |
|-------------------------------------------------------|--------------------------------------------------------------------------|
| **WordPress** | [WordPress plugin](https://wordpress.org/plugins/crumb/) |
| **Drupal** 10.3+ or 11 | [Drupal module](https://github.com/bmlt-enabled/crumb-drupal) |
| **Joomla** 4, 5, or 6 | [Joomla extension](https://github.com/bmlt-enabled/crumb-joomla) |
| **Wix, Squarespace, Google Sites, or plain HTML** | Paste the [CDN snippet](#quick-start) into a code block |
| **A JS/TS app** (React, Svelte, Vue, Vite, etc.) | `npm install crumb-widget` ([docs](https://crumb.bmlt.app/#npm-package)) |

## Features

- List and map views with real-time search and filters
- Meeting detail with directions, virtual join link, and formats
- Geolocation-based nearby search, plus typed location search by city, postal code, or address
- Individual meeting links via built-in router
- 13 built-in languages (English, Español, Português (Brasil), Français, Deutsch, Italiano, Svenska, Dansk, Polski, Ελληνικά, Русский, 日本語, فارسی — including RTL layout for Persian)
- Configurable columns, map tiles, and custom markers
- Optional "Update Meeting Info" link on each meeting detail — point at a [bmlt-workflow](https://github.com/bmlt-enabled/bmlt-workflow) form, any custom form, or a `mailto:` URL ([docs](https://crumb.bmlt.app/#update-url))
- Printer-friendly list view

## Quick Start

**What you'll need:**

1. Your **BMLT server URL** — usually something like `https://bmlt.example.org/main_server/`. Ask your service body's webservant if you don't have it.
2. (Optional) A **service body ID** to filter to a specific area or region. [How to find it →](https://crumb.bmlt.app/#find-service-body)

**Minimum viable embed** (paste into any HTML page, Squarespace code block, Wix HTML embed, etc.):

```html

```

**Filter to a single service body:**

```html

```

## Documentation

Check out the full Crumb documentation — including configuration options, examples, and a getting started guide at **[crumb.bmlt.app](https://crumb.bmlt.app/)**.

## Need help?

- 🐛 **Bug or feature request:** open an issue on [GitHub](https://github.com/bmlt-enabled/crumb-widget/issues)
- 📧 **Email:** [help@bmlt.app](mailto:help@bmlt.app)
- 💬 **Community:** the [BMLT Facebook group](https://www.facebook.com/groups/bmltapp/)

## License

MIT