Skip to content

Commit

Permalink
docs: use relative links (#6339)
Browse files Browse the repository at this point in the history
Поиском по документации обнаружила, что у нас много где используются абсолютные ссылки. Поменяла их на относительные.
  • Loading branch information
eugpoloz authored Dec 29, 2023
1 parent ff5ec67 commit 12e4e67
Show file tree
Hide file tree
Showing 22 changed files with 51 additions and 54 deletions.
2 changes: 1 addition & 1 deletion packages/vkui/src/components/ActionSheet/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ActionSheet – имитация [нативного компонента](https
коллекцию `ActionSheetItem`.
На больших экранах прокрутка не отключается.

Передаётся в качестве значения свойства `popout` компонента [`SplitLayout`](https://vkcom.github.io/VKUI/#/SplitLayout).
Передаётся в качестве значения свойства `popout` компонента [`SplitLayout`](#/SplitLayout).

> **Важно**
>
Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/Alert/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Передаётся в качестве значения свойства `popout` компонента [`SplitLayout`](https://vkcom.github.io/VKUI/#/SplitLayout).
Передаётся в качестве значения свойства `popout` компонента [`SplitLayout`](#/SplitLayout).

В Алертах особое внимание нужно уделить кнопкам. Всего есть три типа кнопок:
`cancel`, `destructive` и `default`.
Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/AppRoot/Readme.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Обязательный компонент-обёртка над приложением. В нём инкапсулирована логика [режимов подключения](https://vkcom.github.io/VKUI/#/Modes).
Обязательный компонент-обёртка над приложением. В нём инкапсулирована логика [режимов подключения](#/Modes).
2 changes: 1 addition & 1 deletion packages/vkui/src/components/Avatar/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Для лучшего отображения, используйте длину текста <b>не более 2 символов</b>.
- Для динамического определения градиента под пользователя используйте функцию
[`calcInitialsAvatarColor`](https://vkcom.github.io/VKUI/#/Utils). Генерирует по формуле `user_id % 6 + 1`. Например,
[`calcInitialsAvatarColor`](#/Utils). Генерирует по формуле `user_id % 6 + 1`. Например,
у пользователя с `user_id` 106 будет 5-й (`l-blue`) цвет градиента.

```jsx
Expand Down
8 changes: 4 additions & 4 deletions packages/vkui/src/components/ConfigProvider/Readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Компонент для прокидывания конфига приложению. Помимо прочего, отвечает за установку [темы и платформы](https://vkcom.github.io/VKUI/#/PlatformsAndThemes).
Компонент для прокидывания конфига приложению. Помимо прочего, отвечает за установку [темы и платформы](#/PlatformsAndThemes).

> **Важно**
>
> Обратите внимание, что в вашем приложении должен быть только один ConfigProvider. Если вам необходимо
> переопределить какой-то из параметров, то это можно сделать с помощью [PlatformProvider](https://vkcom.github.io/VKUI/#/PlatformProvider),
> [AppearanceProvider](https://vkcom.github.io/VKUI/#/AppearanceProvider) или [LocaleProvider](https://vkcom.github.io/VKUI/#/LocaleProvider)
> Обратите внимание, что в вашем приложении должен быть только один `ConfigProvider`. Если вам необходимо
> переопределить какой-то из параметров, то это можно сделать с помощью [`PlatformProvider`](#/PlatformProvider),
> [`AppearanceProvider`](#/AppearanceProvider) или [`LocaleProvider`](#/LocaleProvider)
2 changes: 1 addition & 1 deletion packages/vkui/src/components/FormField/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Компонент-оболочка для элементов форм ([Input](https://vkcom.github.io/VKUI/#/Input), [Select](https://vkcom.github.io/VKUI/#/Select), [Textarea](https://vkcom.github.io/VKUI/#/Textarea) и другие).
Компонент-оболочка для элементов форм ([`Input`](#/Input), [`Select`](#/Select), [`Textarea`](#/Textarea) и другие).

```jsx
const Example = () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/ModalCardBase/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Низкоуровневый компонент для отрисовки карточки со сложным содержимым. Используется внутри [ModalCard](https://vkcom.github.io/VKUI/#/ModalCard).
Низкоуровневый компонент для отрисовки карточки со сложным содержимым. Используется внутри [`ModalCard`](#/ModalCard).

```jsx { "props": { "layout": false, "iframe": false } }
<div style={{ margin: 20 }}>
Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/ModalRoot/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Структура

Этот компонент должен быть передан в качестве свойства `modal` компоненту [`SplitLayout`](https://vkcom.github.io/VKUI/#/SplitLayout).
Этот компонент должен быть передан в качестве свойства `modal` компоненту [`SplitLayout`](#/SplitLayout).

> ⚠️ Структура модальных страниц и карточек должна определяться единожды на старте приложения. Структура – это _декларация_ приложения.
> То есть, один раз определив структуру вида:
Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/OnboardingTooltip/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
пользователю хочется представить новый функционал. Это достаточно сложный с точки зрения управления
компонент, поэтому он требует подробной документации.

Для показа тултипа по ховеру, воспользуйтесь [`Tooltip`](https://vkcom.github.io/VKUI/#/Tooltip).
Для показа тултипа по ховеру воспользуйтесь [`Tooltip`](#/Tooltip).

### Концепция

Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/PanelSpinner/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Компонент-обёртка над [`<Spinner />`](https://vkcom.github.io/VKUI/#/Spinner) с заданными отступами и размером. Удобно использовать его во время загрузки данных.
Компонент-обёртка над [`Spinner`](#/Spinner) с заданными отступами и размером. Удобно использовать его во время загрузки данных.

## Цифровая доступность (a11y)

Expand Down
6 changes: 3 additions & 3 deletions packages/vkui/src/components/ScreenSpinner/Readme.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Компонент-обертка над [`<Spinner />`](https://vkcom.github.io/VKUI/#/Spinner). Используется в случаях, когда требуется заблокировать интерфейс до завершения асинхронного процесса.
Компонент-обертка над [`Spinner`](#/Spinner). Используется в случаях, когда требуется заблокировать интерфейс до завершения асинхронного процесса.

Передаётся в качестве значения свойства `popout` компонента [`SplitLayout`](https://vkcom.github.io/VKUI/#/SplitLayout).
Передаётся в качестве значения свойства `popout` компонента [`SplitLayout`](#/SplitLayout).

<br/>
## Цифровая доступность (a11y)

Чтобы уведомить о выполнении асинхронного процесса пользователей скринридеров, проставьте на [`SplitLayout`](https://vkcom.github.io/VKUI/#/SplitLayout), в котором выполняется процесс, метки [`aria-busy`](https://doka.guide/a11y/aria-busy/) и [`aria-live`](https://doka.guide/a11y/aria-live/).
Чтобы уведомить о выполнении асинхронного процесса пользователей скринридеров, проставьте на [`SplitLayout`](#/SplitLayout), в котором выполняется процесс, метки [`aria-busy`](https://doka.guide/a11y/aria-busy/) и [`aria-live`](https://doka.guide/a11y/aria-live/).

Чтобы заменить текст, который прочитает скринридер, передайте его в `children`. Он будет скрыт визуально, но останется доступным для ассистивных технологий.

Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/Spinner/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Используется для визуализации выполнения асинхронного процесса (например, ajax-запроса). Если вы хотите заблокировать интерфейс на момент загрузки, используйте [ScreenSpinner](https://vkcom.github.io/VKUI/#/ScreenSpinner).
Используется для визуализации выполнения асинхронного процесса (например, ajax-запроса). Если вы хотите заблокировать интерфейс на момент загрузки, используйте [`ScreenSpinner`](#/ScreenSpinner).

## Цифровая доступность (a11y)

Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/SubnavigationButton/Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Компонент, используемый в качестве кнопок в [SubnavigationBar](https://vkcom.github.io/VKUI/#/SubnavigationBar).
Компонент, используемый в качестве кнопок в [`SubnavigationBar`](#/SubnavigationBar).

Этот компонент может использоваться:

Expand Down
2 changes: 1 addition & 1 deletion packages/vkui/src/components/TabsItem/Readme.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Элемент компонента [`Tabs`](https://vkcom.github.io/VKUI/#/Tabs). Наследует `mode` из контекста `Tabs`.
Элемент компонента [`Tabs`](#/Tabs). Наследует `mode` из контекста `Tabs`.
4 changes: 2 additions & 2 deletions packages/vkui/src/components/Tappable/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

- вид курсора
- цвет фона в зависимости от состояния
- ripple-эффект при нажатии, если это платформа `ANDROID`
- <a href="{{anchor}}">ripple-эффект</a> при нажатии, если это платформа `ANDROID`

Используется внутри всех контролов. Например, [Button](https://vkcom.github.io/VKUI/#/Button), [Cell](https://vkcom.github.io/VKUI/#/Cell), [ActionSheetItem](https://vkcom.github.io/VKUI/#/ActionSheetItem) и т.п.
Используется внутри всех контролов. Например, [`Button`](#/Button), [`Cell`](#/Cell), [`ActionSheetItem`](#/ActionSheetItem) и т.п.

```jsx { "props": { "layout": false, "iframe": false } }
const Example = () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/vkui/src/components/TooltipBase/Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Низкоуровневый компонент для отрисовки тултипа.

Используется внутри [Tooltip](https://vkcom.github.io/VKUI/#/Tooltip).
Примеры использования и `Readme` можно найти в документации и коде компонента [Tooltip](https://vkcom.github.io/VKUI/#/Tooltip).
Используется внутри [Tooltip](#/Tooltip).
Примеры использования и `Readme` можно найти в документации и коде компонента [Tooltip](#/Tooltip).

Отрисовка `ArrowIcon`, позиционирование необходимо реализовывать c использованием библиотеки `floating` (lib/floating).
4 changes: 2 additions & 2 deletions styleguide/pages/adaptivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
От наличия мышки, высоты и ширины экрана зависит отображение кнопок, элементов форм и так далее.
В этой статье мы разберём, как сделать ваш интерфейс отзывчивым.

Для начала, нужно обернуть ваше приложение в [`AdaptivityProvider`](https://vkcom.github.io/VKUI/#/AdaptivityProvider).
Для начала оберните ваше приложение в [`AdaptivityProvider`](#/AdaptivityProvider).

> **Важно**
>
Expand All @@ -30,7 +30,7 @@ const root = createRoot(container); // createRoot(container!) if you use TypeScr
root.render(<App />);
```

Далее, нужно добавить [`SplitLayout`](https://vkcom.github.io/VKUI/#/SplitLayout) и хотя бы один [`SplitCol`](https://vkcom.github.io/VKUI/#/SplitCol).
Добавьте [`SplitLayout`](#/SplitLayout) и хотя бы один [`SplitCol`](#/SplitCol).

- `SplitLayout` — компонент-обертка для отрисовки макета с одной или несколькими колонками.
- `SplitCol` — компонент для отрисовки колонки.
Expand Down
2 changes: 1 addition & 1 deletion styleguide/pages/html.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ VKUI поддерживает 3 режима использования:
- `embedded` — встраивание VKUI приложения в существующее приложение
- `partial` — UI компоненты используются в существующем приложении без лаяут компонентов

Для примеров и полного описания режимов, см. [Режимы подключения](https://vkcom.github.io/VKUI/#/Режимы%20подключения).
Примеры и полное описание режимов — на странице [Режимы подключения](#/Modes).
30 changes: 15 additions & 15 deletions styleguide/pages/integrations_vk_mini_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@

## Конфигурация VKUI

> Советуем использовать шаблон [@vkontakte/create-vk-mini-app](https://github.com/VKCOM/create-vk-mini-app).
> Советуем использовать шаблон [`@vkontakte/create-vk-mini-app`](https://github.com/VKCOM/create-vk-mini-app).
> В нем конфигурация, описанная ниже, есть по умолчанию.
Для начала устанавливаем библиотеки:

- [@vkontakte/vk-bridge](https://www.npmjs.com/package/@vkontakte/vk-bridge) **>= 2.9.0**
- [@vkontakte/vk-bridge-react](https://www.npmjs.com/package/@vkontakte/vk-bridge) **>= 1.0.0**
- [`@vkontakte/vk-bridge`](https://www.npmjs.com/package/@vkontakte/vk-bridge) **>= 2.9.0**
- [`@vkontakte/vk-bridge-react`](https://www.npmjs.com/package/@vkontakte/vk-bridge) **>= 1.0.0**

```sh
# для примера используется пакетный менеджер yarn
yarn add @vkontakte/vk-bridge @vkontakte/vk-bridge-react
```

Далее подписываемся на изменения из **VK Bridge**. Для этого используем готовые хуки из
[@vkontakte/vk-bridge-react](https://www.npmjs.com/package/@vkontakte/vk-bridge).
[`@vkontakte/vk-bridge-react`](https://www.npmjs.com/package/@vkontakte/vk-bridge).

```tsx static
import * as React from 'react';
Expand Down Expand Up @@ -104,34 +104,34 @@ export const transformVKBridgeAdaptivity = ({

## Навигация

### [PanelHeader](https://vkcom.github.io/VKUI/#/PanelHeader)
### [`PanelHeader`](#/PanelHeader)

Мини-приложению доступна почти вся площадь экрана, поэтому для корректной работы навигации
необходимо использовать компонент [PanelHeader](https://vkcom.github.io/VKUI/#/PanelHeader) на каждом
необходимо использовать компонент [`PanelHeader`](#/PanelHeader) на каждом
экране приложения. Он должен содержать название приложения и значок **Назад** (см.
[PanelHeaderBack](https://vkcom.github.io/VKUI/#/PanelHeaderBack)) на тех экранах, где тот
[`PanelHeaderBack`](#/PanelHeaderBack)) на тех экранах, где тот
требуется.

> _Правый верхний угол_ [PanelHeader](https://vkcom.github.io/VKUI/#/PanelHeader) зарезервирован для
> _Правый верхний угол_ [`PanelHeader`](#/PanelHeader) зарезервирован для
> нативного бара с кнопками управления мини-приложением, поэтому не рекомендуем использовать
> параметр `after`.
>
> Чтобы автоматически скрывать `after` у [PanelHeader](https://vkcom.github.io/VKUI/#/PanelHeader),
> в [ConfigProvider](https://vkcom.github.io/VKUI/#/ConfigProvider) есть параметр
> Чтобы автоматически скрывать `after` у [`PanelHeader`](#/PanelHeader),
> в [`ConfigProvider`](#/ConfigProvider) есть параметр
> `hasCustomPanelHeaderAfter`.
### [View](https://vkcom.github.io/VKUI/#/View)
### [`View`](#/View)

На стартовой странице мини-приложения вы должны включить свайпбек нативного клиента, чтобы
пользователь смог выйти из мини-приложения. Для этого нужно вызывать определенные методы
**VK Bridge** в зависимости от типа мини-приложения:

- Если вы делаете _стандартное_ мини-приложение ВКонтакте, то при переходах отправляйте
[VKWebAppSetSwipeSettings](https://dev.vk.com/bridge/VKWebAppSetSwipeSettings) с `history: true`
[`VKWebAppSetSwipeSettings`](https://dev.vk.com/bridge/VKWebAppSetSwipeSettings) с `history: true`
на первой панели и `history: false` на других.
- Если вы делаете _внутреннее_ мини-приложения ВКонтакте, то отправляйте событие
[VKWebAppEnableSwipeBack](https://dev.vk.com/bridge/VKWebAppEnableSwipeBack) при переходе на
первую панель и событие [VKWebAppDisableSwipeBack](https://dev.vk.com/bridge/VKWebAppDisableSwipeBack)
[`VKWebAppEnableSwipeBack`](https://dev.vk.com/bridge/VKWebAppEnableSwipeBack) при переходе на
первую панель и событие [`VKWebAppDisableSwipeBack`](https://dev.vk.com/bridge/VKWebAppDisableSwipeBack)
при переходе на любую другую.

```tsx static
Expand Down Expand Up @@ -182,7 +182,7 @@ const SomeViews = () => {
функцию `runTapticImpactOccurred`, которая отправляет событие [VKWebAppTapticImpactOccurred](https://dev.vk.com/bridge/VKWebAppTapticImpactOccurred),
как раз заранее проверяя, что возможность вызова вибрации доступна на устройстве.

Виброотликом можно воспользоваться, например, при использовании компонента [PullToRefresh](https://vkcom.github.io/VKUI/#/PullToRefresh)
Виброотликом можно воспользоваться, например, при использовании компонента [`PullToRefresh`](#/PullToRefresh)
на `onRefresh`.

```tsx static
Expand Down
Loading

0 comments on commit 12e4e67

Please sign in to comment.