a2ui-shadcn logoa2ui-shadcn
DocsPlayground

Resources

  • Documentation
  • Playground
  • A2UI Protocol

Community

  • GitHub
  • Issues
  • shadcn/ui

More

  • Tailwind CSS
  • Next.js
  • React

a2ui-shadcn.shahnazar.me

Created by Reza Shahnazar

Getting Started

  • Introduction
  • Installation
  • Usage

Components

  • Components
    Layout
    ColumnRowCard
    Content
    Text
    Input
    TextFieldCheckBox
    Interactive
    Button
    Feedback
    Badge

Reactivity & Actions

  • Actions
  • Transport

Styling

  • Theming
  • RTL Support

Advanced

  • Custom Components
  • API Reference
  1. Home
  2. /Docs
  3. /Api
IntroductionInstallationUsageComponentsThemingRTL SupportCustom ComponentsActionsTransportAPI Reference

API Reference

Complete TypeScript API documentation for a2ui-shadcn components, hooks, types, and utilities.

API Reference

Complete TypeScript API for a2ui-shadcn.

<A2UISurface>

Props:

typescript

useA2UIDataModel

typescript

Example:

tsx

registerFunction

typescript

Message Types

A2UIMessage:

typescript

CreateSurfaceMessage:

typescript

UpdateComponentsMessage:

typescript

UpdateDataModelMessage:

typescript

ActionMessage:

typescript

Transport Types

typescript

Next Steps

  • Interactive Playground - Try the API live
Previous
Custom Components