Versions Compared

Old Version 3

changes.mady.by.user GE-DevDoc-Bot

Saved on

compared with

New Version 4

changes.mady.by.user GE-DevDoc-Bot

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Capture multilingual copy and bind it for submission via dataField and controlsRequestType (e.g., send in BODY).
  • Localize the field label with labelTranslations.
  • Pre-populate known strings with defaultValue.
  • Preserve in-progress work across reloads with saveInLocalStorage.

Sizing & Layout

  • Adjust spacing around the control using paddingClass.
  • Keep labels concise in labelTranslations to maintain compact layout.

States & Feedback

  • Visibility: Control presence with hidden and displayConditions.
  • Editability: Present as view-only with readonly.
  • Validity: Enforce required locales/limits with validation; react to changes via events.ON_VALUE_CHANGE.

Data-Driven / Conditional Behavior

  • Specify required locales and character limits with validation.
  • Establish consistent baselines with defaultValue.

Visibility & Authorization

  • Gate visibility with visibilityPolicySetId.
  • When users may view but not edit, disable interaction with authorizationDisable and clarify state via readonly.

Content & Localization

  • Provide localized onboarding for tours with enableAsHotspot, guidedTourHotSpotTitle, and guidedTourHotSpotDescription.
  • Ensure serialized output keys are correct using dataField and controlsRequestType.

Dos & Don’ts

DoDon’tArticle setting(s)
Localize the field label for every supported locale.Hard-code an English-only label.labelTranslations
Pre-fill known strings to reduce work.Make users retype baseline text.defaultValue
Require critical locales before submit.Rely on color or external notes to mark a locale as required.validation
Keep the control visible but read-only when users must see but not change text.Hide the control when users still need to read it.readonly, authorizationDisable
Persist drafts across reloads for long tasks.Risk losing work on refresh or navigation.saveInLocalStorage
Show the control only when prerequisites are met.Show it at all times and confuse users.displayConditions, hidden
Initialize data on mount and clean up on unmount.Fetch on first keystroke and leak listeners.ON_INIT, ON_DESTROY, events
Bind the field to the correct submission path.Submit translations under an unexpected key or location.dataField, controlsRequestType
Provide stable automation hooks.Select the control by label text in tests.id, dataTestId
Localize guided-tour copy for onboarding.Use English-only hotspot guidance.enableAsHotspot, guidedTourHotSpotTitle, guidedTourHotSpotDescription

...