Skip to content

Commit 811f496

Browse files
committed
Add readme
1 parent 71e995d commit 811f496

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
React Context Menu Wrapper
2+
======
3+
This library provides a simple wrapper for your context menus. It handles user interaction on desktop and mobile
4+
devices, and guarantees correct context menu positioning.
5+
6+
In an effort to stay unopinionated, this library does not provide any styling or additional components. It is up to you
7+
define your own styles and logic for the menu. This is useful when your CSS framework already provides dropdown menu
8+
styling (e.g. [Bulma](https://bulma.io/), [Bootstrap](https://getbootstrap.com/)) or when you need to implement some
9+
non-trivial logic for your context menu (e.g. [Ogma context menus](https://github.com/TimboKZ/Ogma) with tagging
10+
support).
11+
12+
Preview
13+
------
14+
15+
16+
Contributing
17+
------
18+
Please enable [ESLint](https://eslint.org/docs/user-guide/integrations) and
19+
[Prettier](https://prettier.io/docs/en/editors.html) integration in your editor, and use the provided configs.
20+

0 commit comments

Comments
 (0)