@robertlinde/react-tour-kit 0.0.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.
Files changed (111) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +838 -0
  3. package/dist/react-native-platform/components/index.d.ts +2 -0
  4. package/dist/react-native-platform/components/index.js +8 -0
  5. package/dist/react-native-platform/components/index.js.map +1 -0
  6. package/dist/react-native-platform/components/tour-overlay.d.ts +3 -0
  7. package/dist/react-native-platform/components/tour-overlay.js +83 -0
  8. package/dist/react-native-platform/components/tour-overlay.js.map +1 -0
  9. package/dist/react-native-platform/components/tour-tooltip.d.ts +3 -0
  10. package/dist/react-native-platform/components/tour-tooltip.js +138 -0
  11. package/dist/react-native-platform/components/tour-tooltip.js.map +1 -0
  12. package/dist/react-native-platform/hooks/index.d.ts +1 -0
  13. package/dist/react-native-platform/hooks/index.js +6 -0
  14. package/dist/react-native-platform/hooks/index.js.map +1 -0
  15. package/dist/react-native-platform/hooks/use-tour-target.d.ts +2 -0
  16. package/dist/react-native-platform/hooks/use-tour-target.js +16 -0
  17. package/dist/react-native-platform/hooks/use-tour-target.js.map +1 -0
  18. package/dist/react-native-platform/index.d.ts +7 -0
  19. package/dist/react-native-platform/index.js +16 -0
  20. package/dist/react-native-platform/index.js.map +1 -0
  21. package/dist/react-native-platform/platform-adapter.d.ts +2 -0
  22. package/dist/react-native-platform/platform-adapter.js +87 -0
  23. package/dist/react-native-platform/platform-adapter.js.map +1 -0
  24. package/dist/react-native-platform/target-registry.d.ts +10 -0
  25. package/dist/react-native-platform/target-registry.js +20 -0
  26. package/dist/react-native-platform/target-registry.js.map +1 -0
  27. package/dist/react-native-platform/tour-provider.d.ts +3 -0
  28. package/dist/react-native-platform/tour-provider.js +200 -0
  29. package/dist/react-native-platform/tour-provider.js.map +1 -0
  30. package/dist/react-native-platform/types/tour-provider.props.type.d.ts +10 -0
  31. package/dist/react-native-platform/types/tour-provider.props.type.js +3 -0
  32. package/dist/react-native-platform/types/tour-provider.props.type.js.map +1 -0
  33. package/dist/react-native.d.ts +8 -0
  34. package/dist/react-native.js +19 -0
  35. package/dist/react-native.js.map +1 -0
  36. package/dist/react-platform/components/index.d.ts +2 -0
  37. package/dist/react-platform/components/index.js +8 -0
  38. package/dist/react-platform/components/index.js.map +1 -0
  39. package/dist/react-platform/components/tour-overlay.d.ts +3 -0
  40. package/dist/react-platform/components/tour-overlay.js +31 -0
  41. package/dist/react-platform/components/tour-overlay.js.map +1 -0
  42. package/dist/react-platform/components/tour-tooltip.d.ts +2 -0
  43. package/dist/react-platform/components/tour-tooltip.js +126 -0
  44. package/dist/react-platform/components/tour-tooltip.js.map +1 -0
  45. package/dist/react-platform/index.d.ts +6 -0
  46. package/dist/react-platform/index.js +14 -0
  47. package/dist/react-platform/index.js.map +1 -0
  48. package/dist/react-platform/platform-adapter.d.ts +2 -0
  49. package/dist/react-platform/platform-adapter.js +95 -0
  50. package/dist/react-platform/platform-adapter.js.map +1 -0
  51. package/dist/react-platform/tour-provider.d.ts +3 -0
  52. package/dist/react-platform/tour-provider.js +207 -0
  53. package/dist/react-platform/tour-provider.js.map +1 -0
  54. package/dist/react-platform/types/tour-provider.props.type.d.ts +10 -0
  55. package/dist/react-platform/types/tour-provider.props.type.js +3 -0
  56. package/dist/react-platform/types/tour-provider.props.type.js.map +1 -0
  57. package/dist/react-platform/utils/find-visible-element.util.d.ts +1 -0
  58. package/dist/react-platform/utils/find-visible-element.util.js +14 -0
  59. package/dist/react-platform/utils/find-visible-element.util.js.map +1 -0
  60. package/dist/react-platform/utils/index.d.ts +1 -0
  61. package/dist/react-platform/utils/index.js +6 -0
  62. package/dist/react-platform/utils/index.js.map +1 -0
  63. package/dist/react.d.ts +8 -0
  64. package/dist/react.js +18 -0
  65. package/dist/react.js.map +1 -0
  66. package/dist/shared/context/index.d.ts +1 -0
  67. package/dist/shared/context/index.js +7 -0
  68. package/dist/shared/context/index.js.map +1 -0
  69. package/dist/shared/context/tour-context.d.ts +3 -0
  70. package/dist/shared/context/tour-context.js +17 -0
  71. package/dist/shared/context/tour-context.js.map +1 -0
  72. package/dist/shared/hooks/index.d.ts +1 -0
  73. package/dist/shared/hooks/index.js +6 -0
  74. package/dist/shared/hooks/index.js.map +1 -0
  75. package/dist/shared/hooks/use-tour.hook.d.ts +2 -0
  76. package/dist/shared/hooks/use-tour.hook.js +10 -0
  77. package/dist/shared/hooks/use-tour.hook.js.map +1 -0
  78. package/dist/shared/index.d.ts +5 -0
  79. package/dist/shared/index.js +14 -0
  80. package/dist/shared/index.js.map +1 -0
  81. package/dist/shared/types/index.d.ts +8 -0
  82. package/dist/shared/types/index.js +7 -0
  83. package/dist/shared/types/index.js.map +1 -0
  84. package/dist/shared/types/platform-adapter.type.d.ts +24 -0
  85. package/dist/shared/types/platform-adapter.type.js +3 -0
  86. package/dist/shared/types/platform-adapter.type.js.map +1 -0
  87. package/dist/shared/types/rect.type.d.ts +10 -0
  88. package/dist/shared/types/rect.type.js +3 -0
  89. package/dist/shared/types/rect.type.js.map +1 -0
  90. package/dist/shared/types/tour-context.type.d.ts +12 -0
  91. package/dist/shared/types/tour-context.type.js +3 -0
  92. package/dist/shared/types/tour-context.type.js.map +1 -0
  93. package/dist/shared/types/tour-overlay-props.type.d.ts +7 -0
  94. package/dist/shared/types/tour-overlay-props.type.js +3 -0
  95. package/dist/shared/types/tour-overlay-props.type.js.map +1 -0
  96. package/dist/shared/types/tour-step.type.d.ts +8 -0
  97. package/dist/shared/types/tour-step.type.js +3 -0
  98. package/dist/shared/types/tour-step.type.js.map +1 -0
  99. package/dist/shared/types/tour-theme.type.d.ts +9 -0
  100. package/dist/shared/types/tour-theme.type.js +21 -0
  101. package/dist/shared/types/tour-theme.type.js.map +1 -0
  102. package/dist/shared/types/tour-tooltip-props.type.d.ts +17 -0
  103. package/dist/shared/types/tour-tooltip-props.type.js +3 -0
  104. package/dist/shared/types/tour-tooltip-props.type.js.map +1 -0
  105. package/dist/shared/utils/calculate-tooltip-position.util.d.ts +14 -0
  106. package/dist/shared/utils/calculate-tooltip-position.util.js +56 -0
  107. package/dist/shared/utils/calculate-tooltip-position.util.js.map +1 -0
  108. package/dist/shared/utils/index.d.ts +1 -0
  109. package/dist/shared/utils/index.js +6 -0
  110. package/dist/shared/utils/index.js.map +1 -0
  111. package/package.json +88 -0
