Skip to content

Checkbox list UI - Does not update if the model changes. #19437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
readingdancer opened this issue May 27, 2025 · 1 comment
Open

Checkbox list UI - Does not update if the model changes. #19437

readingdancer opened this issue May 27, 2025 · 1 comment
Labels

Comments

@readingdancer
Copy link
Contributor

Which Umbraco version are you using?

15.4.1

Bug summary

Fixes an issue where the CheckboxList property editor UI doesn't update to show selected items when values are set programmatically (e.g., through API calls setValue etc).

Specifics

Problem:
The value setter in UmbPropertyEditorUICheckboxListElement updates the internal selection but doesn't update the checked state of items in the _list array, causing the UI to show stale checkbox states until page refresh.

Solution:
Added #updateCheckedState() method that synchronizes the checked property of list items with the current selection, and calls it from the value setter.

Testing:

  • Set checkbox values programmatically via API
  • Verify UI immediately reflects the new selection
  • Ensure existing functionality remains unchanged

Steps to reproduce

  1. Create a document type with a CheckBoxList property editor
  2. Configure the CheckBoxList with multiple options (e.g., "Option 1", "Option 2", "Option 3")
  3. Create a document using this document type
  4. Set values programmatically via JavaScript (e.g., through a custom property editor or API call):
  element.value = ["Option 1", "Option 3"];

Apply

Observe the UI state immediately after setting the value, you will find that nothing changes, even though the data has changed.

If you save the document and refresh the page, your selections will be visible.

Expected result / actual result

Expected results

The checkbox list UI should immediately update to show "Option 1" and "Option 3" as checked, reflecting the programmatically set values.

Actual results

The checkbox list UI does not update - no checkboxes appear selected even though the underlying value property contains the correct data. The correct selections only become visible after saving the document and refreshing/reloading the page.

Copy link

Hi there @readingdancer!

Firstly, a big thank you for raising this issue. Every piece of feedback we receive helps us to make Umbraco better.

We really appreciate your patience while we wait for our team to have a look at this but we wanted to let you know that we see this and share with you the plan for what comes next.

  • We'll assess whether this issue relates to something that has already been fixed in a later version of the release that it has been raised for.
  • If it's a bug, is it related to a release that we are actively supporting or is it related to a release that's in the end-of-life or security-only phase?
  • We'll replicate the issue to ensure that the problem is as described.
  • We'll decide whether the behavior is an issue or if the behavior is intended.

We wish we could work with everyone directly and assess your issue immediately but we're in the fortunate position of having lots of contributions to work with and only a few humans who are able to do it. We are making progress though and in the meantime, we will keep you in the loop and let you know when we have any questions.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant