@sima-land/ui-nucleons 41.1.0 → 41.2.0

package/_internal/body-scroll.d.ts

@@ -12,3 +12,12 @@ export interface WithBodyScrollLock {
  * @param options Опции.
  */
 export declare const useBodyScrollLock: (ref: React.RefObject<HTMLElement>, needDisable: boolean | undefined, options?: BodyScrollOptions | undefined) => void;
+/**
+ * Проверяет необходимость блокировки дочерних элементов в прокручиваемом элементе.
+ * Необходима для того, чтобы в прокручиваемых контейнерах вложенные прокручиваемые элементы,
+ * имеющие специальный атрибут, прокручивались нормально.
+ * @see {@link https://github.com/willmcpo/body-scroll-lock#more-complex}
+ * @param startEl Начальный элемент.
+ * @return Нужно ли позволить перетаскивание элемента.
+ */
+export declare const allowTouchMove: Required<BodyScrollOptions>['allowTouchMove'];

package/_internal/body-scroll.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useBodyScrollLock = void 0;
+exports.allowTouchMove = exports.useBodyScrollLock = void 0;
 const body_scroll_lock_1 = require("body-scroll-lock");
 const react_1 = require("react");
+const constants_1 = require("../constants");
 /**
  * Хук управления блокировкой прокрутки body.
  * @param ref Реф элемента для которого нужно отключить прокрутку body.
@@ -19,3 +20,22 @@ const useBodyScrollLock = (ref, needDisable, options) => {
     }, [needDisable, options]);
 };
 exports.useBodyScrollLock = useBodyScrollLock;
+/**
+ * Проверяет необходимость блокировки дочерних элементов в прокручиваемом элементе.
+ * Необходима для того, чтобы в прокручиваемых контейнерах вложенные прокручиваемые элементы,
+ * имеющие специальный атрибут, прокручивались нормально.
+ * @see {@link https://github.com/willmcpo/body-scroll-lock#more-complex}
+ * @param startEl Начальный элемент.
+ * @return Нужно ли позволить перетаскивание элемента.
+ */
+const allowTouchMove = (startEl) => {
+    let el = startEl;
+    while (el && el !== document.body) {
+        if (el.getAttribute(constants_1.BSL_IGNORE_ATTR) !== null) {
+            return true;
+        }
+        el = el.parentElement;
+    }
+    return false;
+};
+exports.allowTouchMove = allowTouchMove;

package/alert/index.js

@@ -65,7 +65,7 @@ exports.Alert = Alert;
 const AlertInner = ({ children, className, footer, navBarProps, title, withDivideNavBar, withNavBar = Boolean(title), withScrollDisable = false, scrollDisableOptions, onClose, }) => {
     const rootRef = (0, react_1.useRef)(null);
     const layer = (0, layer_1.useLayer)();
-    (0, body_scroll_1.useBodyScrollLock)(rootRef, withScrollDisable, scrollDisableOptions);
+    (0, body_scroll_1.useBodyScrollLock)(rootRef, withScrollDisable, Object.assign({ allowTouchMove: body_scroll_1.allowTouchMove }, scrollDisableOptions));
     return (react_1.default.createElement("div", { ref: rootRef, className: cx('overlay'), style: { zIndex: layer }, onClick: e => e.target === e.currentTarget && (onClose === null || onClose === void 0 ? void 0 : onClose()), "data-testid": 'alert:overlay' },
         react_1.default.createElement("div", { className: cx('alert', className), "data-testid": 'alert' },
             withNavBar && (react_1.default.createElement(nav_bar_1.NavBar, Object.assign({}, navBarProps, { title: title, bottomBordered: withDivideNavBar, className: cx('header') }))),

package/constants.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Имя атрибута, устанавливаемого на элемент, имеющий прокрутку.
+ * Атрибут устанавливается на элемент в случае, если
+ * прокручиваемый родитель элемента обрабатывается с помощью body-scroll-lock.
+ */
+export declare const BSL_IGNORE_ATTR = "data-bsl-ignore";

package/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BSL_IGNORE_ATTR = void 0;
+/**
+ * Имя атрибута, устанавливаемого на элемент, имеющий прокрутку.
+ * Атрибут устанавливается на элемент в случае, если
+ * прокручиваемый родитель элемента обрабатывается с помощью body-scroll-lock.
+ */
+exports.BSL_IGNORE_ATTR = 'data-bsl-ignore';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sima-land/ui-nucleons",
-  "version": "41.1.0",
+  "version": "41.2.0",
   "repository": "ssh://git@github.com:sima-land/ui-nucleons.git",
   "author": "www.sima-land.ru team",
   "license": "Apache-2.0",

package/screen/index.d.ts

@@ -1,18 +1,10 @@
 import React from 'react';
-import { LoadingOverlayProps } from '../loading-overlay';
-export interface ScreenProps {
+import { ScreenInnerProps } from './utils';
+export interface ScreenProps extends ScreenInnerProps {
     /** Содержимое. */
     children?: React.ReactNode;
-    /** Нужно ли выводить вместо содержимого состояние загрузки. */
-    loading?: boolean;
     /** Определяет область отображаемую как загружающуюся. */
     loadingArea?: 'content' | 'full';
-    /** Свойства компонента LoadingOverlay. */
-    loadingOverlayProps?: LoadingOverlayProps;
-    /** Будет вызвана при полной прокрутке содержимого экрана. */
-    onFullScroll?: () => void;
-    /** Отступ от нижней границы содержимого экрана, после которого начинает срабатывать onFullScroll. */
-    fullScrollThreshold?: number;
     /** Идентификатор для систем автоматизированного тестирования. */
     'data-testid'?: string;
 }
@@ -24,6 +16,8 @@ export interface ScreenProps {
 export declare const Screen: {
     ({ children, loading, loadingArea, loadingOverlayProps, onFullScroll, fullScrollThreshold, "data-testid": testId, }: ScreenProps): JSX.Element;
     Header: ({ divided, title, subtitle, buttons, onBack, onClose, ...restProps }: import("./slots").HeaderSlotProps) => JSX.Element;
-    Body: React.FC<{}>;
+    Body: React.ForwardRefExoticComponent<{
+        children?: React.ReactNode;
+    } & React.RefAttributes<HTMLDivElement | null>>;
     Footer: React.FC<{}>;
 };

package/screen/index.js

@@ -1,35 +1,14 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Screen = void 0;
-const react_1 = __importStar(require("react"));
+const react_1 = __importDefault(require("react"));
 const slots_1 = require("./slots");
-const loading_overlay_1 = require("../loading-overlay");
-const body_scroll_1 = require("../_internal/body-scroll");
 const layer_1 = require("../helpers/layer");
 const define_slots_1 = require("../helpers/define-slots");
-const hooks_1 = require("../hooks");
+const utils_1 = require("./utils");
 const screen_module_scss_1 = __importDefault(require("./screen.module.scss"));
 /**
  * Экран.
@@ -44,16 +23,18 @@ const Screen = ({ children, loading, loadingArea = 'full', loadingOverlayProps,
         body: slots_1.BodySlot,
         footer: slots_1.FooterSlot,
     });
-    // при блокировке прокрутки нужно передавать элемент которому нужно сохранить возможность прокрутки
-    // https://github.com/willmcpo/body-scroll-lock/blame/79c4cf2c956eb7d5cf8d54a03d12751bc6ac8aa3/README.md#L52
-    // поэтому используем внутренний ref и useImperativeHandle
-    const bodyRef = (0, react_1.useRef)(null);
-    (0, body_scroll_1.useBodyScrollLock)(bodyRef, true);
-    (0, hooks_1.useInfiniteScroll)(bodyRef, { onFullScroll, threshold: fullScrollThreshold });
+    if (!body) {
+        throw Error('Looks like you are trying to render <Screen /> without <Screen.Body /> slot, but it is required');
+    }
     return (react_1.default.createElement("div", { className: screen_module_scss_1.default.root, style: { zIndex: layer }, "data-testid": testId },
         react_1.default.createElement(layer_1.LayerProvider, { value: layer },
             !fullLoading && header,
-            react_1.default.createElement("div", { ref: bodyRef, className: screen_module_scss_1.default.body, "data-testid": 'screen:body' }, loading ? (react_1.default.createElement(loading_overlay_1.LoadingOverlay, Object.assign({}, loadingOverlayProps, { fill: false, style: { height: '100%' } }))) : (body)),
+            react_1.default.createElement(utils_1.ScreenContext.Provider, { value: {
+                    loading,
+                    loadingOverlayProps,
+                    onFullScroll,
+                    fullScrollThreshold,
+                } }, body),
             !fullLoading && footer && (react_1.default.createElement("div", { className: screen_module_scss_1.default.footer, "data-testid": 'screen:footer' }, footer)))));
 };
 exports.Screen = Screen;

package/screen/slots.d.ts

@@ -20,10 +20,10 @@ export interface HeaderSlotProps extends NavBarProps {
 export declare const HeaderSlot: ({ divided, title, subtitle, buttons, onBack, onClose, ...restProps }: HeaderSlotProps) => JSX.Element;
 /**
  * Слот основного контента экрана.
- * @param props Свойства.
- * @return Элемент.
  */
-export declare const BodySlot: React.FC;
+export declare const BodySlot: React.ForwardRefExoticComponent<{
+    children?: React.ReactNode;
+} & React.RefAttributes<HTMLDivElement | null>>;
 /**
  * Слот футера экрана.
  * @param props Свойства.

package/screen/slots.js

@@ -1,4 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __rest = (this && this.__rest) || function (s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -15,11 +34,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FooterSlot = exports.BodySlot = exports.HeaderSlot = void 0;
-const react_1 = __importDefault(require("react"));
+const react_1 = __importStar(require("react"));
 const nav_bar_1 = require("../nav-bar");
 const lodash_1 = require("lodash");
 const arrow_left_1 = __importDefault(require("@sima-land/ui-quarks/icons/24x24/Stroked/arrow-left"));
 const cross_1 = __importDefault(require("@sima-land/ui-quarks/icons/24x24/Stroked/cross"));
+const body_scroll_1 = require("../_internal/body-scroll");
+const hooks_1 = require("../hooks");
+const loading_overlay_1 = require("../loading-overlay");
+const utils_1 = require("./utils");
+const screen_module_scss_1 = __importDefault(require("./screen.module.scss"));
 /**
  * Слот шапки экрана.
  * @param props Свойства.
@@ -50,11 +74,20 @@ const HeaderSlot = (_a) => {
 exports.HeaderSlot = HeaderSlot;
 /**
  * Слот основного контента экрана.
- * @param props Свойства.
- * @return Элемент.
  */
-const BodySlot = ({ children }) => react_1.default.createElement(react_1.default.Fragment, null, children);
-exports.BodySlot = BodySlot;
+exports.BodySlot = (0, react_1.forwardRef)(function BodySlot({ children }, outerRef) {
+    const { loading, loadingOverlayProps, onFullScroll, fullScrollThreshold } = (0, react_1.useContext)(utils_1.ScreenContext);
+    // при блокировке прокрутки нужно передавать элемент, которому нужно сохранить возможность прокрутки
+    // https://github.com/willmcpo/body-scroll-lock/blame/79c4cf2c956eb7d5cf8d54a03d12751bc6ac8aa3/README.md#L52
+    // поэтому используем внутренний ref и useImperativeHandle
+    const ref = (0, react_1.useRef)(null);
+    (0, react_1.useImperativeHandle)(outerRef, () => ref.current);
+    (0, body_scroll_1.useBodyScrollLock)(ref, true, { allowTouchMove: body_scroll_1.allowTouchMove });
+    (0, hooks_1.useInfiniteScroll)(ref, { onFullScroll, threshold: fullScrollThreshold });
+    return (
+    // ВАЖНО: элемент с ref должен выводиться всегда (без условий), т.к. он нужен для блокировки прокрутки
+    react_1.default.createElement("div", { ref: ref, className: screen_module_scss_1.default.body, "data-testid": 'screen:body' }, loading ? (react_1.default.createElement(loading_overlay_1.LoadingOverlay, Object.assign({}, loadingOverlayProps, { fill: false, style: { height: '100%' } }))) : (children)));
+});
 /**
  * Слот футера экрана.
  * @param props Свойства.

package/screen/utils.d.ts

@@ -1 +1,13 @@
-export declare const cx: (...args: import("classnames").Argument[]) => string;
+/// <reference types="react" />
+import { LoadingOverlayProps } from '../loading-overlay';
+export interface ScreenInnerProps {
+    /** Нужно ли выводить вместо содержимого состояние загрузки. */
+    loading?: boolean;
+    /** Свойства компонента LoadingOverlay. */
+    loadingOverlayProps?: LoadingOverlayProps;
+    /** Будет вызвана при полной прокрутке содержимого экрана. */
+    onFullScroll?: () => void;
+    /** Отступ от нижней границы содержимого экрана, после которого начинает срабатывать onFullScroll. */
+    fullScrollThreshold?: number;
+}
+export declare const ScreenContext: import("react").Context<ScreenInnerProps>;

package/screen/utils.js

@@ -1,9 +1,5 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cx = void 0;
-const bind_1 = __importDefault(require("classnames/bind"));
-const screen_module_scss_1 = __importDefault(require("./screen.module.scss"));
-exports.cx = bind_1.default.bind(screen_module_scss_1.default);
+exports.ScreenContext = void 0;
+const react_1 = require("react");
+exports.ScreenContext = (0, react_1.createContext)({});

package/touch-slider/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TouchSlider = void 0;
 const react_1 = __importDefault(require("react"));
 const layout_1 = require("../layout");
+const constants_1 = require("../constants");
 const bind_1 = __importDefault(require("classnames/bind"));
 const touch_slider_module_scss_1 = __importDefault(require("./touch-slider.module.scss"));
 const cx = bind_1.default.bind(touch_slider_module_scss_1.default);
@@ -15,6 +16,6 @@ const cx = bind_1.default.bind(touch_slider_module_scss_1.default);
  * @return Элемент.
  */
 const TouchSlider = ({ children }) => (react_1.default.createElement(layout_1.MobileLayout, null,
-    react_1.default.createElement("div", { className: cx('outer', 'invisible-scroll') },
+    react_1.default.createElement("div", Object.assign({ className: cx('outer', 'invisible-scroll') }, { [constants_1.BSL_IGNORE_ATTR]: true }),
         react_1.default.createElement("div", { className: cx('inner') }, children))));
 exports.TouchSlider = TouchSlider;