Beacon Search Widget

Semantic search for technical documentation. Press ⌘K or / to open search, or click the trigger in the header.

Trigger: Header inline (above)

The search trigger in the header nav is the most common pattern — used by DocSearch, Tailwind, Stripe. This instance has keyboard-shortcuts so it owns ⌘K.

Trigger: Standalone

Default placement — no keyboard shortcuts

JavaScript API

Control the widget programmatically

Embed snippet

<script type="module" src="https://widget.main.beacon.us2.amazee.io/beacon.js"></script>
<beacon-search placeholder="Search..."></beacon-search>

Keyboard shortcuts

Keyboard shortcuts are opt-in via the keyboard-shortcuts attribute. Only the instance with this attribute will register global listeners.

<!-- With keyboard shortcuts -->
<beacon-search keyboard-shortcuts></beacon-search>

<!-- Without keyboard shortcuts (default) -->
<beacon-search></beacon-search>

⌘K / Ctrl+K — toggle search modal
/ — open search (when not in an input field)
↑↓ — navigate results
Enter — open selected result
Esc — close modal