Components Overlays

Context menu

Offer contextual actions for a specific item with a pointer or a keyboard.

Live previewGo + JavaScript
Press proof 04

Right-click this proof or use the Actions button.

Usage

Right-click the target, use Shift+F10, or open Actions. Arrow keys move through commands and Escape restores focus. Listen for mono:action and use detail.value to run the command in your application.

Register context-menu with Head and pass its properties to Render. Go setup guide

Go usage
Go usage
err := mono.UI.Render(w, "context-menu", mono.Props{
	"Description": "Right-click this proof or use the Actions button.",
	"Items": []any{
		map[string]any{
			"Label": "Mark for review",
			"Value": "review",
		},
		map[string]any{
			"Label": "Approve proof",
			"Value": "approve",
		},
		map[string]any{
			"Label": "Add to archive",
			"Value": "archive",
		},
	},
	"Label":   "Proof actions",
	"Title":   "Press proof 04",
	"Trigger": "Actions",
})
Rendered HTML
Rendered HTML
<div id="demo-context-menu" data-mono="context-menu" class="mu-stack">
  <div data-target class="mu-card" tabindex="0" aria-haspopup="menu" aria-controls="demo-context-menu-menu">
    <strong class="mu-title">Press proof 04</strong><p class="mu-muted">Right-click this proof or use the Actions button.</p>
  </div>
  <button type="button" class="mu-btn" data-open aria-haspopup="menu" aria-expanded="false" aria-controls="demo-context-menu-menu" popovertarget="demo-context-menu-menu">Actions</button>
  <div id="demo-context-menu-menu" role="menu" aria-label="Proof actions" popover class="mu-panel">
    <button type="button" class="mu-item" tabindex="-1" role="menuitem" data-value="review">Mark for review</button><button type="button" class="mu-item" tabindex="-1" role="menuitem" data-value="approve">Approve proof</button><button type="button" class="mu-item" tabindex="-1" role="menuitem" data-value="archive">Add to archive</button>
  </div>
  <p data-result class="mu-small" role="status"></p>
</div>
Go template
Go template
<div id="{{.ID}}" data-mono="context-menu" class="mu-stack">
  <div data-target class="mu-card" tabindex="0" aria-haspopup="menu" aria-controls="{{.ID}}-menu">
    <strong class="mu-title">{{.Title}}</strong><p class="mu-muted">{{.Description}}</p>
  </div>
  <button type="button" class="mu-btn" data-open aria-haspopup="menu" aria-expanded="false" aria-controls="{{.ID}}-menu" popovertarget="{{.ID}}-menu">{{.Trigger}}</button>
  <div id="{{.ID}}-menu" role="menu" aria-label="{{.Label}}" popover class="mu-panel">
    {{range .Items}}<button type="button" class="mu-item" tabindex="-1" role="menuitem" data-value="{{.Value}}"{{if .Disabled}} disabled{{end}}>{{.Label}}</button>{{end}}
  </div>
  <p data-result class="mu-small" role="status"></p>
