dialog
dialog
Section titled “dialog”| Field | Value |
|---|---|
| Prefix | dialog |
| Namespace constant | DialogNamespace |
| Subjects constant | DialogSubjects |
| Kind | bus |
| Schema record | DialogSchemas |
| Tier | framework |
| Package | @makaio/services-core |
| Defined in | packages/services/core/src/dialog/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
confirm | dialog.confirm | rpc | schemas.ts |
prompt | dialog.prompt | rpc | schemas.ts |
Subject Details
Section titled “Subject Details”dialog.confirm (rpc)
Section titled “dialog.confirm (rpc)”Request user confirmation via UI.
Subject: dialog.confirm
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
details | string | undefined | no |
message | string | yes |
options | { id: string; label: string; variant?: "primary" | "secondary" | "danger" | undefined; }[] | yes |
position | "center" | "top-center" | "bottom-center" | undefined | no |
showDontAskAgain | boolean | undefined | no |
title | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
dontAskAgain | boolean | undefined | no |
selectedOptionId | string | null | yes |
dialog.prompt (rpc)
Section titled “dialog.prompt (rpc)”Request text input via UI prompt dialog.
Subject: dialog.prompt
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
cancelLabel | string | undefined | no |
defaultValue | string | undefined | no |
message | string | yes |
multiline | boolean | undefined | no |
placeholder | string | undefined | no |
submitLabel | string | undefined | no |
title | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
value | string | null | yes |
Auto-generated by yarn docs:bus. Do not edit manually.