﻿---
description: Переопределяет базовую адаптивность компонента – глобально или локально.
tags: provider
---

# AdaptivityProvider \[tag:component]

Переопределяет базовую [адаптивность](/overview/adaptivity) компонента – глобально или локально. Принимает все доступные
[параметры адаптивности](/overview/adaptivity#adaptivity-props).

## Когда использовать? \[#when-to-use]

* Если вам нужно зафиксировать размер компонента на `compact` или `regular` (см. [Адаптивность | Размеры элементов интерфейса](/overview/adaptivity#density)).
* Если вам нужно зафиксировать конкретный брейкпоинт на мобильный, планшетный, настольный и т.п. (см. [Адаптивность | Размеры экрана](/overview/adaptivity#breakpoints)).
* Если вам нужно зафиксировать поведение компонента (см. [Адаптивность | Наличие точного указателя](/overview/adaptivity#pointer)).

## Логика работы

`AdaptivityProvider` всегда перебивает свой вышестоящий экземпляр – это значит, что свойства не наследуются из контекста.

Говоря о свойствах, по умолчанию они определяются как `undefined`. Автоматически определение есть только у свойства `density` при
условии, что заданы `viewWidth` и `viewHeight` или `viewWidth` и `hasPointer` или только `viewHeight`.

## Глобальное переопределение \[#override-global]

Оборачиваем в `AdaptivityProvider` всё приложение.

```jsx filename="index.js" {9}
import { ConfigProvider, AdaptivityProvider, AppRoot, ViewWidth } from '@vkontakte/vkui';

/**
 * Зашили верстку и поведение под настольные экраны.
 */
export function AlwaysDesktopWithMouse() {
  return (
    <ConfigProvider>
      <AdaptivityProvider viewWidth={ViewWidth.DESKTOP} hasPointer>
        <AppRoot>{/* приложение */}</AppRoot>
      </AdaptivityProvider>
    </ConfigProvider>
  );
}
```

## Локальное переопределение \[#override-local]

В необходимом месте отдельно оборачиваем компонент или ряд компонентов в `AdaptivityProvider`.

```jsx {8}
import { AdaptivityProvider, Button } from '@vkontakte/vkui';

/**
 * Зашили высоту кнопки в "regular" размере.
 */
export function ReallyBigButton() {
  return (
    <AdaptivityProvider density="regular">
      <Button size="l">Я действительно большая кнопка</Button>
    </AdaptivityProvider>
  );
}
```

## Хук useAdaptivity \[#use-adaptivity]

Хук возвращает из контекста свойства, переданные в `AdaptivityProvider`.

```jsx filename="example.jsx"
import { AdaptivityProvider, useAdaptivity } from '@vkontakte/vkui';

function AdaptivityPropsByContext() {
  const {
    density = 'undefined',
    viewWidth = 'undefined',
    viewHeight = 'undefined',
    hasPointer = 'undefined',
  } = useAdaptivity();

  return (
    <pre>
      density: {density}, viewWidth: {viewWidth}, viewHeight: {viewHeight}, hasPointer:{' '}
      {hasPointer}
    </pre>
  );
}

// На странице увидим такой вывод
//
// density: compact, viewWidth: undefined, viewHeight: undefined, hasPointer: undefined
export function App() {
  return (
    <AdaptivityProvider density="compact">
      <AdaptivityPropsByContext />
    </AdaptivityProvider>
  );
}
```

Для создание адаптивных интерфейсов лучше использовать более гибкие утилиты (см. [Адаптивность |
Утилиты для создания адаптивных интерфейсов](/overview/adaptivity#utils)).

## Свойства и методы \[#api]

### AdaptivityProvider

| Свойство     | Тип                 | По умолчанию | Описание                                                                                                                                                                                                                                                                          |
| ------------ | ------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `density`    | `DensityTypeValues` | `-`          | Тип размера экрана.                                                                                                                                                                                                                                                               |
| `hasHover`   | `boolean`           | `-`          | **Deprecated**: Since 7.3.0. Будет удалено в **VKUI v9** ([https://github.com/VKCOM/VKUI/pull/8490](https://github.com/VKCOM/VKUI/pull/8490)).                                                                                                                                    |
| `hasPointer` | `boolean`           | `-`          | Флаг наличия указателя (например, мыши) на устройстве.                                                                                                                                                                                                                            |
| `sizeX`      | `SizeTypeValues`    | `-`          | **Deprecated**: Since 8.0.0. Будет удалено в **VKUI v10** – используйте `sizeX="compact"` → `viewWidth={ViewWidth.MOBILE}` или `sizeX="compact"` → `viewWidth={ViewWidth.SMALL_TABLET}` ([https://github.com/VKCOM/VKUI/issues/9015](https://github.com/VKCOM/VKUI/issues/9015)). |
| `sizeY`      | `SizeTypeValues`    | `-`          | **Deprecated**: Since 8.0.0. Будет удалено в **VKUI v10** – используйте `density` ([https://github.com/VKCOM/VKUI/issues/9015](https://github.com/VKCOM/VKUI/issues/9015)).                                                                                                       |
| `viewHeight` | `number`            | `-`          | Тип высоты экрана для адаптивного отображения.                                                                                                                                                                                                                                    |
| `viewWidth`  | `ViewWidthType`     | `-`          | Тип ширины экрана для адаптивного отображения.                                                                                                                                                                                                                                    |

### useAdaptivity

*Не принимает свойств*
