Search documentation

Search documentation

Hook@pillar-ai/react

useHelpPanel()

Hook for panel-specific controls

typescript
import { useHelpPanel } from '@pillar-ai/react'

Signature

typescript
function useHelpPanel(): UseHelpPanelResult

Return Value

Return Value

isOpen
requiredboolean
Whether the panel is currently open
open
required(options?: { view?: string; article?: string; search?: string }) => void
Open the panel
close
required() => void
Close the panel
toggle
required() => void
Toggle the panel
openArticle
required(slug: string) => void
Open a specific article in the panel
openCategory
required(slug: string) => Promise<void>
Open a specific category in the panel
openSearch
required(query?: string) => void
Open search with a query
openChat
required() => void
Open the AI chat

Returns

UseHelpPanelResult

Example

tsx
function HelpButton() {
  const { isOpen, toggle, openChat } = useHelpPanel();
  
  return (
    <div>
      <button onClick={toggle}>
        {isOpen ? 'Close' : 'Help'}
      </button>
      <button onClick={openChat}>
        Ask AI
      </button>
    </div>
  );
}
Source: packages/sdk-react/src/hooks/useHelpPanel.ts