> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Session canvas

> SessionRpc で Session canvas の一覧、表示、アクション呼び出しを行う使用例です。

## Session canvas

対象: SessionRpc（Session に紐づくセッション単位の操作）

RPC 全体の概要とページ一覧は [RPC](https://kawax.biz/jp/packages/laravel-copilot-sdk/rpc.md) を参照してください。

## Session canvas

Canvas RPC は `$session->rpc()->canvas()` から呼び出します。`list()` は
`CanvasList` の `canvases`、`listOpen()` は `CanvasListOpenResult` の
`openCanvases` に一覧を返します。`open()` は `OpenCanvasInstance`、
action 呼び出しは `CanvasActionInvokeResult` を返します。`close()` の
戻り値はありません。

```php theme={null}
$canvases = $session->rpc()->canvas();
$available = $canvases->list()->canvases;
$openInstances = $canvases->listOpen()->openCanvases;

$instance = $canvases->open([
    'canvasId' => 'editor',
    'instanceId' => 'editor-1',
    'input' => ['file' => 'README.md'],
]);

$result = $canvases->action()->invoke([
    'instanceId' => $instance->instanceId,
    'actionName' => 'format',
    'input' => ['style' => 'compact'],
]);

$canvases->close(['instanceId' => $instance->instanceId]);
```

Canvas provider の reverse-RPC (`canvas.open` / `canvas.close` /
`canvas.action.invoke`) は `SessionConfig` / `ResumeSessionConfig` の
`canvasHandler` で処理します。Canvas の描画はホスト UI の責務です。


## Related topics

- [SessionConfig](https://kawax.biz/jp/packages/laravel-copilot-sdk/session-config.md)
- [RPC（Remote Procedure Call）](https://kawax.biz/jp/packages/laravel-copilot-sdk/rpc.md)
- [SessionRpc 概要](https://kawax.biz/jp/packages/laravel-copilot-sdk/rpc/session-overview.md)
- [Remote Sessions](https://kawax.biz/jp/packages/laravel-copilot-sdk/remote-sessions.md)
- [Cloud Sessions](https://kawax.biz/jp/packages/laravel-copilot-sdk/cloud-sessions.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.