crumb-widget 1.4.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -0
- package/dist/module.js +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="docs/crumb-logo.svg" alt="Crumb Widget logo" width="128" height="128">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">Crumb Widget</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://github.com/bmlt-enabled/crumb-widget/actions/workflows/test.yml"><img src="https://github.com/bmlt-enabled/crumb-widget/actions/workflows/test.yml/badge.svg" alt="test"></a>
|
|
9
|
+
<a href="https://codecov.io/gh/bmlt-enabled/crumb-widget"><img src="https://codecov.io/gh/bmlt-enabled/crumb-widget/graph/badge.svg" alt="codecov"></a>
|
|
10
|
+
<a href="https://www.npmjs.com/package/crumb-widget"><img src="https://img.shields.io/npm/v/crumb-widget" alt="npm"></a>
|
|
11
|
+
<a href="https://crumb.bmlt.app/"><img src="https://img.shields.io/badge/docs-crumb.bmlt.app-blue" alt="docs"></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<p align="center">
|
|
15
|
+
🌐 English | <a href="docs/intl/README.es.md">Español</a> | <a href="docs/intl/README.pt-BR.md">Português (Brasil)</a> | <a href="docs/intl/README.fr.md">Français</a> | <a href="docs/intl/README.de.md">Deutsch</a> | <a href="docs/intl/README.it.md">Italiano</a> | <a href="docs/intl/README.sv.md">Svenska</a> | <a href="docs/intl/README.da.md">Dansk</a> | <a href="docs/intl/README.pl.md">Polski</a> | <a href="docs/intl/README.el.md">Ελληνικά</a> | <a href="docs/intl/README.ru.md">Русский</a> | <a href="docs/intl/README.ja.md">日本語</a> | <a href="docs/intl/README.fa.md">فارسی</a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
<p align="center">
|
|
19
|
+
<strong>👉 Live demo:</strong> <a href="https://crumb.bmlt.app/meetings.html">crumb.bmlt.app/meetings.html</a>
|
|
20
|
+
</p>
|
|
21
|
+
|
|
22
|
+
<p align="center">
|
|
23
|
+
<img src="docs/screenshot-carousel.gif" alt="Crumb Widget — list, map, and meeting detail views" width="550">
|
|
24
|
+
</p>
|
|
25
|
+
|
|
26
|
+
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).
|
|
27
|
+
|
|
28
|
+
## Which version should I use?
|
|
29
|
+
|
|
30
|
+
| Your site | Use this |
|
|
31
|
+
|-------------------------------------------------------|--------------------------------------------------------------------------|
|
|
32
|
+
| **WordPress** | [WordPress plugin](https://wordpress.org/plugins/crumb/) |
|
|
33
|
+
| **Drupal** 10.3+ or 11 | [Drupal module](https://github.com/bmlt-enabled/crumb-drupal) |
|
|
34
|
+
| **Joomla** 4, 5, or 6 | [Joomla extension](https://github.com/bmlt-enabled/crumb-joomla) |
|
|
35
|
+
| **Wix, Squarespace, Google Sites, or plain HTML** | Paste the [CDN snippet](#quick-start) into a code block |
|
|
36
|
+
| **A JS/TS app** (React, Svelte, Vue, Vite, etc.) | `npm install crumb-widget` ([docs](https://crumb.bmlt.app/#npm-package)) |
|
|
37
|
+
|
|
38
|
+
## Features
|
|
39
|
+
|
|
40
|
+
- List and map views with real-time search and filters
|
|
41
|
+
- Meeting detail with directions, virtual join link, and formats
|
|
42
|
+
- Geolocation-based nearby search, plus typed location search by city, postal code, or address
|
|
43
|
+
- Individual meeting links via built-in router
|
|
44
|
+
- 13 built-in languages (English, Español, Português (Brasil), Français, Deutsch, Italiano, Svenska, Dansk, Polski, Ελληνικά, Русский, 日本語, فارسی — including RTL layout for Persian)
|
|
45
|
+
- Configurable columns, map tiles, and custom markers
|
|
46
|
+
- 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))
|
|
47
|
+
- Printer-friendly list view
|
|
48
|
+
|
|
49
|
+
## Quick Start
|
|
50
|
+
|
|
51
|
+
**What you'll need:**
|
|
52
|
+
|
|
53
|
+
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.
|
|
54
|
+
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)
|
|
55
|
+
|
|
56
|
+
**Minimum viable embed** (paste into any HTML page, Squarespace code block, Wix HTML embed, etc.):
|
|
57
|
+
|
|
58
|
+
```html
|
|
59
|
+
<div id="crumb-widget" data-server="https://myserver.com/main_server/"></div>
|
|
60
|
+
<script type="module" src="https://cdn.aws.bmlt.app/crumb-widget.js"></script>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**Filter to a single service body:**
|
|
64
|
+
|
|
65
|
+
```html
|
|
66
|
+
<div id="crumb-widget"
|
|
67
|
+
data-server="https://myserver.com/main_server/"
|
|
68
|
+
data-service-body="3"
|
|
69
|
+
></div>
|
|
70
|
+
<script type="module" src="https://cdn.aws.bmlt.app/crumb-widget.js"></script>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Documentation
|
|
74
|
+
|
|
75
|
+
Check out the full Crumb documentation — including configuration options, examples, and a getting started guide at **[crumb.bmlt.app](https://crumb.bmlt.app/)**.
|
|
76
|
+
|
|
77
|
+
## Need help?
|
|
78
|
+
|
|
79
|
+
- 🐛 **Bug or feature request:** open an issue on [GitHub](https://github.com/bmlt-enabled/crumb-widget/issues)
|
|
80
|
+
- 📧 **Email:** [help@bmlt.app](mailto:help@bmlt.app)
|
|
81
|
+
- 💬 **Community:** the [BMLT Facebook group](https://www.facebook.com/groups/bmltapp/)
|
|
82
|
+
|
|
83
|
+
## License
|
|
84
|
+
|
|
85
|
+
MIT
|
package/dist/module.js
CHANGED
|
@@ -7360,7 +7360,7 @@ Mr(["click"]);
|
|
|
7360
7360
|
function Cu(e, t) {
|
|
7361
7361
|
X.serverUrl = t.serverUrl, X.serviceBodyIds = t.serviceBodyIds ?? [], X.containerId = e.id || "crumb-widget", X.view = js(t.view, Hs.view), X.locationMarker = t.map?.markers?.location, X.tiles = t.map?.tiles, X.tilesDark = t.map?.tiles_dark, X.columns = Ls(t.columns, Hs.columns), X.geolocation = zs("geolocation", t.geolocation, Hs.geolocation), X.geolocationRadius = Ms("geolocationRadius", t.geolocationRadius, Hs.geolocationRadius), X.distanceOptions = Is(t.distanceOptions, Hs.distanceOptions), X.height = Ps(t.height), X.darkMode = Rs(t.darkMode, Hs.darkMode), X.nowOffset = Ns("nowOffset", t.nowOffset, Hs.nowOffset), X.hideHeader = zs("hideHeader", t.hideHeader, Hs.hideHeader), X.updateUrl = Vs(t.updateUrl), t.basePath != null && Ii(!1, t.basePath);
|
|
7362
7362
|
let n = Bs(t.language, ss) ?? (typeof navigator < "u" ? navigator.language : "en");
|
|
7363
|
-
X.distanceUnit = Fs(t.distanceUnit, Cs(n)), gs(n), X.darkMode === "auto" ? e.classList.add("bmlt-dark-auto") : X.darkMode === !0 && e.classList.add("bmlt-dark-force"), console.log("[crumb-widget] v1.4.
|
|
7363
|
+
X.distanceUnit = Fs(t.distanceUnit, Cs(n)), gs(n), X.darkMode === "auto" ? e.classList.add("bmlt-dark-auto") : X.darkMode === !0 && e.classList.add("bmlt-dark-force"), console.log("[crumb-widget] v1.4.1+0db62aa"), Ur(Su, {
|
|
7364
7364
|
target: e,
|
|
7365
7365
|
props: { config: X }
|
|
7366
7366
|
});
|