Skip to main content

​
State Management

useToolInfo

Get initial tool input, output and metadata

useWidgetState

Persist state across widget renders

​
Context Sync

data-llm

Sync widget UI state with the model for contextual responses

​
Utilities

createStore

Create a Zustand store that automatically syncs with widget state

​
User Interface

useLayout

Get layout and visual environment (theme, safe area)

useUser

Get user information (locale, device type)

useDisplayMode

Get and request widget display mode changes

useRequestModal

Open a modal portaled outside of the widget iframe

​
Actions

useCallTool

Call tools from within a widget

useOpenExternal

Open external links

useSendFollowUpMessage

Send a follow-up message in the conversation

useFiles

Upload and download files

​
Advanced

useAppsSdkContext

Low-level hook to subscribe to window.openai state values

​
Import

All hooks and utilities are exported from skybridge/web: 
import {
  createStore,
  useCallTool,
  useDisplayMode,
  useFiles,
  useLayout,
  useAppsSdkContext,
  useOpenExternal,
  useRequestModal,
  useSendFollowUpMessage,
  useToolInfo,
  useUser,
  useWidgetState,
} from "skybridge/web";