Skip to content

Commit

Permalink
docs: readme corrections from localization (#1933)
Browse files Browse the repository at this point in the history
  • Loading branch information
@vvtimofeev
vvtimofeev authored Dec 19, 2024
1 parent 26d1609 commit 498b620
Show file tree
Hide file tree
Showing 105 changed files with 11,459 additions and 1,222 deletions.
34 changes: 34 additions & 0 deletions src/components/ActionTooltip/README-ru.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!--GITHUB_BLOCK-->

# ActionTooltip

<!--/GITHUB_BLOCK-->

`ActionTooltip` — это простая текстовая подсказка, использующая в качестве якоря дочерний элемент. Для правильной работы элемент-якорь должен поддерживать события мыши и события получения или потери фокуса.

## Использование

```tsx
import {ActionTooltip} from '@gravity-ui/uikit';

<ActionTooltip title="Content">
<div tabIndex={0}>Anchor</div>
</ActionTooltip>;
```

## Свойства

| Имя | Описание | Тип | Значение по умолчанию |
| :--------------- | ------------------------------------------------------------------------------------------ | :----------------------------------------------: | :-------------------: |
| children | Элемент-якорь для `Tooltip`. Должен принимать `ref` для передачи DOM-элемента. | `React.ReactElement` | |
| closeDelay | Время задержки в миллисекундах перед скрытием `Tooltip` после увода курсора с элемента. | `number` | `0` |
| openDelay | Время задержки в миллисекундах перед показом `Tooltip` после наведения курсора на элемент. | `number` | `250` |
| placement | Положение `Tooltip` относительно якоря. | [`PopupPlacement`](../Popup/README.md#placement) | |
| qa | HTML-атрибут `data-qa`, используется для тестирования. | `string` | |
| title | Текст заголовка для тултипа. | `string` | |
| description | Текст описания в тултипе. | `string` | |
| hotkey | Горячие клавиши, назначенные на действие в интерфейсе. | `string` | |
| id | Используется для реализации логики доступности. | `string` | |
| disablePortal | Отключает использование `Portal` для дочерних элементов. | `boolean` | |
| contentClassName | HTML-атрибут `class` для узла с содержимым. | `string` | |
| disabled | Блокирует открытие всплывающего окна. | `boolean` | `false` |
19 changes: 9 additions & 10 deletions src/components/ActionTooltip/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

<!--/GITHUB_BLOCK-->

A simple text tip that uses its children node as an anchor. For correct functioning, the anchor node
must be able to handle mouse events and focus or blur events.
This is a simple text tip that uses its child node as an anchor. To work correctly, the anchor node must be able to handle mouse events and focus or blur events.

## Usage

Expand All @@ -21,15 +20,15 @@ import {ActionTooltip} from '@gravity-ui/uikit';

| Name | Description | Type | Default |
| :--------------- | --------------------------------------------------------------------------------------- | :----------------------------------------------: | :-----: |
| children | An anchor element for a `Tooltip`. Must accept a `ref` that will provide a DOM element. | `React.ReactElement` | |
| children | Anchor element for a `Tooltip`. It must accept a `ref` that will provide a DOM element. | `React.ReactElement` | |
| closeDelay | Number of ms to delay hiding the `Tooltip` after the hover ends | `number` | `0` |
| openDelay | Number of ms to delay showing the `Tooltip` after the hover begins | `number` | `250` |
| openDelay | Number of ms to delay showing the `Tooltip` once the hover starts | `number` | `250` |
| placement | `Tooltip` position relative to its anchor | [`PopupPlacement`](../Popup/README.md#placement) | |
| qa | HTML `data-qa` attribute, used in tests | `string` | |
| qa | `data-qa` HTML attribute, used for testing | `string` | |
| title | Tooltip title text | `string` | |
| description | Tooltip description text | `string` | |
| hotkey | Hot keys that are assigned to an interface action. | `string` | |
| id | This prop is used to help implement the accessibility logic. | `string` | |
| disablePortal | Do not use Portal for children | `boolean` | |
| contentClassName | HTML class attribute for content node | `string` | |
| disabled | Prevent popup from opening | `boolean` | `false` |
| hotkey | Hotkeys assigned to an interface action | `string` | |
| id | Used for implementing the accessibility logic | `string` | |
| disablePortal | Disables using Portal for children | `boolean` | |
| contentClassName | HTML class attribute for the content node | `string` | |
| disabled | Prevents the popup from opening | `boolean` | `false` |
Loading

0 comments on commit 498b620

Please sign in to comment.