Skip to content

Fix of checkedValue behavior in Knockout #1982

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.

Sign up for GitHub

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

Merged
tomasherceg merged 1 commit into from
Jan 9, 2026
Merged

Fix of checkedValue behavior in Knockout #1982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/Framework/Framework/Resources/Scripts/knockout-latest.debug.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4547,7 +4547,10 @@ ko.bindingHandlers['checked'] = {
// When we're responding to the checkedValue changing, and the element is
// currently checked, replace the old elem value with the new elem value
// in the model array.
if (isChecked) {
if (isChecked
// we want to suppress this behavior in DotVVM - it will applies only to non-DotVVM checkboxes
&& !allBindings['has']('checkedArrayContainsObservables')
) {
ko.utils.addOrRemoveItem(writableValue, elemValue, true, checkedArrayContainsObservables, checkedValueComparer);
ko.utils.addOrRemoveItem(writableValue, saveOldValue, false, checkedArrayContainsObservables, checkedValueComparer);
}
Expand Down Expand Up @@ -5117,7 +5120,7 @@ ko.bindingHandlers['selectedOptions'] = {
previousScrollTop = element.scrollTop;

if (newValue && typeof newValue.length == "number") {
// touch all array elements, because the ko.utils.arrayIndexOf bellow unwraps everything with ko.dependencyDetection.ignore
// touch all array elements
ko.utils.arrayForEach(newValue, ko.utils.unwrapObservable);

ko.utils.arrayForEach(element.getElementsByTagName("option"), function(node) {
Expand Down
90 changes: 45 additions & 45 deletions src/Framework/Framework/Resources/Scripts/knockout-latest.js
View file
Open in desktop

Large diffs are not rendered by default.

18 changes: 18 additions & 0 deletions ...Samples/Common/ViewModels/ControlSamples/CheckBox/CheckBoxCheckedValueUpdatesViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using DotVVM.Framework.ViewModel;
using DotVVM.Framework.Hosting;

namespace DotVVM.Samples.Common.ViewModels.ControlSamples.CheckBox
{
public class CheckBoxCheckedValueUpdatesViewModel : DotvvmViewModelBase
{
public List<int> SelectedValues { get; set; } = new() { 2 };

public int FirstValue { get; set; } = 1;
}
}

54 changes: 54 additions & 0 deletions src/Samples/Common/ViewModels/ControlSamples/CheckBox/CheckBoxCollectionUpdatesViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using DotVVM.Framework.ViewModel;
using DotVVM.Framework.Hosting;

namespace DotVVM.Samples.Common.ViewModels.ControlSamples.CheckBox
{
public class CheckBoxCollectionUpdatesViewModel : DotvvmViewModelBase
{
public List<Item> Items { get; set; } =
[
new Item() { Id = 1, Name = "Parent 1" },
new Item() { Id = 2, Name = "Parent 2" },
];

public int SelectedItem { get; set; }

public List<Item> ChildItems { get; set; } = new();

public List<int> SelectedChildItems { get; set; } = new();


public void OnItemClick(Item item)
{
SelectedItem = item.Id;

ChildItems = SelectedItem switch {
1 => new List<Item>
{
new Item { Id = 11, Name = "Child 1-1" },
new Item { Id = 12, Name = "Child 1-2" },
},
2 => new List<Item>
{
new Item { Id = 21, Name = "Child 2-1" },
new Item { Id = 22, Name = "Child 2-2" },
new Item { Id = 23, Name = "Child 2-3" },
},
_ => throw new Exception()
};
}


public class Item
{
public int Id { get; set; }
public string Name { get; set; }
}
}
}

28 changes: 28 additions & 0 deletions src/Samples/Common/Views/ControlSamples/CheckBox/CheckBoxCheckedValueUpdates.dothtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
@viewModel DotVVM.Samples.Common.ViewModels.ControlSamples.CheckBox.CheckBoxCheckedValueUpdatesViewModel, DotVVM.Samples.Common

<!DOCTYPE html>

<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title>
</head>
<body>

<dot:CheckBox CheckedItems="{value: SelectedValues}"
CheckedValue="{value: FirstValue}"
Text="{value: $"checkedValue = {FirstValue}"}"/>

<dot:Button Text="Change checkedValue = 1"
Click="{staticCommand: FirstValue = 1}" />
<dot:Button Text="Change checkedValue = 2"
Click="{staticCommand: FirstValue = 2}" />

<dot:Repeater DataSource="{value: SelectedValues}" WrapperTagName="ul">
<li>{{value: _this}}</li>
</dot:Repeater>

</body>
</html>


29 changes: 29 additions & 0 deletions src/Samples/Common/Views/ControlSamples/CheckBox/CheckBoxCollectionUpdates.dothtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
@viewModel DotVVM.Samples.Common.ViewModels.ControlSamples.CheckBox.CheckBoxCollectionUpdatesViewModel, DotVVM.Samples.Common

<!DOCTYPE html>

<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title></title>
</head>
<body>

<dot:Repeater DataSource="{value: Items}">
<p>
<dot:LinkButton Text="{value: Name}" Click="{command: _root.OnItemClick(_this)}" />
</p>
</dot:Repeater>

<dot:Repeater DataSource="{value: ChildItems}">
<dot:CheckBox CheckedItems="{value: _root.SelectedChildItems}" CheckedValue="{value: Id}" Text="{value: Name}" />
</dot:Repeater>

<dot:Repeater DataSource="{value: SelectedChildItems}" WrapperTagName="ul">
<li>{{value: _this}}</li>
</dot:Repeater>

</body>
</html>


2 changes: 2 additions & 0 deletions src/Samples/Tests/Abstractions/SamplesRouteUrls.designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

101 changes: 100 additions & 1 deletion src/Samples/Tests/Tests/Control/CheckBoxTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
using DotVVM.Samples.Tests.Base;
using System.Linq;
using DotVVM.Samples.Tests.Base;
using DotVVM.Testing.Abstractions;
using Newtonsoft.Json;
using Riganti.Selenium.Core;
using Riganti.Selenium.DotVVM;
using Riganti.Selenium.Validators.Checkers.ElementWrapperCheckers;
using Xunit;
using Xunit.Abstractions;

Expand Down Expand Up @@ -209,6 +211,103 @@ public void Control_CheckBox_CheckBoxObjects()
});
}

[Fact]
public void Control_CheckBox_CheckBoxCheckedValueUpdates()
{
RunInAllBrowsers(browser => {
browser.NavigateToUrl(SamplesRouteUrls.ControlSamples_CheckBox_CheckBoxCheckedValueUpdates);

var checkbox = browser.Single("input[type=checkbox]");
var buttons = browser.FindElements("input[type=button]");
var selected = browser.Single("ul");

ValidateCheckBoxState(checkedValue: 1, selectedValues: [2], isChecked: false);

buttons[1].Click();
ValidateCheckBoxState(checkedValue: 2, selectedValues: [2], isChecked: true);
buttons[0].Click();
ValidateCheckBoxState(checkedValue: 1, selectedValues: [2], isChecked: false);

checkbox.Click();
ValidateCheckBoxState(checkedValue: 1, selectedValues: [2, 1], isChecked: true);
buttons[1].Click();
ValidateCheckBoxState(checkedValue: 2, selectedValues: [2, 1], isChecked: true);
checkbox.Click();
ValidateCheckBoxState(checkedValue: 2, selectedValues: [1], isChecked: false);

buttons[0].Click();
ValidateCheckBoxState(checkedValue: 1, selectedValues: [1], isChecked: true);
checkbox.Click();
ValidateCheckBoxState(checkedValue: 1, selectedValues: [], isChecked: false);

buttons[1].Click();
ValidateCheckBoxState(checkedValue: 2, selectedValues: [], isChecked: false);


void ValidateCheckBoxState(int checkedValue, int[] selectedValues, bool isChecked)
{
var selectedValuesInPage = selected.FindElements("li").Select(i => int.Parse(i.GetInnerText()));
Assert.Equal(selectedValues.Order(), selectedValuesInPage.Order());
Assert.Equal(checkbox.GetAttribute("value"), checkedValue.ToString());
Assert.Equal(isChecked, checkbox.IsSelected());
}
});
}

[Fact]
public void Control_CheckBox_CheckBoxCollectionUpdates()
{
RunInAllBrowsers(browser => {
browser.NavigateToUrl(SamplesRouteUrls.ControlSamples_CheckBox_CheckBoxCollectionUpdates);

var links = browser.FindElements("a");
var selected = browser.Single("ul");

ValidateState([], []);

links[0].Click();
ValidateState([], [false, false]);

browser.ElementAt("input[type=checkbox]", 0).Click();
ValidateState([11], [true, false]);

links[1].Click();
ValidateState([11], [false, false, false]);

browser.ElementAt("input[type=checkbox]", 1).Click();
ValidateState([11, 22], [false, true, false]);

browser.ElementAt("input[type=checkbox]", 2).Click();
ValidateState([11, 22, 23], [false, true, true]);

links[0].Click();
ValidateState([11, 22, 23], [true, false]);

links[1].Click();
ValidateState([11, 22, 23], [false, true, true]);

browser.ElementAt("input[type=checkbox]", 1).Click();
ValidateState([11, 23], [false, false, true]);

links[0].Click();
ValidateState([11, 23], [true, false]);

browser.ElementAt("input[type=checkbox]", 0).Click();
ValidateState([23], [false, false]);

links[1].Click();
ValidateState([23], [false, false, true]);

void ValidateState(int[] selectedValues, bool[] checkboxStates)
{
var selectedValuesInPage = selected.FindElements("li").Select(i => int.Parse(i.GetInnerText()));
Assert.Equal(selectedValues.Order(), selectedValuesInPage.Order());

var checkboxStatesInPage = browser.FindElements("input[type=checkbox]").Select(c => c.IsSelected());
Assert.Equal(checkboxStates, checkboxStatesInPage);
}
});
}
public CheckBoxTests(ITestOutputHelper output) : base(output)
{
}
Expand Down