@nocobase/plugin-ai 2.2.0-alpha.1 → 2.2.0-alpha.10

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-json-variable-mapping/index.md

@@ -1,4 +1,6 @@
 ---
+title: "Workflow: JSON variable mapping"
+keywords: "Workflow"
 displayName: "Workflow: JSON variable mapping"
 packageName: '@nocobase/plugin-workflow-json-variable-mapping'
 description: |
@@ -9,4 +11,4 @@ defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: JSON variable mapping
+# Workflow: JSON variable mapping

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-loop/index.md

@@ -1,12 +1,14 @@
 ---
+title: "Workflow: Loop node"
+keywords: "Workflow"
 displayName: "Workflow: Loop node"
 packageName: '@nocobase/plugin-workflow-loop'
 description: |
-  Used to execute a sub-process for each item in an array or for a fixed number of iterations.
+  Used to repeat the sub-process processing of each value in an array, and can also be used for fixed times of sub-process processing.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Loop node
+# Workflow: Loop node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-mailer/index.md

@@ -1,12 +1,14 @@
 ---
-displayName: "Workflow: Send email node"
+title: "Workflow: mailer node"
+keywords: "NocoBase,Workflow,SMTP,email"
+displayName: "Workflow: mailer node"
 packageName: '@nocobase/plugin-workflow-mailer'
 description: |
-  Used to send emails in a workflow.
+  Send email in workflow.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Send email node
+# Workflow: mailer node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-manual/index.md

@@ -1,12 +1,14 @@
 ---
-displayName: "Workflow: Manual Node"
+title: "Workflow: Manual node"
+keywords: "Workflow"
+displayName: "Workflow: Manual node"
 packageName: '@nocobase/plugin-workflow-manual'
 description: |
-  Used for processes where some decisions are controlled manually.
+  Could be used for workflows which some of decisions are made by users.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Manual Node
+# Workflow: Manual node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-notification/index.md

@@ -1,12 +1,14 @@
 ---
-displayName: "Workflow: Notification Node"
+title: "Workflow: notification node"
+keywords: "Workflow"
+displayName: "Workflow: notification node"
 packageName: '@nocobase/plugin-workflow-notification'
 description: |
-  Used to send various notifications in the workflow.
+  Send notification in workflow.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Notification Node
+# Workflow: notification node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-parallel/index.md

@@ -1,12 +1,14 @@
 ---
-displayName: "Workflow: Parallel branch node"
+title: "Workflow: Parallel node"
+keywords: "Workflow"
+displayName: "Workflow: Parallel node"
 packageName: '@nocobase/plugin-workflow-parallel'
 description: |
-  Used for branch processes that need to be executed in parallel in a workflow.
+  Could be used for parallel execution of branch processes in the workflow.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Parallel branch node
+# Workflow: Parallel node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-request/index.md

@@ -1,12 +1,14 @@
 ---
-displayName: "Workflow: HTTP Request Node"
+title: "Workflow: HTTP request node"
+keywords: "Workflow"
+displayName: "Workflow: HTTP request node"
 packageName: '@nocobase/plugin-workflow-request'
 description: |
-  Used to send requests to any HTTP service for data interaction within a workflow.
+  Send HTTP requests to any HTTP service for data interaction in workflow.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: HTTP Request Node
+# Workflow: HTTP request node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-request-interceptor/index.md

@@ -1,15 +1,17 @@
 ---
+title: "Workflow: Pre-action event"
+keywords: "Workflow"
 displayName: "Workflow: Pre-action event"
 packageName: '@nocobase/plugin-workflow-request-interceptor'
 supportedVersions:
   - 1.x
   - 2.x
 description: |
-  Triggered before the execution of a request initiated through an action button or API, such as before adding, updating, or deleting data. Suitable for data validation and logic judgment before the action, and the request could be rejected by using the "End node".
+  Triggered before the execution of a request initiated through an action button or API, such as before adding, updating, or deleting data. Suitable for data validation and logic judgment before action, and the request could be rejected by using the "End process" node.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Pre-action event
+# Workflow: Pre-action event

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-response-message/index.md

