From bac107e36826786d8ae0e2e22402ffbb987b985d Mon Sep 17 00:00:00 2001
From: Guy Sartorelli <36352093+GuySartorelli@users.noreply.github.com>
Date: Mon, 25 Nov 2024 10:30:51 +1300
Subject: [PATCH] DOC Document including attributes in formfield schema data
 (#630)

---
 en/08_Changelogs/6.0.0.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/en/08_Changelogs/6.0.0.md b/en/08_Changelogs/6.0.0.md
index cab26371..914127da 100644
--- a/en/08_Changelogs/6.0.0.md
+++ b/en/08_Changelogs/6.0.0.md
@@ -37,6 +37,7 @@ title: 6.0.0 (unreleased)
   - [`DBDecimal` default value](#dbdecimal-default-value)
   - [`RedirectorPage` validation](#redirectorpage-validation)
   - [Update JS MIME type, remove `type` in `<script>` tags](#js-mime-type-update)
+  - [`getSchemaDataDefaults()` now includes attributes](#formfield-schema-data)
 - [Full list of removed and changed API (by module, alphabetically)](#api-removed-and-changed)
 
 ## Features and enhancements
@@ -932,6 +933,28 @@ We've updated the MIME type for JavaScript from `"application/javascript"` to `"
 
 This change is generally backward-compatible and should not affect existing functionality. However, if your project explicitly relies on the `type` attribute for `<script>` tags, you may need to adjust accordingly.
 
+### `getSchemaDataDefaults()` now includes attributes {#formfield-schema-data}
+
+The [`FormField::getSchemaDataDefaults()`](api:SilverStripe\Forms\FormField::getSchemaDataDefaults()) method (and by extension the [`getSchemaData()`](api:SilverStripe\Forms\FormField::getSchemaData()) method) now calls [`getAttributes()`](api:SilverStripe\Forms\FormField::getAttributes()). This was done so that attributes such as `placeholder` can be used in the react components that render form fields.
+
+In the past it was common to call `getSchemaData()` inside the `getAttributes()` method, so that a form field rendered in an entwine admin context had the data necessary to bootstrap a react component for that field. Doing that now would result in an infinite recursion loop.
+
+If you were calling `getSchemaData()` in your `getAttributes()` method in a `FormField` subclass include `$SchemaAttributesHtml` in your template instead. For example:
+
+```diff
+-public function getAttributes()
+-{
+-    $attributes = parent::getAttributes();
+-    $attributes['data-schema'] = json_encode($this->getSchemaData());
+-    return $attributes;
+-}
+```
+
+```diff
+-<div $AttributesHTML></div>
++<div $AttributesHTML $SchemaAttributesHtml></div>
+```
+
 ### Full list of removed and changed API (by module, alphabetically) {#api-removed-and-changed}
 
 <!--- Changes below this line will be automatically regenerated -->