---
title: "Control the widget with BuukWidget"
url: "/help/buuk/guides/control-the-widget-with-buukwidget"
updated: "2026-11-15T11:35:29.635Z"
---
# Control the widget with BuukWidget

The embed adds a small global API so your own interface can open the widget or tell it who is reading. Nothing here is required to install the widget.

## Open and close

```js
BuukWidget.open();
BuukWidget.close();
BuukWidget.toggle();
```

Use these on your own buttons: a Help link in the header, a menu item, or a support card. With the launcher turned off in the Widget studio, this is how readers reach the widget at all.

## Open a specific article

```js
BuukWidget.showArticle("embed-the-help-widget");
```

The argument is the article slug. It opens the widget straight on that page, which is useful when your error message or settings screen has a matching doc.

## Identify the reader

```js
BuukWidget.identify({ name: "Sam Rivera", email: "sam@example.com" });
```

Identification is optional and stays in the page. It is attached to escalated questions so the handoff carries a name and email, and it is ignored if both fields are empty. Call it after the snippet loads and after the reader signs in, so a handoff made later includes them.

## Set the language

```js
BuukWidget.setLocale("de");
```

The widget serves translations your docs already have. Setting the locale switches collection names, article bodies and the interface copy, and it is remembered for that browser. Call it whenever your product's language changes; calling it with an empty string goes back to the workspace default.

## Announcements

```js
BuukWidget.showAnnouncements();
```

Opens the News tab. Pair it with a badge in your own UI when you want readers to notice a release.

## Notes

Wait for the snippet to finish loading before calling these. A `BuukWidget` check or a `DOMContentLoaded` listener is enough. All calls are no-ops when the widget is disabled, so you don't need to guard them yourself.