@vkontakte/vkui 4.28.0 → 4.28.1

package/src/components/ModalRoot/types.ts

@@ -0,0 +1,53 @@
+export enum ModalType {
+  PAGE = "page",
+  CARD = "card",
+}
+
+export type TranslateRange = [number, number];
+
+export type ModalsState = { [index: string]: ModalsStateEntry };
+
+export interface ModalElements {
+  modalElement?: HTMLElement | null;
+  innerElement?: HTMLElement | null;
+  headerElement?: HTMLElement | null;
+  contentElement?: HTMLElement | null;
+}
+
+export interface ModalsStateEntry extends ModalElements {
+  id: string | null;
+  onClose?: () => any;
+  type?: ModalType;
+
+  settlingHeight?: number;
+  dynamicContentHeight?: boolean;
+  expandable?: boolean;
+
+  /**
+   * Процент текущего сдвига модалки
+   */
+  translateY?: number;
+  /**
+   * Процент сдвига модалки в изначальном состоянии
+   */
+  translateYFrom?: number;
+  /**
+   * Процент сдвига модалки во время взаимодействия с ней (потянуть, чтобы открыть или закрыть)
+   */
+  translateYCurrent?: number;
+
+  touchStartContentScrollTop?: number;
+  touchMovePositive?: boolean | null;
+  touchShiftYPercent?: number;
+
+  expanded?: boolean;
+  collapsed?: boolean;
+  hidden?: boolean;
+
+  contentScrolled?: boolean;
+  contentScrollStopTimeout?: ReturnType<typeof setTimeout>;
+
+  expandedRange?: TranslateRange;
+  collapsedRange?: TranslateRange;
+  hiddenRange?: TranslateRange;
+}

package/src/components/ModalRoot/useModalManager.tsx

