helpdock 0.1.0 → 0.1.2
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 +243 -0
- package/dist/assets/DemoPage.d.ts +20 -0
- package/dist/components/ArticleDetail.d.ts +18 -0
- package/dist/components/ArticlesTab.d.ts +19 -0
- package/dist/components/ContactTab.d.ts +32 -0
- package/dist/components/HelpDock.d.ts +33 -0
- package/dist/components/Panel.d.ts +20 -0
- package/dist/components/WidgetButton.d.ts +11 -0
- package/dist/context/articles-context.d.ts +11 -0
- package/dist/context/config-context.d.ts +255 -0
- package/dist/helpdock.js +574 -545
- package/dist/helpdock.umd.cjs +34 -34
- package/dist/index.d.ts +9 -0
- package/dist/schema/analytics.d.ts +416 -0
- package/dist/schema/article.d.ts +67 -0
- package/dist/schema/config.d.ts +289 -0
- package/dist/schema/contact.d.ts +268 -0
- package/dist/services/analytics.d.ts +21 -0
- package/dist/services/attachments.d.ts +68 -0
- package/dist/services/search.d.ts +10 -0
- package/dist/types/events.d.ts +38 -0
- package/package.json +5 -3
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { Article } from "../schema/article";
|
|
2
|
+
/**
|
|
3
|
+
* Base event detail types for HelpDock custom events
|
|
4
|
+
*/
|
|
5
|
+
export interface HelpDockEventMap {
|
|
6
|
+
"helpdock:open": CustomEvent<undefined>;
|
|
7
|
+
"helpdock:article-open": CustomEvent<{
|
|
8
|
+
article: Article;
|
|
9
|
+
}>;
|
|
10
|
+
"helpdock:article-close": CustomEvent<undefined>;
|
|
11
|
+
"helpdock:toggle-expand": CustomEvent<undefined>;
|
|
12
|
+
"helpdock:search": CustomEvent<{
|
|
13
|
+
query: string;
|
|
14
|
+
}>;
|
|
15
|
+
"helpdock:switch-tab": CustomEvent<{
|
|
16
|
+
tab: "articles" | "contact";
|
|
17
|
+
}>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Extract event detail type from event name
|
|
21
|
+
*/
|
|
22
|
+
export type HelpDockEventDetail<K extends keyof HelpDockEventMap> = HelpDockEventMap[K] extends CustomEvent<infer D> ? D : never;
|
|
23
|
+
/**
|
|
24
|
+
* Extract event type from event name
|
|
25
|
+
*/
|
|
26
|
+
export type HelpDockEvent<K extends keyof HelpDockEventMap> = HelpDockEventMap[K];
|
|
27
|
+
/**
|
|
28
|
+
* Typed event listener for HelpDock events
|
|
29
|
+
*/
|
|
30
|
+
export type HelpDockEventListener<K extends keyof HelpDockEventMap> = (event: HelpDockEvent<K>) => void;
|
|
31
|
+
/**
|
|
32
|
+
* Helper to create a typed event listener that handles the casting internally
|
|
33
|
+
*/
|
|
34
|
+
export declare function createHelpDockEventListener<K extends keyof HelpDockEventMap>(listener: HelpDockEventListener<K>): EventListener;
|
|
35
|
+
/**
|
|
36
|
+
* Helper to dispatch a typed HelpDock event
|
|
37
|
+
*/
|
|
38
|
+
export declare function dispatchHelpDockEvent<K extends keyof HelpDockEventMap>(element: HTMLElement, eventName: K, detail?: HelpDockEventDetail<K>): void;
|
package/package.json
CHANGED
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "helpdock",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"files": [
|
|
6
|
-
"dist"
|
|
6
|
+
"dist",
|
|
7
|
+
"README.md"
|
|
7
8
|
],
|
|
8
9
|
"main": "./dist/helpdock.umd.cjs",
|
|
9
10
|
"module": "./dist/helpdock.js",
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
10
12
|
"exports": {
|
|
11
13
|
".": {
|
|
12
14
|
"import": "./dist/helpdock.js",
|
|
@@ -15,7 +17,7 @@
|
|
|
15
17
|
},
|
|
16
18
|
"scripts": {
|
|
17
19
|
"dev": "vite",
|
|
18
|
-
"build": "
|
|
20
|
+
"build": "vite build && tsc",
|
|
19
21
|
"preview": "vite preview"
|
|
20
22
|
},
|
|
21
23
|
"dependencies": {
|