Skip to content

action.mdx

Latest commit

 

History

History
55 lines (36 loc) · 1.55 KB

action.mdx

File metadata and controls

55 lines (36 loc) · 1.55 KB
Raw
title Action
description Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}

Action Parameter Schema

Defines inputs required before executing an action.

**Source:** `packages/spec/src/ui/action.zod.ts`

TypeScript Usage

import { ActionParam, ActionType } from '@objectstack/spec/ui';
import type { ActionParam, ActionType } from '@objectstack/spec/ui';

// Validate data
const result = ActionParam.parse(data);

ActionParam

Properties

Property Type Required Description
name string ✅
label string ✅ Display label (plain string; i18n keys are auto-generated by the framework)
type Enum<'text' | 'textarea' | 'email' | 'url' | 'phone' | 'password' | 'markdown' | 'html' | 'richtext' | 'number' | 'currency' | 'percent' | 'date' | 'datetime' | 'time' | 'boolean' | 'toggle' | 'select' | 'multiselect' | 'radio' | 'checkboxes' | 'lookup' | 'master_detail' | 'tree' | 'image' | 'file' | 'avatar' | 'video' | 'audio' | 'formula' | 'summary' | 'autonumber' | 'location' | 'address' | 'code' | 'json' | 'color' | 'rating' | 'slider' | 'signature' | 'qrcode' | 'progress' | 'tags' | 'vector'> ✅
required boolean ✅
options Object[] optional

ActionType

Allowed Values

  • script
  • url
  • modal
  • flow
  • api