@@ -0,0 +1,203 @@
+import * as React from "react";
+import { ModalsState, ModalsStateEntry, ModalType } from "./types";
+import { warnOnce } from "../../lib/warnOnce";
+import { getNavId } from "../../lib/getNavId";
+import { useIsomorphicLayoutEffect } from "../../lib/useIsomorphicLayoutEffect";
+import { noop, isFunction } from "../../lib/utils";
+
+interface ModalTransitionState {
+  activeModal?: string | null;
+  enteringModal?: string | null;
+  exitingModal?: string | null;
+
+  history?: string[];
+  isBack?: boolean | null;
+}
+
+export interface ModalTransitionProps extends ModalTransitionState {
+  onEnter: (id: string | null) => void;
+  onExit: (id: string | null) => void;
+  getModalState: (id: string) => ModalsStateEntry;
+  closeActiveModal: VoidFunction;
+  delayEnter: boolean;
+}
+
+function getModals(children: React.ReactNode | React.ReactNode[]) {
+  return React.Children.toArray(children) as React.ReactElement[];
+}
+
+const warn = warnOnce("ModalRoot");
+
+export function modalTransitionReducer(
+  state: ModalTransitionState,
+  action: {
+    type: "setActive" | "entered" | "exited" | "inited";
+    id: string | null;
+  }
+): ModalTransitionState {
+  if (action.type === "setActive" && action.id !== state.activeModal) {
+    const nextModal = action.id;
+    // preserve exiting modal if switching mid-transition
+    const prevModal = state.exitingModal || state.activeModal;
+    let history = state.history ? [...state.history] : [];
+    const isBack = Boolean(nextModal && history.includes(nextModal));
+
+    if (nextModal === null) {
+      history = [];
+    } else if (isBack) {
+      history = history.splice(0, history.indexOf(nextModal) + 1);
+    } else {
+      history.push(nextModal);
+    }
+
+    return {
+      activeModal: nextModal,
+      // not entering yet
+      enteringModal: null,
+      exitingModal: prevModal,
+      history,
+      isBack,
+    };
+  }
+  if (action.type === "entered" && action.id === state.enteringModal) {
+    return { ...state, enteringModal: null };
+  }
+  if (action.type === "exited" && action.id === state.exitingModal) {
+    return { ...state, exitingModal: null };
+  }
+  if (action.type === "inited" && action.id === state.activeModal) {
+    return { ...state, enteringModal: action.id };
+  }
+  return state;
+}
+
+/**
+ * Реализует переход модалок. При смене activeModal m1 -> m2:
+ * 1. activeModal: m1, exitingModal: null, enteringModal: null, триггер перехода
+ * 2. activeModal: m2, exitingModal: m1, enteringModal: null, рендерим m2 чтобы прошел init, начинаем анимацию выхода
+ * одновременный переход между ModalPage:
+ *   3a. activeModal: m2, exitingModal: m1, enteringModal: m2
+ *   4a. exitingModal и enteringModal переходят в null в порядке завершения анимации
+ * ИЛИ дожидаемся скрытия ModalCard
+ *   3b. activeModal: m2, exitingModal: null, enteringModal: m2
+ *   4b. enteringModal переходит в null после завершения анимации
+ * 5. activeModal: m2, exitingModal: null, enteringModal: null, переход закончен
+ */
+export function useModalManager(
+  activeModal: string | null | undefined,
+  children: React.ReactNode | React.ReactNode[],
+  onClose: (id: string) => void,
+  initModal: (state: ModalsStateEntry) => void = noop
+): ModalTransitionProps {
+  const modalsState = React.useRef<ModalsState>({}).current;
+  getModals(children).forEach((Modal) => {
+    const modalProps = Modal.props;
+    const id = getNavId(modalProps, warn);
+    const state: ModalsStateEntry = (id !== undefined && modalsState[id]) || {
+      id: id ?? null,
+    };
+
+    state.onClose = Modal.props.onClose;
+    state.dynamicContentHeight = !!modalProps.dynamicContentHeight;
+    // ModalPage props
+    if (typeof modalProps.settlingHeight === "number") {
+      state.settlingHeight = modalProps.settlingHeight;
+    }
+
+    if (state.id !== null) {
+      modalsState[state.id] = state;
+    }
+  });
+
+  const isMissing = activeModal && !modalsState[activeModal];
+  const safeActiveModal = isMissing ? null : activeModal;
+  const [transitionState, dispatchTransition] = React.useReducer(
+    modalTransitionReducer,
+    {
+      activeModal: safeActiveModal,
+      enteringModal: null,
+      exitingModal: null,
+      history: safeActiveModal ? [safeActiveModal] : [],
+      isBack: false,
+    }
+  );
+
+  // Map props to state, render activeModal for init
+  useIsomorphicLayoutEffect(() => {
+    // ignore non-existent activeModal
+    if (process.env.NODE_ENV === "development" && isMissing) {
+      warn(`Can't transition - modal ${activeModal} not found`);
+    }
+    dispatchTransition({ type: "setActive", id: safeActiveModal ?? null });
+  }, [activeModal]);
+
+  // Init activeModal & set enteringModal
+  useIsomorphicLayoutEffect(() => {
+    if (transitionState.activeModal) {
+      initModal(modalsState[transitionState.activeModal]);
+      dispatchTransition({ type: "inited", id: transitionState.activeModal });
+    }
+  }, [transitionState.activeModal]);
+
+  const isCard = (id: string | null | undefined) =>
+    id != null && modalsState[id]?.type === ModalType.CARD;
+  const onEnter = React.useCallback(
+    (id: string | null) => dispatchTransition({ type: "entered", id }),
+    []
+  );
+  const onExit = React.useCallback(
+    (id: string | null) => dispatchTransition({ type: "exited", id }),
+    []
+  );
+  const delayEnter = Boolean(
+    transitionState.exitingModal &&
+      (isCard(activeModal) || isCard(transitionState.exitingModal))
+  );
+  const getModalState = React.useCallback(
+    (id: string) => modalsState[id],
+    [modalsState]
+  );
+
+  function closeActiveModal() {
+    const modalState =
+      transitionState.activeModal && modalsState[transitionState.activeModal];
+    if (modalState) {
+      if (isFunction(modalState.onClose)) {
+        modalState.onClose();
+      } else if (isFunction(onClose)) {
+        onClose(modalState.id);
+      } else if (process.env.NODE_ENV === "development") {
+        warn("onClose is undefined");
+      }
+    }
+  }
+
+  return {
+    onEnter,
+    onExit,
+    ...transitionState,
+    delayEnter,
+    getModalState,
+    closeActiveModal,
+  };
+}
+
+export function withModalManager(
+  initModal: (a: ModalsStateEntry) => void = noop
+) {
+  return function <Props extends ModalTransitionProps>(
+    Wrapped: React.ComponentType<Props>
+  ): React.FC<
+    Omit<Props, keyof ModalTransitionProps> & { activeModal?: string | null }
+  > {
+    return function WithModalManager(props) {
+      const transitionManager = useModalManager(
+        props.activeModal,
+        props.children,
+        (props as any).onClose,
+        initModal
+      );
+      return <Wrapped {...(props as any)} {...transitionManager} />;
+    };
+  };
+}

