Skip to content
Brok UI

Loading…

No results

AI Function Call

Open source

Tool-invocation card showing the function name, status badge and arguments.

Version
v1.0.4
Stability
stable
License
MIT
Related
AI Chain of Thought
AI Prompt
Code Block

Preview

get_weather() Success
location
Berlin
unit
celsius
previews.components.ai-function-call.default.blade.php Blade
<x-ui.ai.function-call name="get_weather" :arguments="['location' => 'Berlin', 'unit' => 'celsius']" status="success" class="mx-auto w-full max-w-md" />

Installation

terminal
php artisan ui:add ai-function-call

Registry contract

php artisan ui:add ai-function-call writes only the files below. The CLI validates each file hash before writing and asks before it replaces a local change, unless you pass --force.

  • blade resources/views/components/ui/ai/function-call.blade.php
Registry dependencies
None — installs on its own.
Packages
composer: jml/brok:^0.2

Use with AI

A brief for your coding agent: install command, usage, props, guidance and the rules. Copy it, or open a prompt about this component in an assistant.

ai-function-call.md
# Brok UI: AI Function Call (`ai-function-call`)

Tool-invocation card showing the function name, status badge and arguments.

Brok UI is a Laravel Blade component registry. Installed components are plain Blade files the app owns.

## Install

```bash
php artisan ui:add ai-function-call
```

## Usage

```blade
<x-ui.ai.function-call name="get_weather" :arguments="['location' => 'Berlin', 'unit' => 'celsius']" status="success" class="mx-auto w-full max-w-md" />
```

## Props

- `name` (string, default `get_weather`)
- `arguments` (array, default `['location' => 'Berlin', 'unit' => 'celsius']`)
- `status` (string, default `success`)

## Use when

- Use to expose AI-specific prompts, states, or reasoning metadata when those details help users supervise or understand an AI workflow.
- Showing that an assistant invoked a tool, with the arguments it sent.
- Making a tool-use step visible inside a chat thread or an agent trace.

## Avoid when

- Do not surface internal AI mechanics when they add confusion or implementation detail without user value.
- Showing a tool's result body; put that in a code-block or the following message.
- Rendering source code; this displays a named call and its argument list.

## Anti-patterns

- Decorative AI chrome
- Exposing internal mechanics without user value

## Rules

- Use the `<brok:ai-function-call>` tag (or `<x-ui.ai-function-call>`) in Blade; do not rewrite the component.
- Prefer the documented props and variants over utility-class overrides; when a utility must win, use the `!` important modifier.
- Use semantic design tokens (`bg-primary`, `text-muted-foreground`), never raw colour utilities.
- Keep the `data-slot` attributes; they are the styling and test hooks.

## Links

- Docs: https://brokui.dev/docs/components/ai-function-call
- Registry JSON (files, props, contract): https://brokui.dev/r/open/ai-function-call.json

Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.

API

manifest knowledge + registry-derived coverage

Props

Props accepted by this component: name, type, default value and description.
Prop Type Default Description
name string get_weather
arguments array ['location' => 'Berlin', 'unit' => 'celsius']
status string success

Slots

  • default —

Data slots

Stable hooks for CSS overrides and browser tests.

ai-function-call

Behavior

  • arguments render as key and value pairs in a monospace list, in the order given.
  • status drives the badge, so a pending, failed or successful call reads at a glance.
  • Declares registry capability flags: a11y, responsive, rtl, darkMode, localized.

Guidance

AI-assisted interaction

Help users prompt, inspect, or supervise an AI-assisted operation.

Use when

  • Use to expose AI-specific prompts, states, or reasoning metadata when those details help users supervise or understand an AI workflow.
  • Showing that an assistant invoked a tool, with the arguments it sent.
  • Making a tool-use step visible inside a chat thread or an agent trace.

Avoid when

  • Do not surface internal AI mechanics when they add confusion or implementation detail without user value.
  • Showing a tool's result body; put that in a code-block or the following message.
  • Rendering source code; this displays a named call and its argument list.

Use instead

  • Deterministic conventional workflow

Anti-patterns

  • Decorative AI chrome
  • Exposing internal mechanics without user value
Anatomy
root
Theming hooks
ai-function-call

Accessibility

