AIUI Agent Developer Guide

This guide provides independent and comprehensive context for AI agents developing AIUI applications. It includes project structure, SFC .ink support specifications, and standard API references, designed to help Large Language Models (LLMs) generate accurate AIUI pages and logic code.

At present, AIUI is used in two forms. These two forms describe the current AIUI product shape only; more forms may be added in the future. Different forms can also transition into one another as the user flow changes, for example from a conversation-flow card into a full-screen page.

• Conversation-flow cards: Cards embedded in a conversation flow are display-only and should be treated as non-interactive surfaces for presenting information.
• Full-screen pages: Full-screen pages provide complete interaction capabilities and support richer page logic, event handling, and user input.

1. Project Structure

A standard AIUI application project typically contains the following core files:

• AGENTS.md: The agent manifest, defining the agent's identity and capabilities.
• app.json: Global configuration, including page routes, window settings, etc.
• app.js: Application lifecycle and global logic.
• pages/: Page directory containing the application's pages, primarily using the Single File Component (SFC) .ink format.
• assets/: Directory for storing static resources like images and audio.

1.1 Agent Manifest (AGENTS.md)

The manifest file defines the agent's basic information and required permissions/skills:

# Agent Manifest

## Identity
- **Name**: My AIUI Agent
- **Version**: 1.0.0
- **Description**: A brief application description.
- **Author**: Developer Name

## Capabilities
- **Permissions**:
  - camera
  - microphone
  - network
  - audio
- **Skills**:
  - weather-lookup

1.2 Global Configuration (app.json)

Defines application page paths and global UI styles. The pages field is required and declares the routing order for all application pages:

{
  "pages": [
    "pages/index/index"
  ],
  "window": {
    "navigationBarTitleText": "My AIUI Agent",
    "viewport": {
      "width": "device-width"
    }
  }
}

• pages is an array of page route strings without file extensions.
• Each entry maps to a page directory such as pages/index/index, which resolves to the corresponding page files in that folder.
• The first item in the array is treated as the application's default landing page.
• Add new pages here whenever you create additional screens, otherwise the framework will not register them for navigation.

1.3 Application Registration (app.js)

AIUI uses an ES module-based registration system, registering the application by exporting a default configuration object:

export default {
  onLaunch() {
    console.log('App Launch');
  },
  globalData: {
    userInfo: null
  }
};

1.4 Page

In AIUI, each page acts as a Model Context Protocol (MCP) UI component. A complete page should define the following parts:

• Configuration: Page-level metadata such as description, and schema. The description explains what the page represents, and schema.data uses JSON Schema to declare the input data required to render the page.
• Logic: Page state, lifecycle hooks, and custom methods used to initialize data and respond to user interactions.
• Structure: The UI template that describes the page layout and binds data to components.
• Style: The WXSS or CSS rules that control the visual presentation of the page.

When writing page configuration, pay special attention to description and schema.data:

• description should describe the page in natural language from a UI perspective.
  • State what the page displays or helps the user accomplish.
  • Mention the most important dynamic data if the page depends on external input.
  • Keep it specific and observable. Prefer "Displays a weather summary for a city" over "Weather page".
• schema.data should define the complete input contract required to render the page.
  • Use type: "object" at the top level.
  • Put all render-time fields in properties.
  • Use required for fields that must exist before the page can render correctly.
  • Add description, enum, items, and nested object definitions when they help clarify the data contract.

Examples:

Example 1: Weather card page

{
  "description": "Displays the current weather summary for a city, including temperature, condition, and humidity.",
  "schema": {
    "data": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string",
          "description": "City name shown in the page header"
        },
        "temperature": {
          "type": "number",
          "description": "Current temperature in Celsius"
        },
        "condition": {
          "type": "string",
          "enum": ["sunny", "cloudy", "rainy", "snowy"],
          "description": "Current weather condition"
        },
        "humidity": {
          "type": "number",
          "description": "Current humidity percentage"
        }
      },
      "required": ["city", "temperature", "condition"]
    }
  }
}

Example 2: Product detail page

{
  "description": "Shows product information for an item, including title, price, primary image, and purchase status.",
  "schema": {
    "data": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Product title"
        },
        "price": {
          "type": "number",
          "description": "Current selling price"
        },
        "imageUrl": {
          "type": "string",
          "description": "Primary product image URL"
        },
        "inStock": {
          "type": "boolean",
          "description": "Whether the product can be purchased"
        },
        "tags": {
          "type": "array",
          "description": "Short product labels shown near the title",
          "items": {
            "type": "string"
          }
        }
      },
      "required": ["title", "price", "imageUrl", "inStock"]
    }
  }
}