package/src/components/ModalRoot/withModalRootContext.tsx

@@ -0,0 +1,19 @@
+import * as React from "react";
+import ModalRootContext, {
+  ModalRootContextInterface,
+} from "./ModalRootContext";
+
+type PickedProps = Pick<ModalRootContextInterface, "updateModalHeight">;
+
+export function withModalRootContext<P extends PickedProps>(
+  Component: React.ComponentType<P>
+): React.ComponentType<Omit<P, keyof PickedProps>> {
+  function WithModalRootContext(props: Omit<P, keyof PickedProps>) {
+    const { updateModalHeight } = React.useContext(ModalRootContext);
+
+    return (
+      <Component {...(props as P)} updateModalHeight={updateModalHeight} />
+    );
+  }
+  return WithModalRootContext;
+}

package/src/components/NativeSelect/NativeSelect.tsx

@@ -0,0 +1,113 @@
+import * as React from "react";
+import { classNames } from "../../lib/classNames";
+import { DropdownIcon } from "../DropdownIcon/DropdownIcon";
+import { FormField } from "../FormField/FormField";
+import { HasAlign, HasRef, HasRootRef } from "../../types";
+import { withAdaptivity, SizeType } from "../../hoc/withAdaptivity";
+import { getClassName } from "../../helpers/getClassName";
+import Headline from "../Typography/Headline/Headline";
+import Text from "../Typography/Text/Text";
+import { VKCOM } from "../../lib/platform";
+import { useIsomorphicLayoutEffect } from "../../lib/useIsomorphicLayoutEffect";
+import { useEnsuredControl } from "../../hooks/useEnsuredControl";
+import { useExternRef } from "../../hooks/useExternRef";
+import { usePlatform } from "../../hooks/usePlatform";
+import {
+  AdaptivityContextInterface,
+  AdaptivityProps,
+} from "../AdaptivityProvider/AdaptivityContext";
+import "../Select/Select.css";
+
+export interface NativeSelectProps
+  extends React.SelectHTMLAttributes<HTMLSelectElement>,
+    HasRef<HTMLSelectElement>,
+    HasRootRef<HTMLLabelElement>,
+    HasAlign,
+    AdaptivityProps {
+  placeholder?: string;
+  multiline?: boolean;
+}
+
+export interface SelectState {
+  value?: React.SelectHTMLAttributes<HTMLSelectElement>["value"];
+  title?: string;
+  notSelected?: boolean;
+}
+
+const NativeSelect: React.FC<
+  NativeSelectProps & AdaptivityContextInterface
+> = ({
+  style,
+  defaultValue = "",
+  align,
+  placeholder,
+  children,
+  className,
+  getRef,
+  getRootRef,
+  disabled,
+  sizeX,
+  sizeY,
+  multiline,
+  ...restProps
+}) => {
+  const platform = usePlatform();
+  const [title, setTitle] = React.useState("");
+  const [notSelected, setNotSelected] = React.useState(false);
+  const [value, onChange] = useEnsuredControl(restProps, { defaultValue });
+  const selectRef = useExternRef(getRef);
+  useIsomorphicLayoutEffect(() => {
+    const selectedOption =
+      selectRef.current?.options[selectRef.current.selectedIndex];
+    if (selectedOption) {
+      setTitle(selectedOption.text);
+      setNotSelected(selectedOption.value === "" && placeholder != null);
+    }
+  }, [value, children]);
+
+  const TypographyComponent =
+    platform === VKCOM || sizeY === SizeType.COMPACT ? Text : Headline;
+
+  return (
+    <FormField
+      Component="label"
+      vkuiClass={classNames(getClassName("Select", platform), {
+        ["Select--not-selected"]: notSelected,
+        [`Select--align-${align}`]: !!align,
+        [`Select--sizeX--${sizeX}`]: !!sizeX,
+        [`Select--sizeY--${sizeY}`]: !!sizeY,
+        "Select--multiline": multiline,
+      })}
+      className={className}
+      style={style}
+      getRootRef={getRootRef}
+      disabled={disabled}
+      after={<DropdownIcon />}
+    >
+      <select
+        {...restProps}
+        disabled={disabled}
+        vkuiClass="Select__el"
+        onChange={onChange}
+        value={value}
+        ref={selectRef}
+      >
+        {placeholder && <option value="">{placeholder}</option>}
+        {children}
+      </select>
+      <TypographyComponent
+        Component="div"
+        weight="regular"
+        vkuiClass="Select__container"
+      >
+        <span vkuiClass="Select__title">{title}</span>
+      </TypographyComponent>
+    </FormField>
+  );
+};
+
+// eslint-disable-next-line import/no-default-export
+export default withAdaptivity(NativeSelect, {
+  sizeX: true,
+  sizeY: true,
+});