@@ -1,12 +1,14 @@
 ---
+title: "Workflow: Response message"
+keywords: "Workflow"
 displayName: "Workflow: Response message"
 packageName: '@nocobase/plugin-workflow-response-message'
 description: |
-  Used to assemble and display response messages to the client in form event and request interception workflows.
+  Used for assemble response message and showing to client in form event and request interception workflows.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Response message
+# Workflow: Response message

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-sql/index.md

@@ -1,12 +1,14 @@
 ---
-displayName: "Workflow: SQL Node"
+title: "Workflow: SQL node"
+keywords: "Workflow"
+displayName: "Workflow: SQL node"
 packageName: '@nocobase/plugin-workflow-sql'
 description: |
-  Used to execute arbitrary SQL statements on the database within a workflow.
+  Execute SQL statements in workflow.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: SQL Node
+# Workflow: SQL node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-subflow/index.md

@@ -1,4 +1,6 @@
 ---
+title: "Workflow: Subflow"
+keywords: "Workflow"
 displayName: "Workflow: Subflow"
 packageName: '@nocobase/plugin-workflow-subflow'
 supportedVersions:
@@ -12,4 +14,4 @@ defaultEnabled: false
 editionLevel: 2
 ---
 
-# Workflow: Subflow
+# Workflow: Subflow

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-test/index.md

@@ -1,5 +1,7 @@
 ---
-displayName: "Workflow: Test Kit"
+title: "Workflow: test kit"
+keywords: "Workflow: test kit,Plugin,NocoBase"
+displayName: "Workflow: test kit"
 packageName: '@nocobase/plugin-workflow-test'
 description: |
   
@@ -9,4 +11,4 @@ defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Test Kit
+# Workflow: test kit

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-transaction/index.md

@@ -0,0 +1,16 @@
+---
+title: "Workflow: Database transaction node"
+keywords: "Workflow: Database transaction node,plugin,NocoBase"
+displayName: "Workflow: Database transaction node"
+packageName: '@nocobase/plugin-workflow-transaction'
+supportedVersions:
+  - 2.x
+description: |
+  Run data operation nodes from the same database data source in a transaction, committing on success and rolling back on failure.
+isFree: false
+builtIn: false
+defaultEnabled: false
+editionLevel: 3
+---
+
+# Workflow: Database transaction node

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-variable/index.md

@@ -1,15 +1,17 @@
 ---
-displayName: "Workflow: Custom variable node"
+title: "Workflow: Custom variable"
+keywords: "Workflow"
+displayName: "Workflow: Custom variable"
 packageName: '@nocobase/plugin-workflow-variable'
 supportedVersions:
   - 1.x
   - 2.x
 description: |
-  Used for creating custom variables or assigning values to them in workflows, to save temporary data in the process.
+  Used for creating custom variables or assigning value to it in workflows, to save temporary data in the process.
 isFree: true
 builtIn: true
 defaultEnabled: false
 editionLevel: 0
 ---
 
-# Workflow: Custom variable node
+# Workflow: Custom variable

package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-workflow-webhook/index.md

@@ -1,5 +1,7 @@
 ---
-displayName: "Workflow: Webhook Trigger"
+title: "Workflow: Webhook"
+keywords: "Workflow"
+displayName: "Workflow: Webhook"
 packageName: '@nocobase/plugin-workflow-webhook'
 supportedVersions:
   - 1.x
@@ -12,4 +14,4 @@ defaultEnabled: false
 editionLevel: 2
 ---
 
-# Workflow: Webhook Trigger
+# Workflow: Webhook

package/dist/ai/docs/nocobase/runjs/context/ai.md

