Widget ID: raise-hand. API: documented below.

Purpose

Participants raise a hand to ask to speak. The widget shows the queue in the order hands were raised; anyone can lower a hand from the queue, for example after that person has spoken. The control panel tray button raises or lowers your hand and shows how many hands are up.

API

TypeScript
interface RaiseHandApi {
  setRaised(raised: boolean): void;
}

Available while the widget is open.

Example: raise a hand from your own button

JavaScript
const weei = await window.weeiReady;
document.querySelector('#ask-question').onclick = async () => {
  await weei.widgetsApi.enable('raise-hand');
  weei.widgetsApi.get('raise-hand')?.setRaised(true);
};

Good to know

  • Each participant orders the queue by when the hand reached them, so two hands raised at the same moment can appear in a different order for different people.
  • Nothing is stored; hands of participants who leave are removed.