crumb-widget 1.1.0 → 1.2.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 +10 -21
- package/dist/module.d.ts +5 -1
- package/dist/module.js +4443 -1765
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -1,48 +1,37 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="pages/crumb-logo.svg" alt="Crumb Widget logo" width="128" height="128">
|
|
3
|
+
</p>
|
|
4
|
+
|
|
1
5
|
# Crumb Widget
|
|
2
6
|
|
|
3
7
|
[](https://github.com/bmlt-enabled/crumb-widget/actions/workflows/test.yml)
|
|
4
8
|
[](https://codecov.io/gh/bmlt-enabled/crumb-widget)
|
|
5
9
|
[](https://www.npmjs.com/package/crumb-widget)
|
|
10
|
+
[](https://crumb.bmlt.app/)
|
|
6
11
|
|
|
7
|
-
An embeddable NA meeting finder widget with
|
|
8
|
-
|
|
9
|
-
Built with Svelte 5, distributed as a **single self-contained JavaScript file** with no host-page dependencies. Available as a CDN script or as an [npm package](https://www.npmjs.com/package/crumb-widget).
|
|
12
|
+
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/), [CDN script](https://cdn.aws.bmlt.app/crumb-widget.js), or [npm package](https://www.npmjs.com/package/crumb-widget).
|
|
10
13
|
|
|
11
14
|
## Features
|
|
12
15
|
|
|
13
16
|
- List and map views with real-time search and filters
|
|
14
17
|
- Meeting detail with directions, virtual join link, and formats
|
|
15
18
|
- Geolocation-based nearby search
|
|
19
|
+
- Individual meeting links via built-in router
|
|
16
20
|
- Multi-language support
|
|
17
21
|
- Configurable columns, map tiles, and custom markers
|
|
22
|
+
- Printer-friendly list view
|
|
18
23
|
|
|
19
24
|
## Quick Start
|
|
20
25
|
|
|
21
26
|
```html
|
|
22
|
-
<!doctype html>
|
|
23
|
-
<html lang="en">
|
|
24
|
-
<head>
|
|
25
|
-
<meta charset="UTF-8" />
|
|
26
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
27
|
-
<title>Meeting Finder</title>
|
|
28
|
-
</head>
|
|
29
|
-
<body>
|
|
30
27
|
<div
|
|
31
28
|
id="crumb-widget"
|
|
32
29
|
data-server="https://myserver.com/main_server/"
|
|
33
30
|
data-service-body="3"
|
|
34
31
|
></div>
|
|
35
32
|
<script type="module" src="https://cdn.aws.bmlt.app/crumb-widget.js"></script>
|
|
36
|
-
</body>
|
|
37
|
-
</html>
|
|
38
33
|
```
|
|
39
34
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
Full documentation at **[crumb.bmlt.app](https://crumb.bmlt.app/)**.
|
|
43
|
-
|
|
44
|
-
## Philosophy
|
|
35
|
+
## License
|
|
45
36
|
|
|
46
|
-
|
|
47
|
-
kept simple and focused. New features are weighed against the cost to the codebase; niche requests that bloat the project
|
|
48
|
-
for everyone are generally out of scope. If you need deep customization, this may not be the right tool.
|
|
37
|
+
MIT
|
package/dist/module.d.ts
CHANGED
|
@@ -2,14 +2,18 @@ export declare type Column = 'time' | 'name' | 'location' | 'address' | 'service
|
|
|
2
2
|
|
|
3
3
|
export declare interface CrumbWidgetConfig {
|
|
4
4
|
language?: string;
|
|
5
|
-
|
|
5
|
+
view?: 'list' | 'map' | 'both';
|
|
6
6
|
columns?: Column[];
|
|
7
7
|
geolocation?: boolean;
|
|
8
8
|
geolocationRadius?: number;
|
|
9
|
+
distanceOptions?: number[];
|
|
10
|
+
distanceUnit?: 'mi' | 'km';
|
|
9
11
|
height?: number;
|
|
10
12
|
darkMode?: 'auto' | true | false;
|
|
11
13
|
nowOffset?: number;
|
|
12
14
|
hideHeader?: boolean;
|
|
15
|
+
/** Base path for History API routing (e.g. '/meetings'). Enables clean URLs without '#'. */
|
|
16
|
+
basePath?: string;
|
|
13
17
|
map?: {
|
|
14
18
|
tiles?: TilesConfig;
|
|
15
19
|
tiles_dark?: TilesConfig;
|