@@ -0,0 +1,206 @@
+---
+title: "ctx.ai"
+description: "Use ctx.ai in RunJS to trigger AI employee tasks, either with inline task content or with tasks configured on an AI employee action."
+keywords: "ctx.ai,AI employee,triggerTask,triggerModelTask,RunJS,NocoBase"
+---
+
+# ctx.ai
+
+Use `ctx.ai` in RunJS to trigger **AI employee tasks**. It works well in JSBlock, JSAction, and other interactions where a button, form, or business flow needs to hand work to a specific AI employee.
+
+`ctx.ai` only triggers tasks. It does not return the execution result of the AI employee task. After the call, the task enters the AI employee conversation flow, and the result is handled by the AI employee session.
+
+:::warning Note
+
+`ctx.ai` is provided by the AI plugin. If the AI plugin is not enabled, or the current RunJS environment has not loaded the corresponding client capability, `ctx.ai` may not exist. You can check `ctx.ai?.triggerTask` or `ctx.ai?.triggerModelTask` before calling it.
+
+:::
+
+## Methods
+
+### ctx.ai.triggerTask()
+
+Trigger an AI employee task directly.
+
+```ts
+ctx.ai.triggerTask(options: TriggerTaskOptions): void
+```
+
+| Parameter | Type | Description |
+|------|------|------|
+| `aiEmployee` | `string \| AIEmployee` | AI employee. When a string is passed, NocoBase matches `AIEmployee.username` exactly, and the AI employee must be accessible to the current user. |
+| `tasks` | `Task[]` | Tasks to trigger. |
+| `open` | `boolean` | Whether to open the AI employee conversation panel. |
+| `auto` | `boolean` | Whether to use the auto-trigger semantics of an AI employee action. |
+
+Common `Task` fields:
+
+| Field | Type | Description |
+|------|------|------|
+| `title` | `string` | Task title. |
+| `message.system` | `string` | System message, used to constrain the AI employee's role and output requirements. |
+| `message.user` | `string` | User message, which is the main instruction for this task. |
+| `message.workContext` | `ContextItem[]` | Page block context used by the task. |
+| `autoSend` | `boolean` | Whether to send the task message automatically. |
+| `webSearch` | `boolean` | Whether Web search is allowed for this task. |
+| `model` | `{ llmService: string; model: string } \| null` | Model used by this task. |
+| `skillSettings` | `SkillSettings` | Skills and tools available to this task. |
+
+### Add Page Block Context
+
+`message.workContext` currently passes page blocks. Put the FlowModel uid of the target page block into it:
+
+```ts
+message: {
+  user: 'Review the current users table and summarize operational risks.',
+  workContext: [
+    {
+      type: 'flow-model',
+      uid: 'USERS_TABLE_BLOCK_UID',
+    },
+  ],
+}
+```
+
+| Field | Description |
+|------|------|
+| `type` | Fixed to `flow-model`, meaning this item is a page block context. |
+| `uid` | FlowModel uid of the page block, such as a table block, detail block, or chart block. |
+
+If you want to use the current JSBlock itself as context, use the current model uid:
+
+```ts
+workContext: [
+  {
+    type: 'flow-model',
+    uid: ctx.model.uid,
+  },
+],
+```
+
+Usually, `message.workContext` should be placed inside the `message` of a concrete task. `triggerModelTask()` reuses the task configured on the target AI employee action, so it also reads `message.workContext` from that task.
+
+### Specify Model
+
+`model` specifies the model for a single task. If omitted, the AI employee's default model configuration is used. Passing `null` means no task-level model is specified.
+
+```ts
+model: {
+  llmService: 'openai-main',
+  model: 'gpt-4.1',
+}
+```
+
+### Configure Skills / Tools
+
+`skillSettings` specifies the skills and tools available to a single task. If omitted, the AI employee's own capability configuration is used.
+
+```ts
+skillSettings: {
+  skillsVersion: 2,
+  toolsVersion: 2,
+  skills: ['business-analysis-report'],
+  tools: ['businessReportGenerator'],
+}
+```
+
+To explicitly disable all skills or tools for this task, pass empty arrays and keep the version fields:
+
+```ts
+skillSettings: {
+  skillsVersion: 2,
+  toolsVersion: 2,
+  skills: [],
+  tools: [],
+}
+```
+
+The following example asks `viz` to generate a handoff brief and opens the AI employee conversation panel:
+
+```ts
+if (!ctx.ai?.triggerTask) {
+  ctx.message.error(ctx.t('AI employee task API is not available.'));
+  return;
+}
+
+ctx.ai.triggerTask({
+  aiEmployee: 'viz',
+  open: true,
+  tasks: [
+    {
+      title: ctx.t('Daily operations handoff brief'),
+      message: {
+        system:
+          'You prepare reusable daily operations handoff briefs. Focus on risks, blockers, decisions, owners, and next actions.',
+        user: [
+          "Prepare today's operations handoff brief.",
+          'Cover customer escalations, SLA risks, approvals, and follow-up owners.',
+          'Return a concise brief that can be posted to the team channel.',
+        ].join('\n'),
+      },
+      autoSend: true,
+      webSearch: false,
+    },
+  ],
+});
+
+ctx.message.success(ctx.t('AI employee task triggered.'));
+```
+
+If `aiEmployee` is a string, NocoBase matches accessible AI employees by `username` exactly. If no match is found, the task is not triggered and a warning is printed to the console.
+
+### ctx.ai.triggerModelTask()
+
+Read a task from an AI employee action model on the page and trigger it.
+
+```ts
+ctx.ai.triggerModelTask(uid: string, taskIndex: number, options?: TriggerModelTaskOptions): void
+```
+
+| Parameter | Type | Description |
+|------|------|------|
+| `uid` | `string` | FlowModel uid of the AI employee action. |
+| `taskIndex` | `number` | Task index, starting from `0`. |
+| `options.open` | `boolean` | Whether to open the AI employee conversation panel. |
+| `options.auto` | `boolean` | Whether to use the auto-trigger semantics of an AI employee action. |
+
+This method reads the AI employee and task configuration from the target model. It is useful when the task has already been configured on an AI employee action on the page, and RunJS only needs to trigger it.
+
+```ts
+if (!ctx.ai?.triggerModelTask) {
+  ctx.message.error(ctx.t('AI employee task API is not available.'));
+  return;
+}
+
+const weeklyReviewActionUid = 'AI_EMPLOYEE_ACTION_MODEL_UID';
+
+ctx.ai.triggerModelTask(weeklyReviewActionUid, 0, {
+  open: true,
+});
+
+ctx.message.success(ctx.t('Configured AI employee task triggered.'));
+```
+
+If the target model does not exist, has no AI employee configured, or the specified index has no task, no task is triggered and a warning is printed to the console.
+
+## Which Method to Use
+
+| Scenario | Recommended method |
+|------|------|
+| Task content is assembled dynamically in RunJS, such as from form values. | `ctx.ai.triggerTask()` |
+| The task has already been configured on an AI employee action on the page, and RunJS only triggers it. | `ctx.ai.triggerModelTask()` |
+| Business users need to adjust task content without changing code. | `ctx.ai.triggerModelTask()` |
+| The AI employee, prompt, or sending behavior needs to be decided at runtime. | `ctx.ai.triggerTask()` |
+
+## Notes
+
+- `triggerTask()` and `triggerModelTask()` are fire-and-forget. They do not return the execution result of the AI employee task.
+- `aiEmployee` strings only match `AIEmployee.username` exactly. They do not match nicknames, job titles, or translated names.
+- `triggerModelTask()` uses a `0`-based `taskIndex`.
+- `triggerModelTask()` reads task configuration from the target AI employee action model. If the task needs work context, configure `message.workContext` on that task.
+
+## Related
+
+- [ctx.message](./message.md): Show lightweight prompts before and after triggering tasks.
+- [ctx.render](./render.md): Render buttons or forms in JSBlock.
+- [ctx.model](./model.md): Get current FlowModel information.