WCAG 2.2 AA Keyboard focus-visible RTL-ready Localized labels Dark mode
Keyboard
No component-owned keyboard interaction; native element behavior applies.
Focus
none
  • The function name and status are text, so the call is announced without relying on the badge colour.
  • Decorative icons are aria-hidden.
  • Semantic HTML and a stable data-slot attribute for styling and scripting hooks.
  • Focus-visible rings use the ring token, so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces in the preview.
  • Labels go through __() and layout uses logical properties (ms-*, text-start), so it mirrors under dir="rtl" — flip the preview to RTL to confirm.
  • Dark mode uses the same semantic tokens under the dark class; high contrast follows forced-color system tokens.

Livewire

Safe

Livewire can update this component through forwarded wire:* attributes.

Source

The exact, editable file ui:add writes into your app. Previews render this same code; there are no preview-only components.

resources/views/components/ui/ai/function-call.blade.php Blade
@props([
    'name' => 'get_weather',
    'arguments' => ['location' => 'Berlin', 'unit' => 'celsius'],
    'status' => 'success',
])

@php
    // Normalise arguments: accept an assoc array or a JSON string.
    $args = $arguments;
    if (is_string($args)) {
        $decoded = json_decode($args, true);
        $args = json_last_error() === JSON_ERROR_NONE ? $decoded : [];
    }
    $args = is_array($args) ? $args : [];

    // Map status → human label and semantic badge colour. The running state adds
    // a motion-gated pulse so it reads as in-flight without animating on its own.
    $map = [
        'pending' => ['label' => __('Pending'), 'badge' => 'bg-muted text-muted-foreground'],
        'running' => ['label' => __('Running'), 'badge' => 'bg-info/10 text-info'],
        'success' => ['label' => __('Success'), 'badge' => 'bg-success/10 text-success'],
        'error' => ['label' => __('Error'), 'badge' => 'bg-destructive/10 text-destructive'],
    ];
    $current = $map[$status] ?? $map['success'];
@endphp

{{--
    AI function call — a card describing a tool invocation. The header pairs a
    function glyph with the monospaced name() and a status badge; the body lists
    the arguments as key/value rows (monospaced keys + values). The running badge
    gets a subtle ui-ai-fn-pulse, gated behind motion-safe.
--}}
<div
    data-slot="ai-function-call"
    {{ $attributes->merge(['class' => 'overflow-hidden rounded-lg border border-border bg-card text-foreground']) }}
>
    <div class="flex items-center gap-2 border-b border-border px-3 py-2">
        <svg class="size-4 shrink-0 text-muted-foreground" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="m18 16 4-4-4-4"/><path d="m6 8-4 4 4 4"/><path d="m14.5 4-5 16"/></svg>
        <code class="min-w-0 flex-1 truncate font-mono text-sm">{{ $name }}()</code>
        <span @class([
            'inline-flex items-center gap-2 rounded-full px-2 py-0.5 text-xs font-medium',
            $current['badge'],
            'motion-safe:animate-[ui-ai-fn-pulse_1.4s_ease-in-out_infinite]' => $status === 'running',
        ])>
            @if ($status === 'running')
                <span class="size-2 rounded-full bg-current" aria-hidden="true"></span>
            @endif
            {{ $current['label'] }}
        </span>
    </div>

    @if (count($args) > 0)
        <dl class="divide-y divide-border">
            @foreach ($args as $key => $value)
                <div class="flex items-start gap-3 px-3 py-2 text-xs">
                    <dt class="shrink-0 font-mono text-muted-foreground">{{ $key }}</dt>
                    <dd class="min-w-0 flex-1 break-words text-end font-mono">{{ is_scalar($value) ? $value : json_encode($value) }}</dd>
                </div>
            @endforeach
        </dl>
    @else
        <p class="px-3 py-2 text-xs text-muted-foreground">{{ __('No arguments') }}</p>
    @endif
</div>

Ownership & lifecycle

Owner, release state, review evidence and adoption for this item.
Owner
Platform UI (@JoshJML)
Current version
1.0.4
Status
Stable
License
open
Accessibility reviewed
No review date recorded
Last breaking change
No date recorded
Deprecation
Not deprecated
Contract
v6
Foundation
≥ 1.0.0