steedos-object-fields

Define and validate Steedos object fields in .field.yml files.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Fields define how data is stored, validated, and displayed across Steedos objects, and configuring them through .field.yml files for each field can be error-prone without a clear guide. This skill consolidates material on all Steedos field types and the .field.yml configuration, including how to model relationships and computed fields, and how to drive UI behavior with Amis schema. The guidance covers fields living in objects/{name}/fields/.

Core Features & Use Cases

  • Defines fields as individual .field.yml files under objects/{name}/fields/ and documents essential properties like name, type, label, required, index, searchable, filterable, sortable, and group.
  • Covers valid field types (text, number, currency, select, lookup, master_detail, formula, summary, file, image, location, etc.) and illustrates common configurations for relationships and computed fields.
  • Provides practical examples and best practices to tailor field behavior, validation, defaults, and UI customization for Steedos apps.

Quick Start

Create or edit a field YAML file under objects/{name}/fields/ to define a new field using the provided examples.

Frequently Asked Questions about steedos-object-fields

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

FAQPage Schema
How do I define object fields in YAML for Steedos?

You define Steedos object fields by creating .field.yml files under objects/{name}/fields/ with required keys name, type, and label. This enforces a consistent structure for data storage, validation, and display across your apps.

What field types are supported when defining Steedos object fields?

Supported Steedos field types include text, number, currency, select, lookup, master_detail, formula, summary, file, image, and location. These types allow you to model relationships and computed fields within your YAML configuration.

How do I configure relationships between objects using lookup and master_detail fields?

You configure object relationships by setting the field type to lookup or master_detail in your .field.yml file. Lookup creates a reference to another object, while master_detail establishes a tighter parent-child relationship with cascading behaviors.

Can I create computed fields like formula and summary in Steedos YAML?

Yes, you can create computed fields by setting the field type to formula or summary in your .field.yml file. Formula fields calculate values dynamically, while summary fields aggregate data from related child records.

What are the required properties for a Steedos .field.yml file?

A Steedos .field.yml file requires three essential properties: name, type, and label. You can also add optional properties like required, index, searchable, filterable, sortable, and group to control field-level behaviors.

How do I customize the UI behavior of Steedos object fields?

You customize Steedos field UI behavior by applying Amis schema within your .field.yml configuration. This allows you to drive interface customization and field interactions directly alongside your field definitions.