React

事前構築された React コンポーネントを使って React アプリケーションに Docs Embed を追加する

Reactプロジェクト向けに、GitBookはドキュメントを埋め込むための事前構築コンポーネントを提供します。これらのコンポーネントは状態管理、コンテキスト、ライフサイクルを自動的に処理します。

手順

1

パッケージをインストールする

追加 @gitbook/embed をあなたのReactプロジェクトに:

npm install @gitbook/embed

完全なAPIリファレンスとソースコードは次を参照してください @gitbook/embed GitHub上のパッケージ.

2

Reactコンポーネントをインポートする

をインポートします GitBookProvider および GitBookFrame コンポーネント：

import {
  GitBookProvider,
  GitBookFrame,
} from "@gitbook/embed/react";

3

アプリをGitBookProviderでラップする

プロバイダをコンポーネントツリーのルート、または埋め込みが必要な場所に追加します：

function App() {
  return (
    <GitBookProvider siteURL="https://docs.company.com">
      <YourAppContent />
    </GitBookProvider>
  );
}

4

GitBookFrameコンポーネントを追加する

埋め込みを表示したい場所にフレームコンポーネントを配置します：

function App() {
  return (
    <GitBookProvider siteURL="https://docs.company.com">
      <div className="app">
        <YourAppContent />
        <GitBookFrame
          visitor={{
            token: 'your-jwt-token', // 任意：Adaptive Contentや認証アクセス用
            unsignedClaims: { userId: '123' } // 任意：動的式のためのカスタムクレーム
          }}
        />
      </div>
    </GitBookProvider>
  );
}

5

埋め込みをカスタマイズする

フレームコンポーネントに構成プロパティを渡します：

<GitBookProvider siteURL="https://docs.company.com">
  <GitBookFrame
    trademark={false}
    tabs={['assistant', 'docs']}
    greeting={{ title: 'Welcome!', subtitle: 'How can I help?' }}
    suggestions={['What is GitBook?', 'How do I get started?']}
    actions={[
      {
        icon: 'circle-question',
        label: 'Contact Support',
        onClick: () => window.open('https://support.example.com', '_blank')
      }
    ]}
    tools={[/* ... */]}
    visitor={{
      token: 'your-jwt-token',
      unsignedClaims: { userId: '123' }
    }}
  />
</GitBookProvider>

6

useGitBookフックで埋め込みを制御する

を使用します useGitBook フックを使ってプログラム的に埋め込みと対話します：

import { useGitBook } from "@gitbook/embed/react";

function HelpButton() {
  const gitbook = useGitBook();
  const frameURL = gitbook.getFrameURL({ visitor: { token: '...' } });
  
  const handleNavigate = () => {
    const iframe = document.createElement('iframe');
    iframe.src = frameURL;
    const frame = gitbook.createFrame(iframe);
    frame.navigateToPage('/getting-started');
    frame.navigateToAssistant();
    frame.postUserMessage('How do I get started?');
  };

  return <button onClick={handleNavigate}>Get Help</button>;
}

7

埋め込みを条件付きでレンダリングする

必要なときだけ埋め込みを表示する：

function App() {
  const [showEmbed, setShowEmbed] = useState(false);

  return (
    <GitBookProvider siteURL="https://docs.company.com">
      <button onClick={() => setShowEmbed(true)}>Get Help</button>
      {showEmbed && <GitBookFrame />}
    </GitBookProvider>
  );
}

8

Next.jsやサーバーサイドレンダリングと共に使う

SSRの問題を避けるためにコンポーネントを動的にインポートします：

import dynamic from "next/dynamic";

const GitBookProvider = dynamic(
  () => import("@gitbook/embed/react").then((mod) => mod.GitBookProvider),
  { ssr: false }
);

const GitBookFrame = dynamic(
  () => import("@gitbook/embed/react").then((mod) => mod.GitBookFrame),
  { ssr: false }
);

Props と構成

GitBookProvider の Props：

プロパティ	型	必須	デフォルト	説明
siteURL	string	はい	該当なし	あなたのGitBookドキュメントサイトのURL（例： https://docs.company.com).
children	ReactNode	はい	該当なし	プロバイダ内でレンダリングする子コンポーネント。

GitBookFrame の Props：

すべての構成オプションはプロップとして <GitBookFrame>に渡すことができます。利用可能なオプションは下の「Configuration」セクションを参照してください。

プロパティ	型	必須	デフォルト	説明
className	string	いいえ	null	フレームコンテナに適用するCSSクラス名。
style	object	いいえ	{}	フレームコンテナに適用するインラインスタイル。
visitor	object	いいえ	{}	認証されたアクセスのオプション（下参照）。

useGitBook フック：

を返します GitBookClient 次のメソッドを持つインスタンス：

• getFrameURL(options?: { visitor?: {...} }) → string - iframe の URL を取得する

• createFrame(iframe: HTMLIFrameElement) → GitBookFrameClient - フレームクライアントを作成する

フレームクライアントは以下を提供します：

• navigateToPage(path: string) → void

• navigateToAssistant() → void

• postUserMessage(message: string) → void

• clearChat() → void

• configure(settings: {...}) → void

• on(event: string, listener: Function) → () => void

構成オプション

構成オプションはプロップとして利用できます <GitBookFrame>:

tabs

表示するタブを上書きします。デフォルトはサイトの設定です。

• 型: ('assistant' | 'docs')[]

actions

タブの横にサイドバー内でレンダリングされるカスタムアクションボタン。各アクションボタンはクリック時にコールバックをトリガーします。

注記：これは以前は buttonsという名前でした。 actions 代わりに

• 型: Array<{ icon: string, label: string, onClick: () => void }>

greeting

Assistantタブに表示される歓迎メッセージ。

• 型: { title: string, subtitle: string }

suggestions

Assistantのウェルカム画面に表示される推奨質問。

• 型: string[]

trademark

Docs EmbedフッターやAssistantのブランディングを含む埋め込みUI内のGitBook商標を表示するか隠すかを指定します。

• 型: boolean

• デフォルト: true

tools

Assistantを拡張するカスタムAIツール。詳細は次を参照してください： カスタムツールの作成 を参照してください。

• 型: Array<{ name: string, description: string, inputSchema: object, execute: Function, confirmation?: {...} }>

visitor (認証アクセス)

で使用されます Adaptive Content および 認証されたアクセス.

• 型: { token?: string, unsignedClaims?: Record<string, unknown> }

よくある落とし穴

• GitBookProviderでラップしていない – この GitBookFrame は機能するために親の GitBookProvider を必要とします。

• 動的インポートなしでSSRと共に使用する – コンポーネントはブラウザAPIを使用するため、Next.jsなどのSSRフレームワークでは動的にインポートする必要があります。

• siteURLが公開されたドキュメントと一致していない – propがライブのドキュメントサイトのURLと正確に一致していることを確認してください。 siteURL useGitBookをプロバイダ外で呼び出す

• フックはプロバイダの子であるコンポーネント内で使用する必要があります – この useGitBook 。 GitBookProvider.

• ツリー内に複数のプロバイダがある – 複数の GitBookProvider インスタンスをネストするのは避けてください。コンテキストの競合を引き起こす可能性があります。

• 古いコンポーネント名を使用している – そのコンポーネントは現在 GitBookFrameであり、以前の名前ではありません GitBookAssistantFrame.