crumb-widget 1.0.0
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/LICENSE +21 -0
- package/README.md +48 -0
- package/dist/module.d.ts +22 -0
- package/dist/module.js +10135 -0
- package/package.json +72 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026-present The BMLT Enabled Community
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Crumb Widget
|
|
2
|
+
|
|
3
|
+
[](https://github.com/bmlt-enabled/crumb-widget/actions/workflows/test.yml)
|
|
4
|
+
[](https://codecov.io/gh/bmlt-enabled/crumb-widget)
|
|
5
|
+
|
|
6
|
+
An embeddable NA meeting finder widget. Drop a `<div>` and a `<script>` tag into any page and get a fully functional
|
|
7
|
+
meeting finder - search, filters, list view, map, and meeting detail.
|
|
8
|
+
|
|
9
|
+
Built with Svelte 5, compiled to a **single self-contained JavaScript file** with no host-page dependencies.
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- List and map views with real-time search and filters
|
|
14
|
+
- Meeting detail with directions, virtual join link, and formats
|
|
15
|
+
- Geolocation-based nearby search
|
|
16
|
+
- Multi-language support
|
|
17
|
+
- Configurable columns, map tiles, and custom markers
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
```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
|
+
<div
|
|
31
|
+
id="crumb-widget"
|
|
32
|
+
data-root-server="https://myserver.com/main_server/"
|
|
33
|
+
data-service-body="3"
|
|
34
|
+
></div>
|
|
35
|
+
<script type="module" src="https://cdn.aws.bmlt.app/crumb-widget.js"></script>
|
|
36
|
+
</body>
|
|
37
|
+
</html>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
**Important:** Be sure your page includes `<meta name="viewport" content="width=device-width, initial-scale=1.0" />` in the `<head>`. This is important for proper rendering on mobile devices and small screens.
|
|
41
|
+
|
|
42
|
+
Full documentation at **[crumb.bmlt.app](https://crumb.bmlt.app/)**.
|
|
43
|
+
|
|
44
|
+
## Philosophy
|
|
45
|
+
|
|
46
|
+
This project aims to cover the needs of most NA service bodies well - not every possible use case. It is intentionally
|
|
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.
|
package/dist/module.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { CrumbWidgetConfig, Column } from './types';
|
|
2
|
+
export type { CrumbWidgetConfig, Column };
|
|
3
|
+
export interface MountOptions extends CrumbWidgetConfig {
|
|
4
|
+
/** URL of the BMLT root server (required) */
|
|
5
|
+
rootServerUrl: string;
|
|
6
|
+
/** Service body IDs to filter by (defaults to all) */
|
|
7
|
+
serviceBodyIds?: number[];
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Mount the Crumb Widget into the given element.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* import { mountCrumbWidget } from 'crumb-widget';
|
|
15
|
+
*
|
|
16
|
+
* mountCrumbWidget(document.getElementById('my-widget'), {
|
|
17
|
+
* rootServerUrl: 'https://bmlt.example.org/main_server/',
|
|
18
|
+
* serviceBodyIds: [1, 2, 3],
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export declare function mountCrumbWidget(el: HTMLElement, options: MountOptions): void;
|