Skip to content

docs(HelpMark): improved the README description, removing outdatae li… #2439

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(HelpMark): improved the README description, removing outdatae li… #2439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions src/components/HelpMark/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@
import {HelpMark} from '@gravity-ui/uikit';
```

Component to display help icon with popover
A help icon that reveals contextual information in a popover on hover or click. Ideal for showing tips, explanations, or supporting content without taking up extra space in the interface.

## Examples

Component with rendered raw html and close on mouse leave:

<!--LANDING_BLOCK

Expand Down Expand Up @@ -56,7 +55,8 @@ LANDING_BLOCK-->

`HelpMark` accepts any valid `button` element props in addition to these:

| Name | Description | Type | Default |
| :----------- | :----------------------- | :----------------------: | :-----: |
| iconSize | Sets icon size | `"s"` `"m"` `"l"` `"xl"` | `"m"` |
| popoverProps | Override `Popover` props | `PopoverProps` | |
| Name | Description | Type | Default |
| :----------- | :--------------------------------- | :----------------------: | :-----: |
| iconSize | Sets icon size | `"s"` `"m"` `"l"` `"xl"` | `"m"` |
| popoverProps | Override `Popover` props | `PopoverProps` | |
| children | Content displayed inside the popover | `React.ReactNode` | |
Loading