@@ -0,0 +1,14 @@
1
+ import { type Rect } from '../types';
2
+ type TooltipDimensions = {
3
+ readonly width: number;
4
+ readonly height: number;
5
+ };
6
+ type ViewportDimensions = {
7
+ readonly width: number;
8
+ readonly height: number;
9
+ };
10
+ export declare function calculateTooltipPosition(targetRect: Rect, placement: 'top' | 'bottom' | 'left' | 'right', tooltipDimensions: TooltipDimensions, viewportDimensions: ViewportDimensions): {
11
+ top: number;
12
+ left: number;
13
+ };
14
+ export {};
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.calculateTooltipPosition = calculateTooltipPosition;
4
+ const tooltipWidthDesktop = 400;
5
+ const tooltipWidthMobile = 320;
6
+ const mobileBreakpoint = 640;
7
+ const defaultTooltipHeight = 200;
8
+ const tooltipPadding = 16;
9
+ function calculateTooltipPosition(targetRect, placement, tooltipDimensions, viewportDimensions) {
10
+ const viewportWidth = viewportDimensions.width;
11
+ const viewportHeight = viewportDimensions.height;
12
+ const isMobile = viewportWidth < mobileBreakpoint;
13
+ const defaultWidth = isMobile
14
+ ? Math.min(tooltipWidthMobile, viewportWidth - tooltipPadding * 2)
15
+ : tooltipWidthDesktop;
16
+ const tooltipWidth = tooltipDimensions.width > 0 ? tooltipDimensions.width : defaultWidth;
17
+ const tooltipHeight = tooltipDimensions.height > 0 ? tooltipDimensions.height : defaultTooltipHeight;
18
+ let top = 0;
19
+ let left = 0;
20
+ switch (placement) {
21
+ case 'top': {
22
+ top = targetRect.top - tooltipHeight - tooltipPadding;
23
+ left = targetRect.left + targetRect.width / 2 - tooltipWidth / 2;
24
+ break;
25
+ }
26
+ case 'bottom': {
27
+ top = targetRect.bottom + tooltipPadding;
28
+ left = targetRect.left + targetRect.width / 2 - tooltipWidth / 2;
29
+ break;
30
+ }
31
+ case 'left': {
32
+ top = targetRect.top + targetRect.height / 2 - tooltipHeight / 2;
33
+ left = targetRect.left - tooltipWidth - tooltipPadding;
34
+ break;
35
+ }
36
+ case 'right': {
37
+ top = targetRect.top + targetRect.height / 2 - tooltipHeight / 2;
38
+ left = targetRect.right + tooltipPadding;
39
+ break;
40
+ }
41
+ }
42
+ if (left < tooltipPadding) {
43
+ left = tooltipPadding;
44
+ }
45
+ if (left + tooltipWidth > viewportWidth - tooltipPadding) {
46
+ left = viewportWidth - tooltipWidth - tooltipPadding;
47
+ }
48
+ if (top < tooltipPadding) {
49
+ top = targetRect.bottom + tooltipPadding;
50
+ }
51
+ if (top + tooltipHeight > viewportHeight - tooltipPadding) {
52
+ top = targetRect.top - tooltipHeight - tooltipPadding;
53
+ }
54
+ return { top, left };
55
+ }
56
+ //# sourceMappingURL=calculate-tooltip-position.util.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"calculate-tooltip-position.util.js","sourceRoot":"","sources":["../../../src/shared/utils/calculate-tooltip-position.util.ts"],"names":[],"mappings":";;AAuBA,4DA8DC;AAnFD,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAC/B,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,cAAc,GAAG,EAAE,CAAC;AAiB1B,SAAgB,wBAAwB,CACtC,UAAgB,EAChB,SAA8C,EAC9C,iBAAoC,EACpC,kBAAsC;IAEtC,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC;IAC/C,MAAM,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC;IACjD,MAAM,QAAQ,GAAG,aAAa,GAAG,gBAAgB,CAAC;IAClD,MAAM,YAAY,GAAG,QAAQ;QAC3B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,aAAa,GAAG,cAAc,GAAG,CAAC,CAAC;QAClE,CAAC,CAAC,mBAAmB,CAAC;IACxB,MAAM,YAAY,GAAG,iBAAiB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC;IAC1F,MAAM,aAAa,GAAG,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC;IAErG,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,aAAa,GAAG,cAAc,CAAC;YACtD,IAAI,GAAG,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,GAAG,CAAC,CAAC;YACjE,MAAM;QACR,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,GAAG,GAAG,UAAU,CAAC,MAAM,GAAG,cAAc,CAAC;YACzC,IAAI,GAAG,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,KAAK,GAAG,CAAC,GAAG,YAAY,GAAG,CAAC,CAAC;YACjE,MAAM;QACR,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC;YACjE,IAAI,GAAG,UAAU,CAAC,IAAI,GAAG,YAAY,GAAG,cAAc,CAAC;YACvD,MAAM;QACR,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC;YACjE,IAAI,GAAG,UAAU,CAAC,KAAK,GAAG,cAAc,CAAC;YACzC,MAAM;QACR,CAAC;IACH,CAAC;IAGD,IAAI,IAAI,GAAG,cAAc,EAAE,CAAC;QAC1B,IAAI,GAAG,cAAc,CAAC;IACxB,CAAC;IAED,IAAI,IAAI,GAAG,YAAY,GAAG,aAAa,GAAG,cAAc,EAAE,CAAC;QACzD,IAAI,GAAG,aAAa,GAAG,YAAY,GAAG,cAAc,CAAC;IACvD,CAAC;IAED,IAAI,GAAG,GAAG,cAAc,EAAE,CAAC;QACzB,GAAG,GAAG,UAAU,CAAC,MAAM,GAAG,cAAc,CAAC;IAC3C,CAAC;IAED,IAAI,GAAG,GAAG,aAAa,GAAG,cAAc,GAAG,cAAc,EAAE,CAAC;QAC1D,GAAG,GAAG,UAAU,CAAC,GAAG,GAAG,aAAa,GAAG,cAAc,CAAC;IACxD,CAAC;IAED,OAAO,EAAC,GAAG,EAAE,IAAI,EAAC,CAAC;AACrB,CAAC"}
@@ -0,0 +1 @@
1
+ export { calculateTooltipPosition } from './calculate-tooltip-position.util';
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.calculateTooltipPosition = void 0;
4
+ var calculate_tooltip_position_util_1 = require("./calculate-tooltip-position.util");
5
+ Object.defineProperty(exports, "calculateTooltipPosition", { enumerable: true, get: function () { return calculate_tooltip_position_util_1.calculateTooltipPosition; } });
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/shared/utils/index.ts"],"names":[],"mappings":";;;AAAA,qFAA2E;AAAnE,2IAAA,wBAAwB,OAAA"}
package/package.json ADDED
@@ -0,0 +1,88 @@
1
+ {
2
+ "name": "@robertlinde/react-tour-kit",
3
+ "version": "0.0.1",
4
+ "description": "Cross-platform guided tour library for React and React Native. Build interactive onboarding experiences with customizable tooltips, smart positioning, cross-page navigation, and async step actions. Fully themeable with TypeScript support.",
5
+ "author": "Robert Linde",
6
+ "license": "MIT",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "https://github.com/robertlinde/react-tour-kit.git"
10
+ },
11
+ "homepage": "https://github.com/robertlinde/react-tour-kit#readme",
12
+ "bugs": {
13
+ "url": "https://github.com/robertlinde/react-tour-kit/issues"
14
+ },
15
+ "scripts": {
16
+ "start:dev": "tsc --watch",
17
+ "build": "tsc",
18
+ "lint": "xo",
19
+ "lint:fix": "xo --fix",
20
+ "format": "prettier --write .",
21
+ "format:check": "prettier --check .",
22
+ "prepublishOnly": "npm run build",
23
+ "prepare": "husky || true"
24
+ },
25
+ "main": "./dist/react.js",
26
+ "module": "./dist/react.js",
27
+ "types": "./dist/react.d.ts",
28
+ "exports": {
29
+ "./react": {
30
+ "types": "./dist/react.d.ts",
31
+ "require": "./dist/react.js",
32
+ "import": "./dist/react.js"
33
+ },
34
+ "./react-native": {
35
+ "types": "./dist/react-native.d.ts",
36
+ "require": "./dist/react-native.js",
37
+ "import": "./dist/react-native.js"
38
+ }
39
+ },
40
+ "files": [
41
+ "dist",
42
+ "README.md",
43
+ "LICENSE"
44
+ ],
45
+ "sideEffects": false,
46
+ "peerDependencies": {
47
+ "react": ">=18.0.0",
48
+ "react-dom": ">=18.0.0",
49
+ "react-native": ">=0.70.0"
50
+ },
51
+ "peerDependenciesMeta": {
52
+ "react-dom": {
53
+ "optional": true
54
+ },
55
+ "react-native": {
56
+ "optional": true
57
+ }
58
+ },
59
+ "devDependencies": {
60
+ "@commitlint/cli": "^19.0.0",
61
+ "@commitlint/config-conventional": "^19.0.0",
62
+ "@types/react": "^19.0.0",
63
+ "@types/react-dom": "^19.0.0",
64
+ "@types/react-native": "^0.72.0",
65
+ "husky": "^9.1.7",
66
+ "lint-staged": "^16.0.0",
67
+ "prettier": "^3.7.0",
68
+ "react": "^19.0.0",
69
+ "react-dom": "^19.0.0",
70
+ "typescript": "^5.7.0",
71
+ "xo": "^1.2.3"
72
+ },
73
+ "keywords": [
74
+ "react",
75
+ "react-native",
76
+ "tour",
77
+ "guided-tour",
78
+ "walkthrough",
79
+ "onboarding",
80
+ "tooltip",
81
+ "tutorial",
82
+ "intro",
83
+ "product-tour"
84
+ ],
85
+ "engines": {
86
+ "node": ">=18.0.0"
87
+ }
88
+ }