Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme corrections from localization #1933

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

docs: readme corrections from localization #1933

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d4aef0c
fix: a lot of readme corrections from localization
vvtimofeev Nov 1, 2024
414f8aa
fix: correction from Ruminat
vvtimofeev Nov 2, 2024
944feca
fix: raubzeug comment
vvtimofeev Nov 2, 2024
30c5ac7
fix: raubzeg comments 2
vvtimofeev Nov 2, 2024
cb220f9
fix: marginy605 comment
vvtimofeev Nov 2, 2024
59ee05c
fix: marginy605 comments
vvtimofeev Nov 2, 2024
69185fe
fix: marginy605 comments
vvtimofeev Nov 2, 2024
f2bcb12
fix: fixed loc folder structure
vvtimofeev Nov 7, 2024
576d130
fix: fixed error in breakpoint word
vvtimofeev Nov 8, 2024
8871b03
fix: add new version of slider component documentation
vvtimofeev Nov 25, 2024
f24edcb
fix: fixed article near slider
vvtimofeev Nov 29, 2024
bad9304
fix: breadcrumbs doc fixes
vvtimofeev Dec 3, 2024
0286477
Merge branch 'main' of https://github.com/gravity-ui/uikit into timof…
vvtimofeev Dec 5, 2024
963119a
Merge branch 'main' into timofeyevvv/readme_corrections_from_loc_team
vvtimofeev Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/components/ActionTooltip/README-ru.md
View file
Open in desktop
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
Open in desktop
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
Loading