@mirantis/beacon-search-widget

Framework-agnostic Web Component (<beacon-search>) for embedding the Beacon search experience on documentation sites. Bundled with Shadow DOM style isolation so it drops into any host page without CSS conflicts.

Status

Pre-release. Primary consumer is the MkDocs plugin, which pulls this package at release time and packages the UMD bundle inside its wheel. Direct consumption from npm is possible but less common.

Install

npm install @mirantis/beacon-search-widget

Pre-release versions (0.x.y-rc.*, -alpha.*, -beta.*) are published to the dev dist-tag, accessible via npm install @mirantis/beacon-search-widget@dev.

Usage

As a <script> tag + custom element

<script src="node_modules/@mirantis/beacon-search-widget/dist/beacon.umd.cjs"></script>
<beacon-search api-url="https://search-api.example.com" product="k0s"></beacon-search>

As an ES module

import '@mirantis/beacon-search-widget';

<beacon-search api-url="https://search-api.example.com"></beacon-search>

Attributes

| Attribute | Required | Description | |---|---|---| | api-url | yes | Base URL of the Beacon search API. | | product | no | Scope search to a single product. | | embed-id | no | Publisher-supplied identifier for analytics segmentation. | | analytics | no | off disables all analytics; default is on. | | analytics-consent-required | no | true defers analytics until the host dispatches beacon-analytics-consent-granted. |

License

Apache-2.0. See LICENSE.

Source

This widget is developed in the private Beacon monorepo under widget/. Issues and contributions go through the Beacon repo.