Search documentation

Search documentation

Composable@pillar-ai/vue

useHelpPanel()

Composable for panel-specific controls

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

Signature

typescript
function useHelpPanel(): UseHelpPanelResult

Return Value

Return Value

isOpen
requiredComputedRef<boolean>
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
```vue
<script setup lang="ts">
import { useHelpPanel } from '@pillar-ai/vue';


const { isOpen, toggle, openChat } = useHelpPanel();
</script>


<template>
  <div>
    <button
Source: packages/sdk-vue/src/composables/useHelpPanel.ts