steedos-object-buttons

Define YAML-based action buttons for Steedos objects with Amis schema.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-object-buttons
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-object-buttons
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-object-buttons
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-object-buttons

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Buttons are essential for extending Steedos objects, but building custom actions requires coordinating YAML definitions with Amis UI and consistent visibility and event handling. This skill provides a standardized pattern to define object buttons in a portable, YAML-based format.

Core Features & Use Cases

  • Defines custom actions as YAML files inside an object's buttons/ directory.
  • Enforces Amis schema root to be a service wrapper for reliable rendering.
  • Supports multiple events (ajax, dialog, reload, broadcast) and complex workflows across record and list views.
  • Includes bilingual guidance and standard button overrides to hide or customize built-in actions.

Quick Start

To add a new action, create a .button.yml under objects/{objectName}/buttons/ with an amis_schema block wrapped as a service object.

Frequently Asked Questions about steedos-object-buttons

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add custom actions to Steedos object record pages?

To add custom actions to Steedos object record pages, create a .button.yml file inside the object's buttons/ directory. This YAML-driven approach defines custom actions with visibility rules, dialogs, and AJAX calls for both record pages and list views.

How does Amis schema work for Steedos object buttons?

The Amis schema for Steedos object buttons must be wrapped as a service object to ensure reliable rendering. This root service wrapper supports multiple events including ajax, dialog, reload, and broadcast for complex workflow execution.

Can I hide or customize built-in buttons in Steedos?

Yes, you can hide or customize built-in buttons in Steedos using standard button overrides. The YAML-based button configuration supports overriding default actions to modify visibility or replace built-in behavior on record and list views.

What's the best way to define multi-action workflows in Steedos YAML buttons?

The best way to define multi-action workflows in Steedos is through YAML button files that coordinate multiple events like ajax, dialog, reload, and broadcast. These configurations operate across record and list views for complex behavior execution.

Does Steedos support YAML-driven visibility rules for object buttons?

Yes, Steedos supports YAML-driven visibility rules for object buttons. Defined within .button.yml files in the objects/{name}/buttons directory, these rules control when custom actions appear on record pages and list views.