Giter VIP home page Giter VIP logo

rctx-contextmenu's Introduction

NPM Badge

Note: rctx-contextmenu Supports React 16.8 and above versions because this plugin solely uses React Hooks.

rctx-contextmenu

Context menu plugin for React. Live Demo | Example Code

RCTX Contextmenu

The problem ๐Ÿ˜ฏ

There are lot of times when you want to customize the right click menu or Context Menu. May be you want to add more customized options or even sub options with same look and feel how a native context menu gives.

The solution ๐Ÿ˜„

rctx-contextmenu gives that flexibility to customize Context Menu. You can add options, sub-options with exactly the look and feel how you get when you use the native Context Menu.

Key features

  • Append to anywhere you want
  • Customize styling like however you want
  • In-built animation
  • Extensive list of APIs
  • Dynamically add/remove menus

Browser Support

  • IE 11 and Edge >= 12
  • FireFox >= 38
  • Chrome >= 47

Table of contents

Installation

npm install --save rctx-contextmenu

Sample Usage

import React from 'react';
import { ContextMenuTrigger, ContextMenu, ContextMenuItem } from 'rctx-contextmenu';

function App() {
  return (
    <div className="app">
      <ContextMenuTrigger
        id="my-context-menu-1"
      >
        <div className="box">
          Right Click On Me
        </div>
      </ContextMenuTrigger>

      <ContextMenu id="my-context-menu-1">
        <ContextMenuItem>Menu Item 1</ContextMenuItem>
        <ContextMenuItem>Menu Item 2</ContextMenuItem>
        <ContextMenuItem>Menu Item 3</ContextMenuItem>
        <ContextMenuItem>Menu Item 4</ContextMenuItem>
      </ContextMenu>
    </div>
  );
}

export default App;

Full example usage

<ContextMenu
  id="my-contextmenu"
  appendTo="body"
  animation="zoom"
  hideOnLeave={false}
  preventHideOnScroll={true}
  preventHideOnResize={true}
  attributes={{
    'aria-label': 'Some text',
    'aria-labelledby': 'Some text'
  }}
  className="my-context-menu"
  onMouseLeave={() => console.log('Mouse left')}
  onShow={() => console.log('I am visible!')}
  onHide={() => console.log('I am hidden!')}
/>
<ContextMenuItem
  disabled={true}
  preventClose={false}
  attributes={{
    'aria-label': 'Some text',
    'aria-labelledby': 'Some text'
  }}
  className="my-context-menu-item"
  onClick={() => console.log("I'm clicked!")}
/>
<ContextMenuTrigger
  id="my-contextmenu"
  disable={false}
  disableWhileShiftPressed={true}
  attributes={{
    'aria-label': 'Some text',
    'aria-labelledby': 'Some text'
  }}
  className="my-context-menu-trigger"
/>
<Submenu
  title="My submenu"
  attributes={{
    'aria-label': 'Some text',
    'aria-labelledby': 'Some text'
  }}
  className="my-context-menu-submenu"
/>

Live Demo

Live demo is available here.

Example Code

Example code is available here.

APIs

<ContextMenu />

Name Type Options Description
id String Should be a string. `ContextMenu` and `ContextMenuTrigger` id should match.
appendTo String Should be a string which contains element selector like body / #id / .class . Default: Enclosed element Append context menu inside required element.
animation String Enums: fade | zoom | pop | toTopLeft | rightToLeft Make the contextmenu visible in animated way.
hideOnLeave Boolean true / false. Default: false Hide contextmenu on blur or mouseOut.
attributes Object - Add additional attributes to the element.
className String - Additional classes.
preventHideOnResize Boolean true / false. Default: false Prevent hiding contextmenu from hiding on window resize.
preventHideOnScroll Boolean true / false. Default: false Prevent hiding contextmenu from hiding on scroll.
onShow Function () => {} Trigger this event when Context Menu is visible.
onHide Function () => {} Trigger this event when Context Menu is hidden.
onMouseLeave Function () => {} Invoke onMouseLeave on blur or mouseOut.

<ContextMenuItem />

Name Type Options Description
disabled Boolean true / False . Default False Disable menu item.
preventClose Boolean true / False . Default False Context menu is closed as soon as an item is clicked.
disableWhileShiftPressed Boolean true / false. Default: false Open browser default contextmenu if shift pressed while right click on trigger element.
attributes Object - Add additional attributes to the element.
className String - Additional classes.
onClick Function () => {} Fire onClick event.

<ContextMenuTrigger />

Name Type Options Description
id String Should be a string. `ContextMenu` and `ContextMenuTrigger` id should match.
attributes Object - Add additional attributes to the element.
disable true / false. Default: false false Disable contextmenu and open browser default contextmenu.
className String - Additional classes.

<Submenu />

Name Type Options Description
title String Should be a string. Title for the Submenu.
attributes Object - Add additional attributes to the element.
className String - Additional classes.

Styling

Styling is totally up to you. You can use CSS or even SCSS to customize the styling part. Below are the classes you can consider for styling

  • menu-trigger (Right click area wrapper)
  • contextmenu (The Context Menu)
  • contextmenu__item (Each Context Menu item)
  • contextmenu__item--disabled (Context Menu item)
  • submenu (Context Submenu)
  • submenu__item (Context Submenu item)

Contributions ๐Ÿ™

Any kind of contribution would be much appreciated. It could be small change in the doc or even any kind of advice. You can create issues if you feel any feature which is missing which solves bigger problems.

Develop locally

First clone the repo

git clone https://github.com/reachtokish/rctx-contextmenu.git

Navigate inside rctx-contextmenu folder

cd rctx-contextmenu

Install dependencies

npm install

Then start server to run it locally

npm start

Now app should run on localhost:1234

Design inspiration Khalid Hasan Zibon / Dribble

License

MIT License

rctx-contextmenu's People

Contributors

reachtokish avatar node-kishore avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.