Added 4.x upgrade doc highlighting breaking changes

rjsf-team · Sep 3, 2021 · 93c278b · 93c278b
1 parent adf3388
commit 93c278b
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/4.x upgrade guide.md b/docs/4.x upgrade guide.md
@@ -0,0 +1,13 @@
+# 4.x Upgrade Guide
+
+## Breaking changes
+
+### ObjectFieldTemplate Title
+
+Object fields can get title through 3 mechanisms namely, `schema`, `ui:title` and `ui:options{title}`. 4.x breaks the precedence of the title string amongst these 3 options.
+
+The new order of precedence is as follow `schema < ui:title < ui:options{title}`.
+
+Thus if you specify a title in ui:options, it will override the title provided in ui:title and the schema itself.
+
+This change was put in place to bring consistency between various fields.