package/src/components/NativeSelect/Readme.md

@@ -0,0 +1,17 @@
+Надстройка над `<select />`. Компонент принимает все валидные для этого элемента свойства.
+
+```jsx
+<View activePanel="native-select">
+  <Panel id="native-select">
+    <PanelHeader>NativeSelect</PanelHeader>
+    <Group>
+      <FormItem top="Выберите пол">
+        <NativeSelect>
+          <option value="m">Мужской</option>
+          <option value="f">Женский</option>
+        </NativeSelect>
+      </FormItem>
+    </Group>
+  </Panel>
+</View>
+```

package/src/components/NavTransitionContext/NavTransitionContext.tsx

@@ -0,0 +1,24 @@
+import * as React from "react";
+import { useObjectMemo } from "../../hooks/useObjectMemo";
+
+interface TransitionContextProps {
+  entering: boolean;
+}
+const TransitionContext = React.createContext<TransitionContextProps>({
+  entering: false,
+});
+export const useNavTransition = () => React.useContext(TransitionContext);
+export const NavTransitionProvider: React.FC<TransitionContextProps> = ({
+  children,
+  entering,
+}) => {
+  const parentContext = useNavTransition();
+  const contextValue = useObjectMemo({
+    entering: parentContext.entering || entering,
+  });
+  return (
+    <TransitionContext.Provider value={contextValue}>
+      {children}
+    </TransitionContext.Provider>
+  );
+};

package/src/components/Pagination/Pagination.css

