# Related Record Summary Grid

## Short Description

Related Record Summary Grid - reusable Yeeflow component for showing related records inline as cards or table rows.

## Purpose / What This Is For

Shows key related records without leaving the current form or dashboard.

## Supported Placement

Approval form; Dashboard

## When To Use

Use this template when teams need a reusable Yeeflow control for case context, order context, asset context, and related list summaries.

## Recommended Defaults

Start with the required source/save parameters, keep labels concise, and test with a small data set before publishing.

## Input Parameters Overview

| Parameter | Type | Purpose |
| --- | --- | --- |
| `targetListId` | `variable` | Related data list ID. |
| `relationField` | `variable` | Field used to match relation. |
| `relationValue` | `variable` | Current relation value. |
| `displayedFieldsJson` | `variable` | JSON/comma list of fields to display. |
| `displayType` | `string` | card or table. |
| `titleField` | `variable` | Primary field. |
| `statusField` | `variable` | Status field. |
| `titleText` | `string` | Panel title. |
| `subtitleText` | `string` | Panel subtitle. |
| `maxItems` | `string` | Max records. |
| `emptyText` | `string` | Empty text. |
| `filterExpression` | `variable` | Optional filter. |

## Detailed Parameter Explanation

Configure expression-editor parameters with Yeeflow fields, variables, temp variables, or static values as appropriate. Writable target parameters save output values and are resolved defensively at runtime. Plain text parameters control display labels and helper text.

## Step-By-Step Setup

1. Add a Custom Code control to the supported Yeeflow placement.
2. Paste the `related-record-summary-grid.tsx` code file.
3. Configure required data source, field, and save-target parameters.
4. Configure labels, limits, and display options.
5. Preview with realistic records.
6. Confirm readonly, empty, and validation states.
7. Publish when behavior is correct.

## Result / Expected Output

A compact card grid or table of related records filtered by relation field/value.

## Real Business Examples

- Procurement approval and vendor review.
- Case, request, or task management.
- Policy, compliance, and operational control checks.
- Department, location, product, or category-driven workflows.

## Notes / Assumptions / Limitations

- Runtime query behavior uses `yeeSDKClient.lists.queryItems(...)` where list data is needed.
- Expression-editor values are normalized from strings, booleans, objects, arrays, and variable selector values.
- Writable targets use defensive setter paths and a local `fieldsValues` fallback.
- Tenant-specific query filter shapes may require adjustment in `filterExpression`.

## Testing Checklist

- Required parameters configured.
- Empty state displays safely.
- Existing saved values initialize correctly when applicable.
- Save targets update as expected when applicable.
- Readonly mode prevents editing.
- Narrow layout remains readable.

## Troubleshooting

If data does not appear, verify list ID, field IDs, filter expression, and permissions. If saving does not work, confirm the target parameter was selected as a writable form field or variable and that the field exists on the form.
