-
Notifications
You must be signed in to change notification settings - Fork 3
Description
Description:
When defining custom component variables in a ComponentDefinition, the description property is supposed to render in the Experiences UI sidebar to guide editors. However, even though the schema supports description (and the docs confirm it), nothing is displayed in the sidebar.
Steps to reproduce:
-
Add a variable in a component definition with a
descriptionproperty, e.g.:myVariable: { displayName: 'Example Variable', type: 'Text', description: 'This is a description that should appear in the sidebar.', group: 'content', }
-
Push the component into Contentful Studio.
-
Inspect the variable in the Experiences UI sidebar.
Expected behavior:
The description text should appear in the sidebar below the control (as documented here: https://www.contentful.com/developers/docs/experiences/component-definition-schema/#variables).
Actual behavior:
No description is rendered in the sidebar. Only the display name, control, and other options (target, defaultValue, etc.) show up.
Screenshots:
-
Sidebar UI: no descriptions visible
Environment:
- Contentful Studio (Experiences UI)
- Schema:
ComponentDefinitionwithvariables
Notes:
It looks like the description field is being ignored by the UI layer. This makes it harder to guide editors, since they don’t see the purpose or usage hints we add in the schema.