@@ -0,0 +1,62 @@
+.Pagination {
+}
+
+.Pagination__list {
+  display: flex;
+  margin: 0;
+  padding: 0;
+  list-style-type: none;
+}
+
+.Pagination__prevButtonContainer {
+  margin-right: 8px;
+}
+
+.Pagination__nextButtonContainer {
+  margin-left: 8px;
+}
+
+/* Page styles */
+.Pagination__page {
+  box-sizing: border-box;
+  padding-right: 8px;
+  padding-left: 8px;
+  width: 100%;
+  min-width: 40px;
+  border-radius: var(--vkui--size_border_radius--regular);
+  text-align: center;
+  color: var(--vkui--color_text_secondary);
+  user-select: none;
+}
+
+.Pagination__page--state-hover {
+  background-color: var(--vkui--color_transparent--hover);
+}
+
+.Pagination__page--state-active,
+.Pagination__page--current {
+  color: var(--vkui--color_text_primary);
+  background-color: var(--vkui--color_transparent--active);
+}
+
+.Pagination__page--disabled {
+  opacity: var(--vkui--opacity_disable);
+}
+
+.Pagination__page--sizeY-compact {
+  font-size: var(--vkui--font_text--font_size--compact);
+  line-height: var(--vkui--size_button_large_height--compact);
+  height: var(--vkui--size_button_large_height--compact);
+}
+
+.Pagination__page--sizeY-regular {
+  font-size: var(--vkui--font_text--font_size--regular);
+  line-height: var(--vkui--size_button_large_height--regular);
+  height: var(--vkui--size_button_large_height--regular);
+}
+
+.Pagination__page--type-ellipsis {
+  min-width: 16px;
+  padding-right: 0;
+  padding-left: 0;
+}

package/src/components/Pagination/Pagination.tsx

