contextmenu/index.html at master · aantthony/contextmenu · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE html>
<html>
<head>
  <link rel='stylesheet' href="contextmenu.css" type="text/css" media="all" />
  <link rel='stylesheet' href="about/bootstrap.min.css" type="text/css" media="all" />
  <link rel='stylesheet' href="about/about.css" type="text/css" media="all" />
  <link rel='stylesheet' href="about/prettify.css" type="text/css" media="all" />
  <title>Contextmenu.js</title>
</head>
<body>
  <a href="http://github.com/aantthony/contextmenu"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub"></a>
  <cmenu type="context" id="samplemenu">
    <menuitem label="New Folder" onclick=""></menuitem>
    <hr />
    <menuitem label="Get Info"></menuitem>
    <hr />
    <menuitem label="Change Desktop Background&hellip;"></menuitem>
    <menuitem label="Clean Up" onclick="alert('source');"></menuitem>
    <cmenu label="Clean Up By">
      <menuitem label="Name"></menuitem>
      <menuitem label="Kind"></menuitem>
      <menuitem label="Date Modified"></menuitem>
    </cmenu>
    <cmenu label="Sort By">
      <menuitem label="Name"></menuitem>
      <menuitem label="Kind"></menuitem>
      <menuitem label="Date Modified"></menuitem>
    </cmenu>
    <menuitem label="Show View Options"></menuitem>
  </cmenu>
  <div class="header">
    <div class="container">
      <h1>ContextMenu</h1>
      <p>Responsive and native-looking javascript right click menu</p>
    </div>
  </div>
  <div class="container page">
    <div class="main">
      <h1>Introduction</h1>
      <div class="row">
        <div class="span6">

      <p style="text-align:justify">
        <u>Contextmenu</u> is a javascript library (with no dependencies) that allows the creation of native-looking right-click menus within a web page.

        Don't use this in an attempt to replace the default context menu (e.g., to prevent Download Linked File As..., Save Image As..) because that is very annoying. The intended use is for creating menus on objects within a page (not the entire page), and for javascript-heavy web apps.
      </p>
        </div>
        <div class="span3" style="margin-left:40px; width: 280px">
          <a class="a" href="download.zip"><button class="btn-download">Download</button></a>
        </div>
      </div>
      <h1>Demo</h1>
      <p>Right click on the text below:</p>
      <blockquote contextmenu="samplemenu">
        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras tempor odio diam. Etiam molestie viverra pellentesque. Donec mi metus, accumsan a varius quis, elementum vel orci. Fusce eget turpis augue. Suspendisse sit amet dictum tellus. Integer dapibus scelerisque velit, nec mollis turpis iaculis id. Nam sed commodo nulla. Proin sagittis molestie purus, non varius est pellentesque malesuada. Duis luctus pretium metus nec euismod. Nullam vehicula felis id libero faucibus sagittis. Nam non leo neque, ut ultricies mauris. Pellentesque a molestie diam. Aliquam erat volutpat. Fusce arcu diam, lobortis et scelerisque a, viverra eu risus.
      </blockquote>
      <h1>Instructions</h1>
      <p>Download the contextmenu.css and contextmenu.js files (above)</p>
      <p>Then in your page, add the following:</p>
      <pre class="prettyprint">
&lt;!DOCTYPE html&gt;
&lt;html&gt;
  &lt;head&gt;
    &lt;link rel="stylesheet" href="contextmenu.css" type="text/css" media="all" /&gt;
    ...
  &lt;/head&gt;
  &lt;body&gt;
    ...
    &lt;script type="text/javascript" src="contextmenu.js"&gt;&lt;/script&gt;
  &lt;/body&gt;
&lt;/html&gt;</pre>
      <p>Either specify the markup using HTML context-menu notation, or use the simple Javascript API provided by the contextmenu object which builds DOM nodes, and adds some javascript to ensure browser compatibility.</p>
      <h2>API Example</h2>
      <div class="row">
        <div class="span5">
      <pre class="prettyprint">
var menu = contextmenu([
  {
    label: "First Item",
    onclick: function (e){
      document.body.style.background = "black";
      setTimeout(function() {
        document.body.style.background = "";
      }, 500);
    }
  },
  {label: "Second Item"},
  {hr : true},
  {
    label: "Sub menu",
    children: [
      {
        label: "Another Item"
      }
    ]
  }
]);