Example 3: Task list page

{
  "description": "Renders a task list with completion status, assignee information, and an optional empty-state message.",
  "schema": {
    "data": {
      "type": "object",
      "properties": {
        "tasks": {
          "type": "array",
          "description": "Tasks displayed in the list",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Task identifier"
              },
              "title": {
                "type": "string",
                "description": "Task title"
              },
              "completed": {
                "type": "boolean",
                "description": "Whether the task has been completed"
              },
              "assignee": {
                "type": "string",
                "description": "Person responsible for the task"
              }
            },
            "required": ["id", "title", "completed"]
          }
        },
        "emptyMessage": {
          "type": "string",
          "description": "Message shown when there are no tasks"
        }
      },
      "required": ["tasks"]
    }
  }
}

AIUI supports two page authoring modes:

1. Multi-file mode: Split the page across separate files such as page.json, page.js, page.wxml, and page.wxss.
   • page.json: Page configuration and metadata.
   • page.js: Page logic, data, lifecycle hooks, and methods.
   • page.wxml: Page template structure.
   • page.wxss: Page styles.
2. Single-file mode: Define the entire page in one .ink file.
   • <script def>: Page configuration and metadata.
   • <script setup>: Page logic, data, lifecycle hooks, and methods.
   • <page>: Page template structure.
   • <style>: Page styles.

Choose exactly one mode for each page. Do not mix multi-file page definitions with an .ink file for the same route.

2. Single File Component (SFC) .ink Specification

In AIUI, page development is recommended to use the Single File Component (SFC) format, which is the .ink file. This format centralizes the page's configuration, logic, structure, and style in a single file.

A standard .ink file structure contains four main tag blocks:

1. <script def>: Used to define page-level JSON configuration, such as the navigation bar title.
2. <script setup>: Contains the page's JavaScript logic code, exporting the page configuration object (including data, lifecycle hooks, custom methods, etc.) via export default.
3. <page>: The page's template structure (WXML-like syntax).
4. <style>: The page's stylesheet (CSS).

2.1 .ink Example Code:

<script def>
{
  "navigationBarTitleText": "Home"
}
</script>

<script setup>
import wx from 'wx';

export default {
  data: {
    greeting: 'Hello AIUI!'
  },
  onLoad() {
    console.log('Page loaded');
  },
  handleTap() {
    this.setData({
      greeting: 'Hello, World!'
    });
  }
}
</script>

<page>
  <view class="container">
    <text class="title">{{ greeting }}</text>
    <button bindtap="handleTap">Click Me</button>
  </view>
</page>

<style>
.container {
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
  height: 100vh;
}

.title {
  font-size: 24px;
  margin-bottom: 20px;
}
</style>

3. WXML (WeiXin Markup Language) & Components

In AIUI, the structure of a page is described using WXML (WeiXin Markup Language), which is used within the <page> tag of an .ink file (or a standalone .wxml file). It allows you to build user interfaces using components, data binding, and conditional rendering.

3.1 Basic Syntax and Data Binding

WXML uses double curly braces {{ }} for data binding. You can bind properties from your page's data object directly to the UI.

<!-- Text binding -->
<view>{{ message }}</view>

<!-- Attribute binding -->
<view class="{{ dynamicClass }}"></view>

<!-- Expression binding -->
<view>{{ count + 1 }}</view>

3.2 Directives (Conditional Rendering and Lists)

AIUI supports conditional rendering using the ink:if, ink:elif, and ink:else directives to control whether a component is rendered based on a condition.

<view ink:if="{{condition === 1}}"> Rendered if condition is 1 </view>
<view ink:elif="{{condition === 2}}"> Rendered if condition is 2 </view>
<view ink:else> Rendered otherwise </view>

AIUI supports basic list rendering with ink:for, allowing you to repeat a component structure for each item in an array.

<view ink:for="{{cities}}" ink:key="name">
  <text>{{item.name}}</text>
  <text>{{item.temperature}}</text>
</view>

Use item to access the current element and index to access its position in the array. Prefer providing a stable ink:key when rendering dynamic collections.

Current Limitation: Nested ink:for is not supported yet. Keep list rendering to a single level, and flatten data in JavaScript first when you need to present hierarchical content.

3.3 Built-in Components

AIUI provides a set of built-in components that you can use within your WXML templates. These components are mapped to native implementations for optimal performance.

For parameter-by-parameter documentation, event behavior, content model notes, and examples, see components.md. The reference there is intentionally aligned with the current component registry and implementation details in ink-builtin-components.

For runtime API details, constructor behavior, supported overloads, and current implementation limits, see apis.md. Use the linked domain reference files there when you need Canvas, wx, device, media, or AI-specific details.