@@ -0,0 +1,196 @@
+import * as React from "react";
+import {
+  Icon24ChevronCompactLeft,
+  Icon24ChevronCompactRight,
+} from "@vkontakte/icons";
+
+import type { HasRootRef } from "../../types";
+
+import { classNames } from "../../lib/classNames";
+
+import { useAdaptivity } from "../../hooks/useAdaptivity";
+import { PaginationPageType, usePagination } from "../../hooks/usePagination";
+
+import Tappable from "../Tappable/Tappable";
+import Button from "../Button/Button";
+
+import "./Pagination.css";
+
+function getPageAriaLabelDefault(page: number, isCurrent: boolean): string {
+  return isCurrent ? `${page} страница` : `Перейти на ${page} страницу`;
+}
+
+export interface PaginationProps
+  extends Omit<React.HTMLAttributes<HTMLElement>, "onChange">,
+    HasRootRef<HTMLElement> {
+  /**
+   * Текущая страница.
+   */
+  currentPage?: number;
+  /**
+   * Кол-во всегда видимых страниц по краям текущей страницы.
+   */
+  siblingCount?: number;
+  /**
+   * Кол-во всегда видимых страниц в начале и в конце.
+   */
+  boundaryCount?: number;
+  /**
+   * Общее кол-во страниц.
+   */
+  totalPages?: number;
+  /**
+   * Блокировка всех кнопок.
+   */
+  disabled?: boolean;
+  /**
+   * Переобределение `aria-label` для кнопки навигации назад.
+   * По умолчанию используется текст на "ru_RU".
+   */
+  prevButtonAriaLabel?: string;
+  /**
+   * Переобределение `aria-label` для кнопки навигации вперёд.
+   * По умолчанию используется текст на "ru_RU".
+   */
+  nextButtonAriaLabel?: string;
+  /**
+   * Функция для переопределния и/или локализации `aria-label` атрибута.
+   * По умолчанию используется текст на "ru_RU".
+   */
+  getPageAriaLabel?(page: number, isCurrent: boolean): string;
+  onChange?(page: number): void;
+}
+
+export const Pagination: React.FC<PaginationProps> = ({
+  currentPage = 1,
+  siblingCount = 1,
+  boundaryCount = 1,
+  totalPages = 1,
+  disabled,
+  getPageAriaLabel = getPageAriaLabelDefault,
+  prevButtonAriaLabel = "Перейти на предыдущую страницу",
+  nextButtonAriaLabel = "Перейти на следующую страницу",
+  getRootRef,
+  onChange,
+  ...resetProps
+}) => {
+  const { sizeY } = useAdaptivity();
+
+  const pages = usePagination({
+    currentPage,
+    totalPages,
+    siblingCount,
+    boundaryCount,
+  });
+  const isFirstPage = currentPage === 1;
+  const isLastPage = currentPage === totalPages;
+
+  const handlePrevClick = React.useCallback(() => {
+    if (onChange && !isFirstPage) {
+      onChange(currentPage - 1);
+    }
+  }, [currentPage, isFirstPage, onChange]);
+
+  const handleClick = React.useCallback(
+    (event: React.MouseEvent<HTMLElement>) => {
+      const page: string = event.currentTarget.dataset.page || "1";
+      onChange?.(Number(page));
+    },
+    [onChange]
+  );
+
+  const handleNextClick = React.useCallback(() => {
+    if (onChange && !isLastPage) {
+      onChange(currentPage + 1);
+    }
+  }, [currentPage, isLastPage, onChange]);
+
+  const renderPages = React.useCallback(
+    (page: PaginationPageType) => {
+      switch (page) {
+        case "start-ellipsis":
+        case "end-ellipsis":
+          return (
+            <li key={page}>
+              <div
+                vkuiClass={classNames(
+                  "Pagination__page",
+                  "Pagination__page--type-ellipsis",
+                  `Pagination__page--sizeY-${sizeY}`,
+                  disabled && "Pagination__page--disabled"
+                )}
+              >
+                ...
+              </div>
+            </li>
+          );
+        default: {
+          const isCurrent = page === currentPage;
+          return (
+            <li key={page}>
+              <Tappable
+                vkuiClass={classNames(
+                  "Pagination__page",
+                  `Pagination__page--sizeY-${sizeY}`,
+                  isCurrent && "Pagination__page--current",
+                  disabled && "Pagination__page--disabled"
+                )}
+                activeMode="Pagination__page--state-active"
+                hoverMode="Pagination__page--state-hover"
+                hasActive={!isCurrent}
+                hasHover={!isCurrent}
+                focusVisibleMode="outside"
+                disabled={disabled}
+                data-page={page}
+                aria-current={isCurrent ? true : undefined}
+                aria-label={getPageAriaLabel(page, isCurrent)}
+                onClick={handleClick}
+              >
+                {page}
+              </Tappable>
+            </li>
+          );
+        }
+      }
+    },
+    [sizeY, currentPage, disabled, getPageAriaLabel, handleClick]
+  );
+
+  return (
+    <nav
+      vkuiClass="Pagination"
+      role="navigation"
+      aria-label="Навигация по страницам"
+      ref={getRootRef}
+      {...resetProps}
+    >
+      <ul vkuiClass="Pagination__list">
+        <li vkuiClass="Pagination__prevButtonContainer">
+          <Button
+            size="l"
+            before={<Icon24ChevronCompactLeft width={24} />}
+            appearance="accent"
+            mode="tertiary"
+            stretched
+            disabled={isFirstPage || disabled}
+            aria-label={prevButtonAriaLabel}
+            onClick={handlePrevClick}
+          />
+        </li>
+        {pages.map(renderPages)}
+        <li vkuiClass="Pagination__nextButtonContainer">
+          <Button
+            size="l"
+            after={<Icon24ChevronCompactRight width={24} />}
+            appearance="accent"
+            mode="tertiary"
+            stretched
+            disabled={isLastPage || disabled}
+            aria-label={nextButtonAriaLabel}
+            onClick={handleNextClick}
+          />
+        </li>
+      </ul>
+    </nav>
+  );
+};