</div>
Component CSS
Component CSS
[data-mono="context-menu"] [role="menu"] { inset: auto; position: fixed; margin: 0; padding: .3rem; min-width: 11rem; max-width: calc(100vw - 1rem); max-height: calc(100dvh - 1rem); overflow: auto; background: white; color: #171717; border: 1px solid #c5c5c5; border-radius: .45rem; box-shadow: 0 .55rem 1.75rem #0002; }
[data-mono="context-menu"] [role="menu"] button { display: block; width: 100%; padding: .5rem .65rem; text-align: start; border-radius: .22rem; background: transparent; color: inherit; }
[data-mono="context-menu"] [role="menu"] button:focus { background: #eee; outline: 1px solid #777; outline-offset: -1px; }
[data-mono="context-menu"] > button { align-self: flex-start; justify-self: start; }
[data-mono="context-menu"] [data-result]:empty { display: none; }
JavaScript module
JavaScript module
export function mount(root) {
  const trigger = root.querySelector('[data-open]');
  const menu = root.querySelector('[role="menu"]');
  const items = [...menu.querySelectorAll('button:not(:disabled)')];
  let opener = trigger;

  function position(x, y) {
    const width = menu.offsetWidth;
    const height = menu.offsetHeight;
    menu.style.left = Math.max(8, Math.min(x, document.documentElement.clientWidth - width - 8)) + 'px';
    menu.style.top = Math.max(8, Math.min(y, document.documentElement.clientHeight - height - 8)) + 'px';
  }

  function open(origin, coords, last = false) {
    if (!items.length) return;
    opener = origin;
    menu.showPopover();
    position(...coords);
    trigger.setAttribute('aria-expanded', 'true');
    const current = menu.querySelector('[aria-checked="true"]:not(:disabled)');
    (last ? items.at(-1) : current || items[0]).focus();
  }
  function fromTrigger(last) {
    const rect = trigger.getBoundingClientRect();
    open(trigger, [rect.left, rect.bottom + 4], last);
  }
  function close(restore) {
    menu.hidePopover();
    if (restore) opener.focus();
  }
  trigger.addEventListener('click', event => {
    event.preventDefault();
    if (menu.matches(':popover-open')) close(true);
    else fromTrigger(false);
  });
  trigger.addEventListener('keydown', event => {
    if (!['ArrowDown', 'ArrowUp'].includes(event.key)) return;
    event.preventDefault();
    fromTrigger(event.key === 'ArrowUp');
  });
  function whileMoving(event) {
    if (event.type === 'resize' || !menu.contains(event.target)) menu.hidePopover();
  }
  menu.addEventListener('toggle', () => {
    const visible = menu.matches(':popover-open');
    trigger.setAttribute('aria-expanded', String(visible));
    if (visible) {
      window.addEventListener('resize', whileMoving);
      document.addEventListener('scroll', whileMoving, true);
    } else {
      window.removeEventListener('resize', whileMoving);
      document.removeEventListener('scroll', whileMoving, true);
    }
  });
  menu.addEventListener('keydown', event => {
    const index = items.indexOf(document.activeElement);
    let next;
    if (event.key === 'Escape') {
      event.preventDefault();
      close(true);
      return;
    }
    if (event.key === 'Tab') {
      close(true);
      return;
    }
    if (event.key === 'ArrowDown') next = (index + 1) % items.length;
    else if (event.key === 'ArrowUp') next = (index - 1 + items.length) % items.length;
    else if (event.key === 'Home') next = 0;
    else if (event.key === 'End') next = items.length - 1;
    else if (event.key.length === 1 && event.key !== ' ' && !event.ctrlKey && !event.metaKey && !event.altKey) {
      const key = event.key.toLowerCase();
      const sequence = [...items.slice(index + 1), ...items.slice(0, index + 1)];
      const match = sequence.find(item => item.textContent.trim().toLowerCase().startsWith(key));
      if (match) next = items.indexOf(match);
    }
    if (next !== undefined) {
      event.preventDefault();
      items[next].focus();
    }
  });
  menu.addEventListener('click', event => {
    const item = event.target.closest('button:not(:disabled)');
    if (!item || !menu.contains(item)) return;
    root.querySelector('[data-result]').textContent = item.textContent;
    root.dispatchEvent(new CustomEvent('mono:action', { bubbles: true, detail: { value: item.dataset.value } }));
    close(true);
  });
  const target = root.querySelector('[data-target]');
  target.addEventListener('contextmenu', event => {
    event.preventDefault();
    const rect = target.getBoundingClientRect();
    open(target, event.clientX || event.clientY ? [event.clientX, event.clientY] : [rect.left, rect.bottom]);
  });
  target.addEventListener('keydown', event => {
    if (event.key !== 'ContextMenu' && !(event.shiftKey && event.key === 'F10')) return;
    event.preventDefault();
    const rect = target.getBoundingClientRect();
    open(target, [rect.left, rect.bottom]);
  });
}
Use the HTML in a static site

Copy the rendered HTML above. Download these assets into the same folder as your page, then add the tags below to its head.

Shared CSS Component CSS Ready-to-use module

HTML head
<link rel="stylesheet" href="./base.css">
<link rel="stylesheet" href="./context-menu.css">
<script type="module" src="./context-menu.js"></script>

Copy into your project

Run this command from the Mono checkout. Set -out to the component directory in your application.

Terminal
go run ./cmd/mono-ui add -out ./components context-menu
Example properties (JSON)
example.json
{
  "Description": "Right-click this proof or use the Actions button.",
  "Items": [
    {
      "Label": "Mark for review",
      "Value": "review"
    },
    {
      "Label": "Approve proof",
      "Value": "approve"
    },
    {
      "Label": "Add to archive",
      "Value": "archive"
    }
  ],
  "Label": "Proof actions",
  "Title": "Press proof 04",
  "Trigger": "Actions"
}