Skip to content

[Button] Fix click sound for checkable button #4967

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Button] Fix click sound for checkable button #4967

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
13 changes: 11 additions & 2 deletions lib/java/com/google/android/material/button/MaterialButton.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
import android.util.AttributeSet;
import android.util.Log;
import android.view.Gravity;
import android.view.SoundEffectConstants;
import android.view.View;
import android.view.accessibility.AccessibilityEvent;
import android.view.accessibility.AccessibilityNodeInfo;
Expand Down Expand Up @@ -1346,11 +1347,19 @@ public void toggle() {

@Override
public boolean performClick() {
if (isEnabled() && materialButtonHelper.isToggleCheckedStateOnClick()) {
Copy link
Contributor

@dsn5ft dsn5ft Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pubiqq thanks for the PR - can you explain why the isEnabled() check is removed? is it because perfomClick() should already never be called if the button is disabled? if so, I agree that the user can't click a disabled button, but it's possible that this method is called programmatically on a disabled button, so maybe we should keep it and do isEnabled() && isCheckable() && materialButtonHelper.isToggleCheckedStateOnClick()?

Copy link
Contributor Author

@pubiqq pubiqq Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Components such as android.widget.Button and android.widget.CheckBox perform click actions when the performClick method is called, even if they're disabled. I see no reason why the MaterialButton should be any different.

Also, the original implementation is incorrect because clicking on the disabled button works inconsistently; it doesn't invoke the toggle() method, but still performs click actions.

final boolean checkable = isCheckable() && materialButtonHelper.isToggleCheckedStateOnClick();
if (checkable) {
toggle();
}

return super.performClick();
final boolean handled = super.performClick();
if (checkable && !handled) {
// View only makes a sound effect if the onClickListener was
// called, so for checkable button we'll need to make one here instead.
playSoundEffect(SoundEffectConstants.CLICK);
}

return handled;
}

/**
Expand Down
1 change: 0 additions & 1 deletion lib/java/com/google/android/material/button/MaterialButtonToggleGroup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,6 @@ void onButtonCheckedStateChanged(@NonNull MaterialButton button, boolean isCheck
if (skipCheckedStateTracker) {
return;
}
button.playSoundEffect(SoundEffectConstants.CLICK);
checkInternal(button.getId(), isChecked);
}
}
2 changes: 0 additions & 2 deletions lib/java/com/google/android/material/button/MaterialSplitButton.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,6 @@ public void addView(@NonNull View child, int index, @Nullable ViewGroup.LayoutPa

buttonChild.addOnCheckedChangeListener(
(button, isChecked) -> {
// Play sound effect when checked state changes.
button.playSoundEffect(SoundEffectConstants.CLICK);
// Update content description when checked state changes.
ViewCompat.setStateDescription(
buttonChild,
Expand Down