@cloud-ru/uikit-product-welcome-tour 0.10.62 → 0.10.64
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/CHANGELOG.md +20 -0
- package/dist/cjs/components/Hint/Hint.d.ts +19 -0
- package/dist/cjs/components/Hint/Hint.js +15 -0
- package/dist/cjs/components/Hint/index.d.ts +1 -0
- package/dist/cjs/components/Hint/index.js +17 -0
- package/dist/cjs/components/Hint/styles.module.css +41 -0
- package/dist/cjs/components/Steps/Steps.d.ts +6 -0
- package/dist/cjs/components/Steps/Steps.js +13 -0
- package/dist/cjs/components/Steps/index.d.ts +1 -0
- package/dist/cjs/components/Steps/index.js +17 -0
- package/dist/cjs/components/Steps/styles.module.css +3 -0
- package/dist/cjs/components/WelcomeTour/WelcomeTour.d.ts +25 -0
- package/dist/cjs/components/WelcomeTour/WelcomeTour.js +70 -0
- package/dist/cjs/components/WelcomeTour/index.d.ts +1 -0
- package/dist/cjs/components/WelcomeTour/index.js +17 -0
- package/dist/cjs/components/index.d.ts +1 -0
- package/dist/cjs/components/index.js +17 -0
- package/dist/cjs/components/types.d.ts +9 -0
- package/dist/cjs/components/types.js +2 -0
- package/dist/cjs/index.d.ts +1 -0
- package/dist/cjs/index.js +17 -0
- package/dist/esm/components/Hint/Hint.d.ts +19 -0
- package/dist/esm/components/Hint/Hint.js +9 -0
- package/dist/esm/components/Hint/index.d.ts +1 -0
- package/dist/esm/components/Hint/index.js +1 -0
- package/dist/esm/components/Hint/styles.module.css +41 -0
- package/dist/esm/components/Steps/Steps.d.ts +6 -0
- package/dist/esm/components/Steps/Steps.js +7 -0
- package/dist/esm/components/Steps/index.d.ts +1 -0
- package/dist/esm/components/Steps/index.js +1 -0
- package/dist/esm/components/Steps/styles.module.css +3 -0
- package/dist/esm/components/WelcomeTour/WelcomeTour.d.ts +25 -0
- package/dist/esm/components/WelcomeTour/WelcomeTour.js +44 -0
- package/dist/esm/components/WelcomeTour/index.d.ts +1 -0
- package/dist/esm/components/WelcomeTour/index.js +1 -0
- package/dist/esm/components/index.d.ts +1 -0
- package/dist/esm/components/index.js +1 -0
- package/dist/esm/components/types.d.ts +9 -0
- package/dist/esm/components/types.js +1 -0
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/package.json +4 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,26 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## 0.10.64 (2025-11-13)
|
|
7
|
+
|
|
8
|
+
### Only dependencies have been changed
|
|
9
|
+
* [@cloud-ru/uikit-product-icons@15.1.3](https://gitverse.ru/cloud-ru-tech/uikit-product/-/blob/master/packages/icons/CHANGELOG.md)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## 0.10.63 (2025-11-12)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Bug Fixes
|
|
19
|
+
|
|
20
|
+
* **PD-3377:** contributors update to publish all packages ([719fd3e](https://gitverse.ru/cloud-ru-tech/uikit-product/commits/719fd3e1249e247443b125c47ea408d92c8395c3))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
6
26
|
## 0.10.62 (2025-11-12)
|
|
7
27
|
|
|
8
28
|
### Only dependencies have been changed
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { MouseEvent } from 'react';
|
|
2
|
+
import { TooltipRenderProps } from 'react-joyride';
|
|
3
|
+
import { TourStepExtended } from '../types';
|
|
4
|
+
type TooltipButtonProps = {
|
|
5
|
+
'aria-label': string;
|
|
6
|
+
'data-action': string;
|
|
7
|
+
onClick: (e: MouseEvent<HTMLElement>) => void;
|
|
8
|
+
role: string;
|
|
9
|
+
title: string;
|
|
10
|
+
label: string;
|
|
11
|
+
};
|
|
12
|
+
type HintProps = {
|
|
13
|
+
backButton?: TooltipButtonProps;
|
|
14
|
+
closeButton: TooltipButtonProps;
|
|
15
|
+
primaryButton: TooltipButtonProps;
|
|
16
|
+
step: TourStepExtended;
|
|
17
|
+
} & Omit<TooltipRenderProps, 'backProps' | 'closeProps' | 'primaryProps'>;
|
|
18
|
+
export declare function Hint({ backButton, closeButton, skipProps, primaryButton, index, size, isLastStep, step, tooltipProps, }: HintProps): import("react/jsx-runtime").JSX.Element;
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Hint = Hint;
|
|
7
|
+
const jsx_runtime_1 = require("react/jsx-runtime");
|
|
8
|
+
const uikit_product_icons_1 = require("@sbercloud/uikit-product-icons");
|
|
9
|
+
const button_1 = require("@snack-uikit/button");
|
|
10
|
+
const typography_1 = require("@snack-uikit/typography");
|
|
11
|
+
const Steps_1 = require("../Steps");
|
|
12
|
+
const styles_module_scss_1 = __importDefault(require('./styles.module.css'));
|
|
13
|
+
function Hint({ backButton, closeButton, skipProps, primaryButton, index, size, isLastStep, step, tooltipProps, }) {
|
|
14
|
+
return ((0, jsx_runtime_1.jsxs)("div", Object.assign({ className: styles_module_scss_1.default.hintWrapper }, tooltipProps, { "data-test-id": 'welcome-tour-hint', children: [(0, jsx_runtime_1.jsxs)("div", { className: styles_module_scss_1.default.headingContainer, children: [(0, jsx_runtime_1.jsx)(typography_1.Typography, { tag: 'h4', family: 'sans', purpose: 'title', size: 'm', "data-test-id": 'welcome-tour-hint__title', children: step.title }), (0, jsx_runtime_1.jsx)(button_1.ButtonSimple, Object.assign({ "data-test-id": 'welcome-tour-hint__icon-close' }, skipProps, { icon: (0, jsx_runtime_1.jsx)(uikit_product_icons_1.CloseInterfaceSVG, {}) }))] }), step.subtitle && ((0, jsx_runtime_1.jsx)(typography_1.Typography, { tag: 'h4', family: 'light', purpose: 'title', size: 's', className: styles_module_scss_1.default.subHeading, "data-test-id": 'welcome-tour-hint__subtitle', children: step.subtitle })), step.content && ((0, jsx_runtime_1.jsx)(typography_1.Typography, { tag: 'h4', family: 'sans', purpose: 'body', size: 's', className: styles_module_scss_1.default.content, "data-test-id": 'welcome-tour-hint__content', children: step.content })), (0, jsx_runtime_1.jsxs)("div", { className: styles_module_scss_1.default.footer, children: [step.content && (0, jsx_runtime_1.jsx)(Steps_1.Steps, { stepsCount: size, currentStep: index }), (0, jsx_runtime_1.jsxs)("div", { className: styles_module_scss_1.default.stepButtons, children: [backButton && index !== 0 && (0, jsx_runtime_1.jsx)(button_1.ButtonSimple, Object.assign({ "data-test-id": 'welcome-tour-hint__button-back' }, backButton)), isLastStep ? ((0, jsx_runtime_1.jsx)(button_1.ButtonFilled, Object.assign({ "data-test-id": 'welcome-tour-hint__button-close' }, closeButton))) : ((0, jsx_runtime_1.jsx)(button_1.ButtonFilled, Object.assign({ "data-test-id": 'welcome-tour-hint__button-next' }, primaryButton)))] })] })] })));
|
|
15
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './Hint';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./Hint"), exports);
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
.hintWrapper{
|
|
2
|
+
display:flex;
|
|
3
|
+
flex-direction:column;
|
|
4
|
+
padding:20px;
|
|
5
|
+
min-width:250px;
|
|
6
|
+
max-width:480px;
|
|
7
|
+
background:var(--sys-neutral-background2-level, #ffffff);
|
|
8
|
+
border-radius:8px;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
.headingContainer{
|
|
12
|
+
color:var(--sys-neutral-text-main, #41424e);
|
|
13
|
+
display:flex;
|
|
14
|
+
align-items:center;
|
|
15
|
+
justify-content:space-between;
|
|
16
|
+
margin-bottom:8px;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
.subHeading{
|
|
20
|
+
color:var(--sys-neutral-text-main, #41424e);
|
|
21
|
+
margin-bottom:16px;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
.content{
|
|
25
|
+
margin-bottom:20px;
|
|
26
|
+
overflow:hidden;
|
|
27
|
+
border-radius:8px;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
.footer{
|
|
31
|
+
display:flex;
|
|
32
|
+
justify-content:space-between;
|
|
33
|
+
align-items:center;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
.stepButtons{
|
|
37
|
+
display:flex;
|
|
38
|
+
align-items:center;
|
|
39
|
+
gap:16px;
|
|
40
|
+
margin-left:auto;
|
|
41
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Steps = Steps;
|
|
7
|
+
const jsx_runtime_1 = require("react/jsx-runtime");
|
|
8
|
+
const pagination_1 = require("@snack-uikit/pagination");
|
|
9
|
+
const styles_module_scss_1 = __importDefault(require('./styles.module.css'));
|
|
10
|
+
function noop() { }
|
|
11
|
+
function Steps({ currentStep, stepsCount }) {
|
|
12
|
+
return ((0, jsx_runtime_1.jsx)(pagination_1.PaginationSlider, { page: currentStep + 1, "data-test-id": 'tour-pagination', onChange: noop, total: stepsCount, className: styles_module_scss_1.default.noPointerEvents }));
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './Steps';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./Steps"), exports);
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import JoyRide, { CallBackProps, STATUS } from 'react-joyride';
|
|
2
|
+
import { TourStepExtended } from '../types';
|
|
3
|
+
export type WelcomeTourProps = {
|
|
4
|
+
tourSteps: TourStepExtended[];
|
|
5
|
+
tourStarted: boolean;
|
|
6
|
+
setTourStarted(value: boolean, status: CallBackProps['status']): void;
|
|
7
|
+
closeButtonProps: {
|
|
8
|
+
label: string;
|
|
9
|
+
onClick?(): void;
|
|
10
|
+
};
|
|
11
|
+
primaryButtonProps: {
|
|
12
|
+
label: string;
|
|
13
|
+
onClick?(): void;
|
|
14
|
+
};
|
|
15
|
+
backButtonProps?: {
|
|
16
|
+
label: string;
|
|
17
|
+
onClick?(): void;
|
|
18
|
+
};
|
|
19
|
+
customScrollOffset?: number;
|
|
20
|
+
};
|
|
21
|
+
declare const WelcomeTourWithRef: import("react").ForwardRefExoticComponent<WelcomeTourProps & import("react").RefAttributes<JoyRide>>;
|
|
22
|
+
export declare const WelcomeTour: typeof WelcomeTourWithRef & {
|
|
23
|
+
statuses: typeof STATUS;
|
|
24
|
+
};
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.WelcomeTour = void 0;
|
|
27
|
+
const jsx_runtime_1 = require("react/jsx-runtime");
|
|
28
|
+
const react_1 = require("react");
|
|
29
|
+
const react_joyride_1 = __importStar(require("react-joyride"));
|
|
30
|
+
const figma_tokens_cloud_platform_1 = require("@sbercloud/figma-tokens-cloud-platform");
|
|
31
|
+
const Hint_1 = require("../Hint");
|
|
32
|
+
const customColors = {
|
|
33
|
+
options: {
|
|
34
|
+
arrowColor: figma_tokens_cloud_platform_1.themeVars.sys.neutral.background2Level,
|
|
35
|
+
overlayColor: figma_tokens_cloud_platform_1.themeVars.sys.blackout,
|
|
36
|
+
},
|
|
37
|
+
};
|
|
38
|
+
const customArrowSize = {
|
|
39
|
+
styles: {
|
|
40
|
+
arrow: {
|
|
41
|
+
length: 8,
|
|
42
|
+
spread: 16,
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
};
|
|
46
|
+
const WelcomeTourWithRef = (0, react_1.forwardRef)(({ tourSteps, tourStarted, setTourStarted, closeButtonProps, primaryButtonProps, backButtonProps, customScrollOffset, }, ref) => {
|
|
47
|
+
const stepsWithoutBeacon = tourSteps.map(step => (Object.assign(Object.assign({}, step), { disableBeacon: true })));
|
|
48
|
+
const checkTourFinish = ({ status }) => {
|
|
49
|
+
if (status === react_joyride_1.STATUS.FINISHED || status === react_joyride_1.STATUS.SKIPPED) {
|
|
50
|
+
setTourStarted(false, status);
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
const renderTooltipComponent = (props) => ((0, jsx_runtime_1.jsx)(Hint_1.Hint, Object.assign({ backButton: backButtonProps
|
|
54
|
+
? Object.assign(Object.assign({}, props.backProps), { label: backButtonProps.label, onClick: e => {
|
|
55
|
+
var _a;
|
|
56
|
+
(_a = backButtonProps.onClick) === null || _a === void 0 ? void 0 : _a.call(backButtonProps);
|
|
57
|
+
props.backProps.onClick(e);
|
|
58
|
+
} }) : undefined, closeButton: Object.assign(Object.assign({}, props.closeProps), { label: closeButtonProps.label, onClick: e => {
|
|
59
|
+
var _a;
|
|
60
|
+
(_a = closeButtonProps.onClick) === null || _a === void 0 ? void 0 : _a.call(closeButtonProps);
|
|
61
|
+
props.closeProps.onClick(e);
|
|
62
|
+
} }), primaryButton: Object.assign(Object.assign({}, props.primaryProps), { label: primaryButtonProps.label, onClick: e => {
|
|
63
|
+
var _a;
|
|
64
|
+
(_a = primaryButtonProps.onClick) === null || _a === void 0 ? void 0 : _a.call(primaryButtonProps);
|
|
65
|
+
props.primaryProps.onClick(e);
|
|
66
|
+
} }) }, props)));
|
|
67
|
+
return ((0, jsx_runtime_1.jsx)(react_joyride_1.default, { tooltipComponent: renderTooltipComponent, steps: stepsWithoutBeacon, continuous: true, styles: customColors, run: tourStarted, callback: checkTourFinish, floaterProps: customArrowSize, disableOverlayClose: true, scrollOffset: customScrollOffset, disableScrollParentFix: true, ref: ref }));
|
|
68
|
+
});
|
|
69
|
+
exports.WelcomeTour = WelcomeTourWithRef;
|
|
70
|
+
exports.WelcomeTour.statuses = react_joyride_1.STATUS;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './WelcomeTour';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./WelcomeTour"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './WelcomeTour';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./WelcomeTour"), exports);
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { ReactNode } from 'react';
|
|
2
|
+
import { Step } from 'react-joyride';
|
|
3
|
+
export type TourStepExtended = {
|
|
4
|
+
subtitle?: ReactNode;
|
|
5
|
+
primaryButtonText?: string;
|
|
6
|
+
backButtonText?: string;
|
|
7
|
+
closeButtonText?: string;
|
|
8
|
+
onFinish?(): void | boolean;
|
|
9
|
+
} & Omit<Step, 'disableBeacon'>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './components/WelcomeTour';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./components/WelcomeTour"), exports);
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { MouseEvent } from 'react';
|
|
2
|
+
import { TooltipRenderProps } from 'react-joyride';
|
|
3
|
+
import { TourStepExtended } from '../types';
|
|
4
|
+
type TooltipButtonProps = {
|
|
5
|
+
'aria-label': string;
|
|
6
|
+
'data-action': string;
|
|
7
|
+
onClick: (e: MouseEvent<HTMLElement>) => void;
|
|
8
|
+
role: string;
|
|
9
|
+
title: string;
|
|
10
|
+
label: string;
|
|
11
|
+
};
|
|
12
|
+
type HintProps = {
|
|
13
|
+
backButton?: TooltipButtonProps;
|
|
14
|
+
closeButton: TooltipButtonProps;
|
|
15
|
+
primaryButton: TooltipButtonProps;
|
|
16
|
+
step: TourStepExtended;
|
|
17
|
+
} & Omit<TooltipRenderProps, 'backProps' | 'closeProps' | 'primaryProps'>;
|
|
18
|
+
export declare function Hint({ backButton, closeButton, skipProps, primaryButton, index, size, isLastStep, step, tooltipProps, }: HintProps): import("react/jsx-runtime").JSX.Element;
|
|
19
|
+
export {};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
|
+
import { CloseInterfaceSVG } from '@sbercloud/uikit-product-icons';
|
|
3
|
+
import { ButtonFilled, ButtonSimple } from '@snack-uikit/button';
|
|
4
|
+
import { Typography } from '@snack-uikit/typography';
|
|
5
|
+
import { Steps } from '../Steps';
|
|
6
|
+
import styles from './styles.module.css';
|
|
7
|
+
export function Hint({ backButton, closeButton, skipProps, primaryButton, index, size, isLastStep, step, tooltipProps, }) {
|
|
8
|
+
return (_jsxs("div", Object.assign({ className: styles.hintWrapper }, tooltipProps, { "data-test-id": 'welcome-tour-hint', children: [_jsxs("div", { className: styles.headingContainer, children: [_jsx(Typography, { tag: 'h4', family: 'sans', purpose: 'title', size: 'm', "data-test-id": 'welcome-tour-hint__title', children: step.title }), _jsx(ButtonSimple, Object.assign({ "data-test-id": 'welcome-tour-hint__icon-close' }, skipProps, { icon: _jsx(CloseInterfaceSVG, {}) }))] }), step.subtitle && (_jsx(Typography, { tag: 'h4', family: 'light', purpose: 'title', size: 's', className: styles.subHeading, "data-test-id": 'welcome-tour-hint__subtitle', children: step.subtitle })), step.content && (_jsx(Typography, { tag: 'h4', family: 'sans', purpose: 'body', size: 's', className: styles.content, "data-test-id": 'welcome-tour-hint__content', children: step.content })), _jsxs("div", { className: styles.footer, children: [step.content && _jsx(Steps, { stepsCount: size, currentStep: index }), _jsxs("div", { className: styles.stepButtons, children: [backButton && index !== 0 && _jsx(ButtonSimple, Object.assign({ "data-test-id": 'welcome-tour-hint__button-back' }, backButton)), isLastStep ? (_jsx(ButtonFilled, Object.assign({ "data-test-id": 'welcome-tour-hint__button-close' }, closeButton))) : (_jsx(ButtonFilled, Object.assign({ "data-test-id": 'welcome-tour-hint__button-next' }, primaryButton)))] })] })] })));
|
|
9
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './Hint';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './Hint';
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
.hintWrapper{
|
|
2
|
+
display:flex;
|
|
3
|
+
flex-direction:column;
|
|
4
|
+
padding:20px;
|
|
5
|
+
min-width:250px;
|
|
6
|
+
max-width:480px;
|
|
7
|
+
background:var(--sys-neutral-background2-level, #ffffff);
|
|
8
|
+
border-radius:8px;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
.headingContainer{
|
|
12
|
+
color:var(--sys-neutral-text-main, #41424e);
|
|
13
|
+
display:flex;
|
|
14
|
+
align-items:center;
|
|
15
|
+
justify-content:space-between;
|
|
16
|
+
margin-bottom:8px;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
.subHeading{
|
|
20
|
+
color:var(--sys-neutral-text-main, #41424e);
|
|
21
|
+
margin-bottom:16px;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
.content{
|
|
25
|
+
margin-bottom:20px;
|
|
26
|
+
overflow:hidden;
|
|
27
|
+
border-radius:8px;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
.footer{
|
|
31
|
+
display:flex;
|
|
32
|
+
justify-content:space-between;
|
|
33
|
+
align-items:center;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
.stepButtons{
|
|
37
|
+
display:flex;
|
|
38
|
+
align-items:center;
|
|
39
|
+
gap:16px;
|
|
40
|
+
margin-left:auto;
|
|
41
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { PaginationSlider } from '@snack-uikit/pagination';
|
|
3
|
+
import styles from './styles.module.css';
|
|
4
|
+
function noop() { }
|
|
5
|
+
export function Steps({ currentStep, stepsCount }) {
|
|
6
|
+
return (_jsx(PaginationSlider, { page: currentStep + 1, "data-test-id": 'tour-pagination', onChange: noop, total: stepsCount, className: styles.noPointerEvents }));
|
|
7
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './Steps';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './Steps';
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import JoyRide, { CallBackProps, STATUS } from 'react-joyride';
|
|
2
|
+
import { TourStepExtended } from '../types';
|
|
3
|
+
export type WelcomeTourProps = {
|
|
4
|
+
tourSteps: TourStepExtended[];
|
|
5
|
+
tourStarted: boolean;
|
|
6
|
+
setTourStarted(value: boolean, status: CallBackProps['status']): void;
|
|
7
|
+
closeButtonProps: {
|
|
8
|
+
label: string;
|
|
9
|
+
onClick?(): void;
|
|
10
|
+
};
|
|
11
|
+
primaryButtonProps: {
|
|
12
|
+
label: string;
|
|
13
|
+
onClick?(): void;
|
|
14
|
+
};
|
|
15
|
+
backButtonProps?: {
|
|
16
|
+
label: string;
|
|
17
|
+
onClick?(): void;
|
|
18
|
+
};
|
|
19
|
+
customScrollOffset?: number;
|
|
20
|
+
};
|
|
21
|
+
declare const WelcomeTourWithRef: import("react").ForwardRefExoticComponent<WelcomeTourProps & import("react").RefAttributes<JoyRide>>;
|
|
22
|
+
export declare const WelcomeTour: typeof WelcomeTourWithRef & {
|
|
23
|
+
statuses: typeof STATUS;
|
|
24
|
+
};
|
|
25
|
+
export {};
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import { forwardRef } from 'react';
|
|
3
|
+
import JoyRide, { STATUS } from 'react-joyride';
|
|
4
|
+
import { themeVars } from '@sbercloud/figma-tokens-cloud-platform';
|
|
5
|
+
import { Hint } from '../Hint';
|
|
6
|
+
const customColors = {
|
|
7
|
+
options: {
|
|
8
|
+
arrowColor: themeVars.sys.neutral.background2Level,
|
|
9
|
+
overlayColor: themeVars.sys.blackout,
|
|
10
|
+
},
|
|
11
|
+
};
|
|
12
|
+
const customArrowSize = {
|
|
13
|
+
styles: {
|
|
14
|
+
arrow: {
|
|
15
|
+
length: 8,
|
|
16
|
+
spread: 16,
|
|
17
|
+
},
|
|
18
|
+
},
|
|
19
|
+
};
|
|
20
|
+
const WelcomeTourWithRef = forwardRef(({ tourSteps, tourStarted, setTourStarted, closeButtonProps, primaryButtonProps, backButtonProps, customScrollOffset, }, ref) => {
|
|
21
|
+
const stepsWithoutBeacon = tourSteps.map(step => (Object.assign(Object.assign({}, step), { disableBeacon: true })));
|
|
22
|
+
const checkTourFinish = ({ status }) => {
|
|
23
|
+
if (status === STATUS.FINISHED || status === STATUS.SKIPPED) {
|
|
24
|
+
setTourStarted(false, status);
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
const renderTooltipComponent = (props) => (_jsx(Hint, Object.assign({ backButton: backButtonProps
|
|
28
|
+
? Object.assign(Object.assign({}, props.backProps), { label: backButtonProps.label, onClick: e => {
|
|
29
|
+
var _a;
|
|
30
|
+
(_a = backButtonProps.onClick) === null || _a === void 0 ? void 0 : _a.call(backButtonProps);
|
|
31
|
+
props.backProps.onClick(e);
|
|
32
|
+
} }) : undefined, closeButton: Object.assign(Object.assign({}, props.closeProps), { label: closeButtonProps.label, onClick: e => {
|
|
33
|
+
var _a;
|
|
34
|
+
(_a = closeButtonProps.onClick) === null || _a === void 0 ? void 0 : _a.call(closeButtonProps);
|
|
35
|
+
props.closeProps.onClick(e);
|
|
36
|
+
} }), primaryButton: Object.assign(Object.assign({}, props.primaryProps), { label: primaryButtonProps.label, onClick: e => {
|
|
37
|
+
var _a;
|
|
38
|
+
(_a = primaryButtonProps.onClick) === null || _a === void 0 ? void 0 : _a.call(primaryButtonProps);
|
|
39
|
+
props.primaryProps.onClick(e);
|
|
40
|
+
} }) }, props)));
|
|
41
|
+
return (_jsx(JoyRide, { tooltipComponent: renderTooltipComponent, steps: stepsWithoutBeacon, continuous: true, styles: customColors, run: tourStarted, callback: checkTourFinish, floaterProps: customArrowSize, disableOverlayClose: true, scrollOffset: customScrollOffset, disableScrollParentFix: true, ref: ref }));
|
|
42
|
+
});
|
|
43
|
+
export const WelcomeTour = WelcomeTourWithRef;
|
|
44
|
+
WelcomeTour.statuses = STATUS;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './WelcomeTour';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './WelcomeTour';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './WelcomeTour';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './WelcomeTour';
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { ReactNode } from 'react';
|
|
2
|
+
import { Step } from 'react-joyride';
|
|
3
|
+
export type TourStepExtended = {
|
|
4
|
+
subtitle?: ReactNode;
|
|
5
|
+
primaryButtonText?: string;
|
|
6
|
+
backButtonText?: string;
|
|
7
|
+
closeButtonText?: string;
|
|
8
|
+
onFinish?(): void | boolean;
|
|
9
|
+
} & Omit<Step, 'disableBeacon'>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './components/WelcomeTour';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './components/WelcomeTour';
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cloud-ru/uikit-product-welcome-tour",
|
|
3
3
|
"title": "Welcome Tour",
|
|
4
|
-
"version": "0.10.
|
|
4
|
+
"version": "0.10.64",
|
|
5
5
|
"sideEffects": [
|
|
6
6
|
"*.css",
|
|
7
7
|
"*.woff",
|
|
@@ -30,17 +30,18 @@
|
|
|
30
30
|
"name": "Akhremenko Grigorii",
|
|
31
31
|
"url": "https://github.com/AGrigorii"
|
|
32
32
|
},
|
|
33
|
+
"contributors": [],
|
|
33
34
|
"license": "Apache-2.0",
|
|
34
35
|
"publishConfig": {
|
|
35
36
|
"access": "public"
|
|
36
37
|
},
|
|
37
38
|
"scripts": {},
|
|
38
39
|
"dependencies": {
|
|
39
|
-
"@cloud-ru/uikit-product-icons": "15.1.
|
|
40
|
+
"@cloud-ru/uikit-product-icons": "15.1.3",
|
|
40
41
|
"@snack-uikit/button": "0.19.7",
|
|
41
42
|
"@snack-uikit/pagination": "0.10.2",
|
|
42
43
|
"@snack-uikit/typography": "0.8.4",
|
|
43
44
|
"react-joyride": "2.5.3"
|
|
44
45
|
},
|
|
45
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "bf479ecf7238ef20b78f20acaef439efa535d1a1"
|
|
46
47
|
}
|