package/dist/ai/docs/nocobase/security/guide.md

@@ -215,6 +215,29 @@ If you need to store sensitive files, it is recommended to use a cloud storage s
 
 For local storage or other public storage that can be accessed directly through same-origin application URLs, you should also pay extra attention to the risks introduced by active content files. Files such as `html`, `xhtml`, and `svg` may be parsed and executed directly by the browser. If an attacker can upload such a file and trick a user into opening it, the attacker may use your trusted application domain to host a malicious page or script.
 
+NocoBase upload validation does not trust the `Content-Type` sent by the request. It prefers the MIME type detected on the server side. A file extension only represents the filename and should not be treated as the authoritative file content type. Therefore, when serving public uploaded files, you also need to make sure the file access path has proper security response headers.
+
+If you deploy with Docker or use the nginx configuration generated by NocoBase, the upload directory already includes this protection: all uploaded files return `X-Content-Type-Options: nosniff`, and active content files such as `html`, `xhtml`, `svg`, `svgz`, and `pdf` are returned as downloads through `Content-Disposition: attachment`.
+
+If you use a custom proxy, CDN, object storage, or expose the local upload directory directly, make sure these rules are not bypassed. You can use the following nginx configuration as a reference:
+
+```nginx
+location ~* ^/storage/uploads/(.*\.(?:htm|html|svg|svgz|xhtml|pdf))$ {
+    alias /path/to/nocobase/storage/uploads/$1;
+    add_header Content-Disposition "attachment" always;
+    add_header X-Content-Type-Options "nosniff" always;
+    autoindex off;
+}
+
+location /storage/uploads/ {
+    alias /path/to/nocobase/storage/uploads/;
+    add_header X-Content-Type-Options "nosniff" always;
+    autoindex off;
+}
+```
+
+If your NocoBase app uses `APP_PUBLIC_PATH`, replace `/storage/uploads/` with the actual access prefix, such as `/nocobase/storage/uploads/`.
+
 In most cases, we recommend that administrators:
 
 - Prefer private storage, signed URLs, or a separate file domain, so that user-uploaded files are not served directly from the same origin as the main application.

