Skip to content

feat: add widget properties documentation template and Data Grid 2 props#2231

Open
iobuhov wants to merge 1 commit into
mendix:mainfrom
iobuhov:feat/prop-spec
Open

feat: add widget properties documentation template and Data Grid 2 props#2231
iobuhov wants to merge 1 commit into
mendix:mainfrom
iobuhov:feat/prop-spec

Conversation

@iobuhov
Copy link
Copy Markdown
Collaborator

@iobuhov iobuhov commented May 26, 2026

Summary

Add a standardized template for documenting widget properties and generate comprehensive documentation for Data Grid 2.

Changes

  1. Widget Properties Template (.agents/templates/widget-props.md)

    • 5-column table format: Property, Type, Default, Required, Description
    • Clear placeholders for property groups and nested objects
    • Instructions for documenting enumerations consistently
    • Example section showing proper usage (marked to exclude from final docs)
  2. Data Grid 2 Properties Documentation (packages/pluggableWidgets/datagrid-web/props.md)

    • Complete documentation of 60+ properties
    • Organized by Studio Pro property groups (General, Behavior, Personalization, Texts)
    • All enumeration values documented with key, label, and description
    • Nested properties (column configuration) properly structured
    • Type constraints documented for attributes and expressions

Template Features

  • Property table: Captures key, type, default value, required status, and description
  • Enumeration documentation: Consistent format for enum values with XML key, Studio Pro label, and description
  • Nested objects: Clear structure for object lists (e.g., column properties)
  • Type constraints: Documents attribute types, return types, and data source references
  • Hierarchical sections: Matches Studio Pro property group organization

🤖 Generated with Claude Code

- Add widget-props.md template in .agents/templates/ with clear placeholders
- Include instructions for documenting enumerations consistently
- Generate comprehensive props.md for Data Grid 2 widget
- Document all 60+ properties organized by Studio Pro groups

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@iobuhov iobuhov requested a review from a team as a code owner May 26, 2026 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant