You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: update docs to match actual RJSF implementation
- Remove `format: "select"` from formats table (not a distinct format)
- Add `options.documentation` to supported options (link icon with tooltip)
- Note that `options.tooltip` supports Markdown
- Fix `enumSource`/`watch` — NOT deprecated, still supported (moved to Legacy)
- Mark `links` as deprecated (not supported in RJSF), suggest `options.documentation`
- Add examples for tooltips and documentation links
- Add `options.documentation` migration example in Links section
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@@ -59,7 +58,8 @@ The following `options` keys can be used in property definitions:
59
58
|`options.dependencies`| Conditional field visibility based on other field values. See [Dynamic Options](/extend/component/ui-options/configuration-schema/examples/#changing-set-of-options-dynamically-based-on-selection). |
60
59
|`options.tags`| Enable tag-style input for multi-select arrays |
61
60
|`options.creatable`| Allow user-created values in select dropdowns |
62
-
|`options.tooltip`| Help text displayed as a tooltip |
61
+
|`options.tooltip`| Help text displayed as a tooltip icon next to the field label. Supports Markdown syntax. |
62
+
|`options.documentation`| Documentation link rendered as a book icon next to the field label. Value: `{ "link": "https://...", "tooltip": "optional hover text" }`|
63
63
|`options.enum_titles`| Display labels for `enum` values |
64
64
|`options.hidden`| Hide the field from the UI |
65
65
|`options.collapsed`| Start object sections in collapsed state |
@@ -143,8 +143,30 @@ The form above can be created using this JSON Schema:
143
143
{% endhighlight %}
144
144
145
145
### Links Example
146
-
If you want to provide links to external resources, keep in mind that the configuration schema does not support markdown,
147
-
but it has a `links` feature. The above example can be modified so that the links are clickable:
146
+
147
+
***Note:** The `links` feature is deprecated. Use `options.documentation` instead (see [Supported Options](#supported-options)).*
148
+
149
+
If you want to provide links to external resources, use `options.documentation` to add a clickable documentation icon next to the field label:
150
+
151
+
{% highlight json %}
152
+
{
153
+
"dateFrom": {
154
+
"title": "Date from",
155
+
"type": "string",
156
+
"description": "Any date accepted by the strtotime function",
The old `links` property is **no longer supported**. If you have existing schemas using it, migrate to `options.documentation`:
148
170
149
171
{% highlight json %}
150
172
{
@@ -209,8 +231,14 @@ Which renders like this:
209
231
{: .image-popup}
210
232

211
233
234
+
### Legacy Features
235
+
236
+
The following features are still supported for backwards compatibility but have preferred alternatives:
237
+
238
+
-**`enumSource` / `watch`** — Dynamic enum population based on other field values. For new schemas, prefer `options.async` with sync actions instead. See [Sync Action Examples](/extend/component/ui-options/configuration-schema/sync-action-examples/#autoload).
239
+
212
240
### Deprecated Features
213
241
214
242
The following features from the legacy JSON Editor library are **no longer supported**:
215
243
216
-
-**`enumSource` / `watch`** — Dynamic enum population based on other field values. Use `options.async` with `autoload` instead for cascading dropdowns. See [Sync Action Examples](/extend/component/ui-options/configuration-schema/sync-action-examples/#autoload).
244
+
-**`links`** — Clickable links on field descriptions. Use `options.documentation` with `link` and optional `tooltip` instead.
0 commit comments