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

update readme #7

Merged
merged 1 commit into from
Feb 26, 2025
Merged

update readme #7

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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,20 @@ export default function App() {
- **allowedPlacements** - array of allowed placements `-'auto' | 'auto-start' | 'auto-end' | 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'`
- **offset** - distance in pixels from highlighted words. `10`
- **zIndex** - zIndex of the popover `999999999`

## Customization

- **withoutStyles** - if true, the menu will be only styled with props that help it to function. And we the following classnames can be targeted for styling:
- `.rhm-popover` - for the popover element
- `.rhm-menu` - for the menu element
- `.rhm-button` - for the button element
- `.rhm-arrow` - for the arrow element
- `.rhm-anchor` - for the anchor element
- **classNames** - an object where classnames can be passed to the menu, popover, and arrow elements.
- `menu` - for the menu element
- `popover` - for the popover element
- `arrow` - for the arrow element

## These classnames are also available for styling as well

- `.rhm-popover` - for the popover element
- `.rhm-menu` - for the menu element
- `.rhm-button` - for the button element
- `.rhm-arrow` - for the arrow element
- `.rhm-anchor` - for the anchor element

## Development

```bash
Expand Down