@glowhop/angular-tour 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/.npmignore +2 -0
- package/CHANGELOG.md +12 -0
- package/LICENSE +22 -0
- package/README.md +33 -0
- package/config/index.d.ts +5 -0
- package/config/package.json +3 -0
- package/config/public-api.d.ts +37 -0
- package/esm2022/config/glowhop-angular-tour-config.mjs +5 -0
- package/esm2022/config/public-api.mjs +25 -0
- package/esm2022/glowhop-angular-tour.mjs +5 -0
- package/esm2022/lib/components/default-tour.mjs +66 -0
- package/esm2022/lib/components/tour-components.mjs +624 -0
- package/esm2022/lib/glow-tour.mjs +10 -0
- package/esm2022/public-api.mjs +4 -0
- package/fesm2022/glowhop-angular-tour-config.mjs +32 -0
- package/fesm2022/glowhop-angular-tour-config.mjs.map +1 -0
- package/fesm2022/glowhop-angular-tour.mjs +704 -0
- package/fesm2022/glowhop-angular-tour.mjs.map +1 -0
- package/index.d.ts +5 -0
- package/lib/components/default-tour.d.ts +11 -0
- package/lib/components/tour-components.d.ts +173 -0
- package/lib/glow-tour.d.ts +20 -0
- package/package.json +51 -0
- package/public-api.d.ts +6 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { createGlowTour as createCoreGlowTour } from "@glowhop/core-tour";
|
|
2
|
+
/**
|
|
3
|
+
* Creates a new GlowTour.js instance for Angular.
|
|
4
|
+
* @param options Tour options for error handling.
|
|
5
|
+
* @returns A tour controller ready to run Angular workflows.
|
|
6
|
+
*/
|
|
7
|
+
export function createGlowTour(options = {}) {
|
|
8
|
+
return createCoreGlowTour(options);
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2xvdy10b3VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9nbG93LXRvdXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBU0EsT0FBTyxFQUFFLGNBQWMsSUFBSSxrQkFBa0IsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBZTFFOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsY0FBYyxDQUFDLFVBQTJCLEVBQUU7SUFDMUQsT0FBTyxrQkFBa0IsQ0FBcUIsT0FBTyxDQUFDLENBQUM7QUFDekQsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgVGVtcGxhdGVSZWYgfSBmcm9tIFwiQGFuZ3VsYXIvY29yZVwiO1xuaW1wb3J0IHR5cGUge1xuICBHbG93VG91ciBhcyBDb3JlR2xvd1RvdXIsXG4gIFN0YXJ0T3B0aW9ucyBhcyBDb3JlU3RhcnRPcHRpb25zLFxuICBTdGVwUHJvcHNTdG9yZSBhcyBDb3JlU3RlcFByb3BzU3RvcmUsXG4gIFRvdXJTdGF0ZSBhcyBDb3JlVG91clN0YXRlLFxuICBXb3JrZmxvd0RlZmluaXRpb24gYXMgQ29yZVdvcmtmbG93RGVmaW5pdGlvbixcbiAgR2xvd1RvdXJPcHRpb25zLFxufSBmcm9tIFwiQGdsb3dob3AvY29yZS10b3VyXCI7XG5pbXBvcnQgeyBjcmVhdGVHbG93VG91ciBhcyBjcmVhdGVDb3JlR2xvd1RvdXIgfSBmcm9tIFwiQGdsb3dob3AvY29yZS10b3VyXCI7XG5cbi8qKiBBbmd1bGFyIGNvbnRlbnQgdHlwZTogc3RyaW5nIG9yIFRlbXBsYXRlUmVmLiAqL1xuZXhwb3J0IHR5cGUgQW5ndWxhclRvdXJDb250ZW50ID0gc3RyaW5nIHwgVGVtcGxhdGVSZWY8dW5rbm93bj47XG4vKiogQW5ndWxhciB0b3VyIGNvbnRyb2xsZXIgaW5zdGFuY2UuICovXG5leHBvcnQgdHlwZSBUb3VyID0gQ29yZUdsb3dUb3VyPEFuZ3VsYXJUb3VyQ29udGVudD47XG4vKiogQW5ndWxhciB0b3VyIHN0YXRlIHNuYXBzaG90LiAqL1xuZXhwb3J0IHR5cGUgVG91clN0YXRlID0gQ29yZVRvdXJTdGF0ZTxBbmd1bGFyVG91ckNvbnRlbnQ+O1xuLyoqIEFuZ3VsYXIgc3RlcCBwcm9wZXJ0aWVzIHN0b3JlLiAqL1xuZXhwb3J0IHR5cGUgU3RlcFByb3BzU3RvcmUgPSBDb3JlU3RlcFByb3BzU3RvcmU8QW5ndWxhclRvdXJDb250ZW50Pjtcbi8qKiBBbmd1bGFyIHdvcmtmbG93IGRlZmluaXRpb24uICovXG5leHBvcnQgdHlwZSBXb3JrZmxvd0RlZmluaXRpb24gPSBDb3JlV29ya2Zsb3dEZWZpbml0aW9uPEFuZ3VsYXJUb3VyQ29udGVudD47XG4vKiogQW5ndWxhciB0b3VyIHN0YXJ0IG9wdGlvbnMuICovXG5leHBvcnQgdHlwZSBTdGFydE9wdGlvbnMgPSBDb3JlU3RhcnRPcHRpb25zPEFuZ3VsYXJUb3VyQ29udGVudD47XG5cbi8qKlxuICogQ3JlYXRlcyBhIG5ldyBHbG93VG91ci5qcyBpbnN0YW5jZSBmb3IgQW5ndWxhci5cbiAqIEBwYXJhbSBvcHRpb25zIFRvdXIgb3B0aW9ucyBmb3IgZXJyb3IgaGFuZGxpbmcuXG4gKiBAcmV0dXJucyBBIHRvdXIgY29udHJvbGxlciByZWFkeSB0byBydW4gQW5ndWxhciB3b3JrZmxvd3MuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBjcmVhdGVHbG93VG91cihvcHRpb25zOiBHbG93VG91ck9wdGlvbnMgPSB7fSk6IFRvdXIge1xuICByZXR1cm4gY3JlYXRlQ29yZUdsb3dUb3VyPEFuZ3VsYXJUb3VyQ29udGVudD4ob3B0aW9ucyk7XG59XG4iXX0=
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { GlowTourDefault } from "./lib/components/default-tour";
|
|
2
|
+
export { GlowTourAdvanceTrigger, GlowTourBackTrigger, GlowTourCancelTrigger, GlowTourContent, GlowTourFooter, GlowTourHeader, GlowTourOverlay, GlowTourPointer, GlowTourPopover, GlowTourRoot, injectGlowTour, } from "./lib/components/tour-components";
|
|
3
|
+
export { createGlowTour } from "./lib/glow-tour";
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHVibGljLWFwaS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9wdWJsaWMtYXBpLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUtoRSxPQUFPLEVBQ0wsc0JBQXNCLEVBQ3RCLG1CQUFtQixFQUNuQixxQkFBcUIsRUFDckIsZUFBZSxFQUNmLGNBQWMsRUFDZCxjQUFjLEVBQ2QsZUFBZSxFQUNmLGVBQWUsRUFDZixlQUFlLEVBQ2YsWUFBWSxFQUNaLGNBQWMsR0FDZixNQUFNLGtDQUFrQyxDQUFDO0FBUzFDLE9BQU8sRUFBRSxjQUFjLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB0eXBlIHsgR2xvd1RvdXJPcHRpb25zIH0gZnJvbSBcIkBnbG93aG9wL2NvcmUtdG91clwiO1xuZXhwb3J0IHsgR2xvd1RvdXJEZWZhdWx0IH0gZnJvbSBcIi4vbGliL2NvbXBvbmVudHMvZGVmYXVsdC10b3VyXCI7XG5leHBvcnQgdHlwZSB7XG4gIFBvaW50ZXJEaXJlY3Rpb25Db250ZW50LFxuICBQb2ludGVyRGlyZWN0aW9uVmFsdWUsXG59IGZyb20gXCIuL2xpYi9jb21wb25lbnRzL3RvdXItY29tcG9uZW50c1wiO1xuZXhwb3J0IHtcbiAgR2xvd1RvdXJBZHZhbmNlVHJpZ2dlcixcbiAgR2xvd1RvdXJCYWNrVHJpZ2dlcixcbiAgR2xvd1RvdXJDYW5jZWxUcmlnZ2VyLFxuICBHbG93VG91ckNvbnRlbnQsXG4gIEdsb3dUb3VyRm9vdGVyLFxuICBHbG93VG91ckhlYWRlcixcbiAgR2xvd1RvdXJPdmVybGF5LFxuICBHbG93VG91clBvaW50ZXIsXG4gIEdsb3dUb3VyUG9wb3ZlcixcbiAgR2xvd1RvdXJSb290LFxuICBpbmplY3RHbG93VG91cixcbn0gZnJvbSBcIi4vbGliL2NvbXBvbmVudHMvdG91ci1jb21wb25lbnRzXCI7XG5leHBvcnQgdHlwZSB7XG4gIEFuZ3VsYXJUb3VyQ29udGVudCxcbiAgU3RhcnRPcHRpb25zLFxuICBTdGVwUHJvcHNTdG9yZSxcbiAgVG91cixcbiAgVG91clN0YXRlLFxuICBXb3JrZmxvd0RlZmluaXRpb24sXG59IGZyb20gXCIuL2xpYi9nbG93LXRvdXJcIjtcbmV4cG9ydCB7IGNyZWF0ZUdsb3dUb3VyIH0gZnJvbSBcIi4vbGliL2dsb3ctdG91clwiO1xuIl19
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { createWorkflowFromConfig as createWorkflowFromConfig$1, validateWorkflowConfig as validateWorkflowConfig$1 } from '@glowhop/core-tour/config';
|
|
2
|
+
export { ConfigValidationError } from '@glowhop/core-tour/config';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Builds an Angular `WorkflowDefinition` from a JSON-serializable config, pre-bound to
|
|
6
|
+
* `AngularTourContent` so the result is accepted by `createGlowTour().run(...)` with no generic
|
|
7
|
+
* and no cast.
|
|
8
|
+
* @param config The parsed JSON (or equivalent plain object) to build from.
|
|
9
|
+
* @param options Options; see `CreateWorkflowFromConfigOptions`.
|
|
10
|
+
* @throws {ConfigValidationError} When the config is invalid.
|
|
11
|
+
* @returns A frozen `WorkflowDefinition` with `.source` attached.
|
|
12
|
+
*/
|
|
13
|
+
function createWorkflowFromConfig(config, options = {}) {
|
|
14
|
+
return createWorkflowFromConfig$1(config, options);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Validates and narrows an unknown value to an Angular `WorkflowConfig`.
|
|
18
|
+
* @param config The parsed JSON (or equivalent plain object) to validate.
|
|
19
|
+
* @param options Validation options; see `ValidateWorkflowConfigOptions`.
|
|
20
|
+
* @throws {ConfigValidationError} When one or more issues are found.
|
|
21
|
+
* @returns The same value, narrowed to `WorkflowConfig`.
|
|
22
|
+
*/
|
|
23
|
+
function validateWorkflowConfig(config, options = {}) {
|
|
24
|
+
return validateWorkflowConfig$1(config, options);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Generated bundle index. Do not edit.
|
|
29
|
+
*/
|
|
30
|
+
|
|
31
|
+
export { createWorkflowFromConfig, validateWorkflowConfig };
|
|
32
|
+
//# sourceMappingURL=glowhop-angular-tour-config.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"glowhop-angular-tour-config.mjs","sources":["../../config/public-api.ts","../../config/glowhop-angular-tour-config.ts"],"sourcesContent":["import type { AngularTourContent } from \"@glowhop/angular-tour\";\nimport type {\n BuiltinAction,\n ConfigValidationIssue,\n EventHandlerConfig as CoreEventHandlerConfig,\n LifecycleActionRef as CoreLifecycleActionRef,\n StepActionRef as CoreStepActionRef,\n StepConfig as CoreStepConfig,\n TransitionActionRef as CoreTransitionActionRef,\n WorkflowConfig as CoreWorkflowConfig,\n WorkflowDefinitionFromConfig as CoreWorkflowDefinitionFromConfig,\n CreateWorkflowFromConfigOptions,\n ValidateWorkflowConfigOptions,\n} from \"@glowhop/core-tour/config\";\nimport {\n ConfigValidationError,\n createWorkflowFromConfig as createCoreWorkflowFromConfig,\n validateWorkflowConfig as validateCoreWorkflowConfig,\n} from \"@glowhop/core-tour/config\";\n\nexport type {\n BuiltinAction,\n ConfigValidationIssue,\n CreateWorkflowFromConfigOptions,\n ValidateWorkflowConfigOptions,\n};\nexport { ConfigValidationError };\n\n/** Angular workflow config: `WorkflowConfig` pre-bound to `AngularTourContent`. */\nexport type WorkflowConfig = CoreWorkflowConfig<AngularTourContent>;\n/** Angular step config: `StepConfig` pre-bound to `AngularTourContent`. */\nexport type StepConfig = CoreStepConfig<AngularTourContent>;\n/** Angular event handler config: `EventHandlerConfig` pre-bound to `AngularTourContent`. */\nexport type EventHandlerConfig = CoreEventHandlerConfig<AngularTourContent>;\n/** Angular step action reference: `StepActionRef` pre-bound to `AngularTourContent`. */\nexport type StepActionRef = CoreStepActionRef<AngularTourContent>;\n/** Angular transition action reference: `TransitionActionRef` pre-bound to `AngularTourContent`. */\nexport type TransitionActionRef = CoreTransitionActionRef<AngularTourContent>;\n/** Angular lifecycle action reference: `LifecycleActionRef` pre-bound to `AngularTourContent`. */\nexport type LifecycleActionRef = CoreLifecycleActionRef<AngularTourContent>;\n/** Angular workflow definition produced from config, pre-bound to `AngularTourContent`. */\nexport type WorkflowDefinitionFromConfig = CoreWorkflowDefinitionFromConfig<AngularTourContent>;\n\n/**\n * Builds an Angular `WorkflowDefinition` from a JSON-serializable config, pre-bound to\n * `AngularTourContent` so the result is accepted by `createGlowTour().run(...)` with no generic\n * and no cast.\n * @param config The parsed JSON (or equivalent plain object) to build from.\n * @param options Options; see `CreateWorkflowFromConfigOptions`.\n * @throws {ConfigValidationError} When the config is invalid.\n * @returns A frozen `WorkflowDefinition` with `.source` attached.\n */\nexport function createWorkflowFromConfig(\n config: unknown,\n options: CreateWorkflowFromConfigOptions = {},\n): WorkflowDefinitionFromConfig {\n return createCoreWorkflowFromConfig<AngularTourContent>(config, options);\n}\n\n/**\n * Validates and narrows an unknown value to an Angular `WorkflowConfig`.\n * @param config The parsed JSON (or equivalent plain object) to validate.\n * @param options Validation options; see `ValidateWorkflowConfigOptions`.\n * @throws {ConfigValidationError} When one or more issues are found.\n * @returns The same value, narrowed to `WorkflowConfig`.\n */\nexport function validateWorkflowConfig(\n config: unknown,\n options: ValidateWorkflowConfigOptions = {},\n): WorkflowConfig {\n return validateCoreWorkflowConfig<AngularTourContent>(config, options);\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":["createCoreWorkflowFromConfig","validateCoreWorkflowConfig"],"mappings":";;;AA2CA;;;;;;;;AAQG;SACa,wBAAwB,CACtC,MAAe,EACf,UAA2C,EAAE,EAAA;AAE7C,IAAA,OAAOA,0BAA4B,CAAqB,MAAM,EAAE,OAAO,CAAC;AAC1E;AAEA;;;;;;AAMG;SACa,sBAAsB,CACpC,MAAe,EACf,UAAyC,EAAE,EAAA;AAE3C,IAAA,OAAOC,wBAA0B,CAAqB,MAAM,EAAE,OAAO,CAAC;AACxE;;ACvEA;;AAEG;;;;"}
|