package/dist/ai/docs/nocobase/shared-components/create-form-registry.md

@@ -0,0 +1,38 @@
+---
+title: "createFormRegistry"
+description: "createFormRegistry: Create an internal registry for plugin extension items."
+keywords: "createFormRegistry,NocoBase,client-v2"
+---
+
+# createFormRegistry
+
+`createFormRegistry` is used to create an internal registry for plugin extension items.
+
+## Basic Usage
+
+```ts
+import { createFormRegistry, type FormRegistryEntry } from '@nocobase/client-v2';
+
+interface StorageType extends FormRegistryEntry {
+  title: string;
+  Component: React.ComponentType;
+}
+
+const storageTypes = createFormRegistry<StorageType>('file-manager/storage-types');
+
+storageTypes.register({ name: 'local', title: 'Local', Component: LocalStorageForm });
+storageTypes.register({ name: 's3', title: 'Amazon S3', Component: S3StorageForm });
+
+const s3 = storageTypes.get('s3');
+const all = storageTypes.list();
+```
+
+## API
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `register(entry)` | `-` | Register an entry |
+| `unregister(name)` | `-` | Remove an entry |
+| `get(name)` | `-` | Get an entry by name |
+| `has(name)` | `-` | Check whether an entry exists |
+| `list()` | `-` | Return all entries |

package/dist/ai/docs/nocobase/shared-components/filter/collection-filter-panel.md