contextmenu.attach(domNode, menu);

contextmenu.show(menu, 300, 200);
</pre>
        </div>
        <div class="span6">
          <pre class="demo-box" id="container">
            <div class="demo-label">
              #container
            </div>
            <input type="button" value="#button1" id="button1" class="btn" />
            <input type="button" value="#button2" id="button2" class="btn" />
          </pre>
          <pre class="prettyprint">
// Hook up an event to launch it
contextmenu.attach($("#button1"), menu);

// Or show it manually
$("#button2").click(function (e) {
  contextmenu.show(menu, e.target);
  // contextmenu.show(menu, e.x, e.y);
});

// Right click the container
contextmenu.attach($("#container"), another_menu);
</pre>
<div class="padding: 8.5px">
<h1>Check out the code</h1>
<p>The code is <a href="http://github.com/aantthony/contextmenu">available on GitHub</a>. Please contribute.</p>
<h1>Share on Twitter!</h1>
<a href="https://twitter.com/share" class="twitter-share-button" data-via="aantthony" data-size="large" data-related="aantthony">Tweet</a>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
</div>
        </div>
      </div>
      <h2>Detailed Example</h2>
      <div class="row">
        <div class="span5">
          Javascript API equivalent
          <pre class="prettyprint">
var menu = contextmenu([
  {label: "Standard"},
  {hr: true},
  {label: "Checkbox", checked: true},
  {label: "Key", key: "\u2318A"}
]);
contextmenu.attach($("#id"), menu);
</pre>
<p>This will work independently of whether executed before or after the page loads.</p>
        </div>
        <div class="span6">
          HTML notation: (direct child of body)
          <pre class="prettyprint">
&lt;cmenu type="context" id="menu"&gt;
  &lt;menuitem label="Standard"&gt;&lt;/menuitem&gt;
  &lt;hr /&gt;
  &lt;menuitem label="Checkbox" checked="checked"&gt;&lt;/menuitem&gt;
  &lt;menuitem label="Key" key="&amp;#8984;A"&gt;&lt;/menuitem&gt;
&lt;/cmenu&gt;</pre>
        <p>If the html node is generated after the page load, then call <code class="prettyprint">contextmenu.prepare($("#menu"));</code> and use <code class="prettyprint">contextmenu.attach</code> when needed.
        </div>
      </div>
      <menu type="context" id="menu">
        <menuitem label="Standard"></menuitem>
      </menu>
      <pre class="demo-box" contextmenu="menu" id="d2">
        <div class="demo-label">&lt;div contextmenu="menu" id="id" /&gt;</div>
        <input type="button" class="btn" value="Test" style="visibility: hidden" />
      </pre>
      <h2>Apps using Contextmenu.js</h2>
      <a href="http://graph.tk/">Graph.tk</a>
      <h1>License</h1>
        <p>MIT</p>
    </div>
  </div>
  <div class="container footer">
    <div class="main">
      Copyright &copy; 2012 <a href="http://twitter.com/aantthony/" title="Follow me on Twitter">@aantthony</a></div>
  </div>

  <script type="text/javascript" src="about/prettify.js"></script>
  <script type="text/javascript" src="contextmenu.js"></script>
  <script type="text/javascript">
  (function(){
    prettyPrint();
    var menu = contextmenu([
      {
        label: "First Item",
        onclick: function (e){
          document.body.style.background = "black";
          setTimeout(function() {
            document.body.style.background = "";
          }, 500);
        }
      },
      {label: "Second Item"},
      {hr: true},
      {
        label: "Sub menu",
        children: [
          {
            label: "Another Item"
          }
        ]
      }
    ]);
    var another_menu = contextmenu([
      {
        label: "New Item",
        onclick: function (e){
          var input = document.createElement("input");
          input.value = "Extra button";
          input.className = "btn";
          input.type = "button";
          var container = document.getElementById("container");
          container.appendChild(input)
          setTimeout(function (){
            container.removeChild(input);
          },3000);
        }
      },
      {
        hr: true
      },
      {
        label: "Share\u2026",
        children: [
          {
            label: "Twitter"
          }
        ]
      }
    ]);

    contextmenu.attach(document.getElementById("button1"), menu);

    document.getElementById("button2").addEventListener("click", function(e){
      contextmenu.show(menu, e.target);
    });
    contextmenu.attach(document.getElementById("container"), another_menu);
  }())
  </script>
</body>
</html>