• <view>: The fundamental layout container, similar to <div> in HTML.
• <text>: Displays text content. Similar to <span> in HTML.
• <image>: Displays local or remote images.
• <button>: A standard clickable button component.
• <canvas>: A component for custom 2D drawing.
• <scroll-view>: A scrollable container for content that exceeds the visible area.
• <chart>: A chart component supporting Line, Area, Pie, and Radar charts.
• <lottie-view>: Renders Lottie animations from inline JSON, local files, or remote URLs.
• <error-state>: A compact status component that displays an optional icon with a message.

4. Events

Besides lifecycle callbacks, AIUI pages also support page-level event handlers for device input such as hardware keys and voice wakeup. These handlers are defined directly on the exported page object.

4.1 Page-Level Events

Page-level events are page methods, not WXML binding attributes. Use them when the page itself should react to framework-delivered input events.

export default {
  onKeyDown(event) {
    console.log('key down:', event.code);
  },

  onKeyUp(event) {
    console.log('key up:', event.code);
  },

  onVoiceWakeup(event) {
    console.log('voice wakeup:', event.keyword);
  }
}

Supported page-level event callbacks:

Callback	Description	Trigger
onKeyDown(event)	Handles page-level key press events	Triggered when a key is pressed
onKeyUp(event)	Handles page-level key release events	Triggered when a key is released
onVoiceWakeup(event)	Handles page-level voice wakeup events	Triggered when a wake word is detected

Some page-level events notify the page and then continue the host's built-in default behavior, such as navigating back, scrolling, or activating the focused target. For key events, those default actions are attached to the onKeyUp(event) phase, so interception only takes effect when the page prevents the keyup event.

export default {
  data: {
    status: 'idle'
  },

  onKeyUp(event) {
    if (event.code === 'Backspace') {
      event.preventDefault();
      this.setData({
        status: 'back action intercepted'
      });
    }
  }
}

Use these rules when handling page-level events:

• If event.preventDefault() is not called, the host may continue the event's default behavior after the callback finishes.
• event.preventDefault() may be called from different handlers, but for key events the host default behavior is defined on onKeyUp(event).
• For that reason, preventing a key event only takes effect when event.preventDefault() is applied to onKeyUp(event).
• Interception only matters for events that actually have host-level default behavior.

4.2 Default Behaviors

Some events in AIUI are not purely notifications. After the page-level callback runs, the host may still perform a built-in action unless the page explicitly intercepts it.

Common default behaviors include:

• Navigating back when the user presses Backspace
• Scrolling the current root container when the user presses ArrowUp or ArrowDown
• Activating the currently focused target or entering navigation mode when the user presses Enter
• Triggering host-defined behavior for device-specific keys when supported by the current runtime

For key events, use event.preventDefault() on onKeyUp(event) when the page needs to replace the host action with custom logic. This is appropriate when:

• The page manages its own back stack, dialog dismissal, or overlay closing behavior
• The page uses hardware keys for custom focus movement or shortcut handling
• The page wants to block host navigation until validation or confirmation is complete

Do not call event.preventDefault() unless the page will provide a clear replacement behavior. If you intercept a default action without updating UI state or performing an alternative action, the page may appear unresponsive.

export default {
  data: {
    dialogVisible: true,
    status: 'idle'
  },

  onKeyUp(event) {
    if (event.code === 'Backspace' && this.data.dialogVisible) {
      event.preventDefault();
      this.setData({
        dialogVisible: false,
        status: 'dialog closed instead of navigating back'
      });
    }
  }
}

4.3 Key Events

onKeyDown(event) is useful for immediate feedback when a hardware key is pressed, such as moving focus or reacting to directional input.

onKeyDown(event) is useful for transient feedback, but preventing it does not stop the host's key default behavior because those actions are processed on key release.

onKeyUp(event) is useful when the page needs to react after a key is released. It is also the effective interception point for key default behavior, because the host evaluates actions such as back, scroll, and activation on key release. In AIUI hosts such as Rokid Glasses, event.code commonly includes:

• Backspace: usually navigates back or requests app close unless intercepted
• ArrowUp: usually scrolls the root view upward unless intercepted
• ArrowDown: usually scrolls the root view downward unless intercepted
• Enter: usually enters navigation mode or activates the current target unless intercepted
• GlobalHook: a device-specific Rokid Glasses key code for hardware-side touch or shortcut input

Note: Use GlobalHook only when you need the fastest possible key response, such as game-style interactions. Its tradeoff is that it is invoked before other key handlers. If you need more consistent key behavior and can tolerate a little latency, it is not recommended.