@@ -0,0 +1,44 @@
+---
+title: "CollectionFilterPanel"
+description: "CollectionFilterPanel: Embed a Collection filter panel in a page."
+keywords: "CollectionFilterPanel,NocoBase,client-v2"
+---
+
+# CollectionFilterPanel
+
+`CollectionFilterPanel` is used to embed a Collection filter panel in a page.
+
+## Basic Usage
+
+```tsx
+import { CollectionFilterPanel, type CollectionFilterPanelRef } from '@nocobase/client-v2';
+
+const ref = useRef<CollectionFilterPanelRef>(null);
+
+<CollectionFilterPanel ref={ref} collection={collection} t={t} />;
+
+const filter = ref.current?.getFilter();
+```
+
+## API
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `collection` | `Collection | undefined` | Collection used as the field source |
+| `initialValue` | `Record<string, unknown>` | Initial filter value |
+| `onChange` | `(filter) => void` | Change callback |
+| `t` | `(key, options?) => string` | Translation function |
+| `filterableFieldNames` | `string[]` | Field allowlist |
+| `nonfilterableFieldNames` | `string[]` | Field blocklist |
+| `noIgnore` | `boolean` | Skip allowlist restrictions |
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| `getFilter()` | Get the compiled filter |
+| `reset()` | Clear all conditions |
+
+## Related Links
+
+- [CollectionFilter](./)

package/dist/ai/docs/nocobase/shared-components/filter/index.md

@@ -0,0 +1,44 @@
+---
+title: "CollectionFilter"
+description: "CollectionFilter: Filter a Collection with multiple conditions."
+keywords: "CollectionFilter,NocoBase,client-v2"
+---
+
+# CollectionFilter
+
+`CollectionFilter` is used to filter a Collection with multiple conditions.
+
+## Basic Usage
+
+```tsx
+import { CollectionFilter } from '@nocobase/client-v2';
+
+<CollectionFilter
+  collection={collection}
+  t={t}
+  onChange={(filter) => {
+    listRequest.run({ filter });
+  }}
+/>;
+```
+
+## API
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `collection` | `Collection | undefined` | Collection used as the field source |
+| `initialValue` | `Record<string, unknown>` | Initial filter value |
+| `onChange` | `(filter) => void` | Change callback |
+| `t` | `(key, options?) => string` | Translation function |
+| `filterableFieldNames` | `string[]` | Field allowlist |
+| `nonfilterableFieldNames` | `string[]` | Field blocklist |
+| `noIgnore` | `boolean` | Skip allowlist restrictions |
+| `buttonText` | `React.ReactNode` | Custom button text |
+| `showCount` | `boolean` | Whether to show the number of conditions |
+| `popoverProps` | `PopoverProps` | Props passed to Antd Popover |
+| `buttonProps` | `ButtonProps` | Props passed to Antd Button |
+| `popoverMinWidth` | `number` | Minimum width of the Popover content |
+
+## Related Links
+
+- [CollectionFilterPanel](./collection-filter-panel)

package/dist/ai/docs/nocobase/shared-components/form/code-scanner.md

@@ -0,0 +1,34 @@
+---
+title: "CodeScanner"
+description: "CodeScanner: Control the low-level full-screen scanner."
+keywords: "CodeScanner,NocoBase,client-v2"
+---
+
+# CodeScanner
+
+`CodeScanner` is used to control the low-level full-screen scanner.
+
+## Basic Usage
+
+```tsx
+import { CodeScanner } from '@nocobase/client-v2';
+
+<CodeScanner
+  visible={visible}
+  onClose={() => setVisible(false)}
+  onScanSuccess={(text) => setValue(text)}
+/>;
+```
+
+## API
+
+| Prop | Type | Description |
+| --- | --- | --- |
+| `visible` | `boolean` | Whether the scanner is visible |
+| `formatsToSupport` | `Html5QrcodeSupportedFormats[]` | Supported QR code or barcode formats |
+| `onClose` | `() => void` | Called when the scanner closes |
+| `onScanSuccess` | `(result: string) => void` | Called after a successful scan |
+
+## Related Links
+
+- [ScanInput](./scan-input)