Skip to content

@sibilance.is/client v0.1.0-alpha.4


@sibilance.is/client / react / useSibilance

Function: useSibilance()

ts
function useSibilance(config, callbacks?): UseSibilanceResult;

Defined in: CmdPr/sibilance/client/src/hooks/useSibilance.ts:68

useSibilance - Main React hook for Sibilance voice surveys

Parameters

ParameterTypeDescription
configSibilanceConfigSibilance configuration
callbacks?SurveyCallbacksSurvey lifecycle callbacks

Returns

UseSibilanceResult

Survey client and controls

Example

tsx
const { client, voiceState, surveyState, connect, disconnect } = useSibilance({
  survey: {
    markdown: surveyMarkdown,
    steps: parsedSteps,
    mermaidDiagram: diagram,
    surveyName: "Customer Feedback",
  }
}, {
  onComplete: (yaml) => console.log('Survey completed:', yaml),
});