export default {
  data: {
    status: 'idle'
  },

  onKeyDown(event) {
    if (event.code === 'Enter') {
      this.setData({
        status: 'enter pressed'
      });
    }
  },

  onKeyUp(event) {
    switch (event.code) {
      case 'Backspace':
        event.preventDefault();
        this.setData({ status: 'back action intercepted' });
        break;
      case 'ArrowDown':
        this.setData({ status: 'arrow down received' });
        break;
      case 'Enter':
        this.setData({ status: 'enter released' });
        break;
      case 'GlobalHook':
        this.setData({ status: 'temple button touched' });
        break;
      default:
        break;
    }
  }
}

4.4 Voice Wakeup Events

onVoiceWakeup(event) runs when the host reports a voice wakeup event. Read the matched wake word from event.keyword. Some hosts may also provide default handling for voice wakeup; whether interception is supported depends on the host implementation.

export default {
  data: {
    status: 'idle'
  },

  onVoiceWakeup(event) {
    if (event.keyword === 'leqi') {
      this.setData({
        status: 'voice wakeup received'
      });
    }
  }
}

5. WXSS (WeiXin Style Sheets)

WXSS is a style language used to describe the visual presentation of components. It is highly compatible with standard CSS and is used within the <style> block of an .ink file (or a standalone .wxss file).

For the current confirmed selector support, layout properties, styling properties, and explicitly unsupported authoring assumptions, see wxss.md.

5.1 Features

WXSS extends standard CSS with features tailored for mobile and wearable devices:

• @import: You can use the @import statement to import external style sheets.

@import "./common.wxss";

.box {
  width: 240px;
  height: 100px;
  background-color: #40FF5E;
}

5.2 Selectors

AIUI supports most standard CSS selectors:

• Class Selector (.class): The recommended way to style components.
• ID Selector (#id).
• Type Selector (element): e.g., view, text.
• Combinators: Grouping (A, B), Descendant (A B), Child (A > B).

Recommendation: Prioritize using Class Selectors to ensure optimal rendering performance.

5.3 Layout

AIUI supports both Flexbox and Grid layout through the Ink CSS engine.

• Flexbox is the primary and recommended choice for most one-dimensional layouts such as vertical stacks, horizontal toolbars, centered content, and card internals.
• Grid is supported for two-dimensional layouts where rows and columns need to be controlled together.

Supported Flexbox properties include:

• display: flex
• flex-direction
• flex-wrap
• justify-content
• align-items
• flex-grow
• flex-shrink
• flex-basis
• gap, row-gap, column-gap

Supported Grid properties include:

• display: grid
• grid-template-columns
• grid-template-rows
• grid-auto-columns
• grid-auto-rows
• grid-auto-flow
• grid-column, grid-column-start, grid-column-end
• grid-row, grid-row-start, grid-row-end
• grid-area
• align-content
• justify-items
• align-self
• justify-self
• gap, row-gap, column-gap

Prefer Flexbox when either layout model can work. Use Grid when the UI clearly benefits from explicit row and column placement.

.container {
  display: flex;
  flex-direction: column;
  align-items: center;
  justify-content: center;
  gap: 12px;
}

.dashboard {
  display: grid;
  grid-template-columns: 1fr 1fr;
  grid-template-rows: auto auto;
  gap: 12px;
}

5.4 Styling

AIUI supports a practical subset of CSS properties for visual styling. When generating styles, stay within the properties that are known to be supported by the Ink CSS engine.

Commonly supported styling properties include:

• Box model and sizing: width, height, min-width, min-height, max-width, max-height, margin, padding, box-sizing
• Positioning and overflow: position, inset, overflow, overflow-x, overflow-y, z-index
• Colors and backgrounds: color, background-color, custom properties, and var(--token) references
• Borders and outlines: border, border-width, border-style, border-color, border-radius, outline, outline-width, outline-style, outline-color, outline-offset
• Typography: font-size, line-height, font-weight, font-family, font-style, font-variant, text-align, white-space, word-break
• Effects and visibility: opacity, visibility, box-shadow, filter, transform, transform-origin
• Motion: transition, transition-property, transition-duration, transition-timing-function, transition-delay, animation, animation-name, animation-duration, animation-timing-function, animation-delay, animation-iteration-count, animation-direction, animation-fill-mode

Prefer simple, production-safe CSS. Do not assume browser-only features or unsupported CSS shorthands beyond what AIUI and Ink CSS explicitly support.

When styling AIUI interfaces:

• Prefer AIUI's built-in theme tokens instead of hardcoding colors, spacing, border widths, or radii
• Reference theme values with var(--token-name)
• Keep custom properties semantically named when introducing new local tokens

Built-in green theme token reference: