[Due for payment 2025-04-23] [$250] Checkbox on Reports table header does not show indeterminate state

[dannymcclain]

Problem

Currently on the Reports page, the checkbox in the table does not show the indeterminate state—it only shows either checked or unchecked (marked or unmarked).

Solution

Update the behavior of the table header checkbox to work as follows:

• With no items selected: unchecked state
• With some, but not all, items selected: indeterminate state
• With all items selected: checked state

Note

Clicking on the checkbox in the indeterminate state should uncheck any items that are currently checked.

Slack thread for reference.

Mocks

None selected

Some selected

All selected

cc @Expensify/design @JmillsExpensify @iwiznia

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021904978587121878600
• Upwork Job ID: 1904978587121878600
• Last Price Increase: 2025-03-26
• Automatic offers:
• abzokhattab | Contributor | 106734685

Issue Owner

Current Issue Owner: @srikarparsi

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~021904978587121878600

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @sobitneupane (External)

[FitseTLT]

🚨 Edited by proposal-police: This proposal was edited at 2025-03-26 20:23:45 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Checkbox on Reports table header does not show indeterminate state

What is the root cause of that problem?

Improvement

What changes do you think we should make in order to solve the problem?

We will add a new indeterminate state checker in check box and when it is true we will display the indeterminate icon here instead of the check mark

App/src/components/Checkbox.tsx

Lines 122 to 128 in 7087610

	{isChecked && (
	<Icon
	src={Expensicons.Checkmark}
	fill={theme.textLight}
	height={caretSize}
	width={caretSize}
	/>

{ isIndeterminateState && (
                        <Icon
                            src={Expensicons.AdminRoomAvatar} // will be updated
                            fill={theme.textLight}
                            height={caretSize}
                            width={caretSize}
                        />

the indeterminate state will be passed here

App/src/components/Search/SearchList.tsx

Line 301 in 7087610

isChecked={selectedItemsLength === data.length}

                        isIndeterminateState={selectedItemsLength > 0 && selectedItemsLength !== data.length}

To unselect selected items in indeterminate state we will then update this

App/src/components/Search/index.tsx

Lines 424 to 426 in 7087610

	const isAllSelected = flattenedItems.length === Object.keys(selectedTransactions).length;
	if (isAllSelected) {

const hasSelected = Object.keys(selectedTransactions).length > 0;

        if (hasSelected) {
            clearSelectedTransactions();
            return;
        }

We will also tweak the style as needed, may be apply bordorColor and bgColor similar to the checked state we already use.

We will also need to specifically handle the case for Expense Reports as we display multiple transaction items grouped as sublists in ReportListItem so we will add similar feature for the checkbox here

App/src/components/SelectionList/Search/ReportListItem.tsx

Lines 176 to 184 in 7087610

	<Checkbox
	onPress={() => onCheckboxPress?.(item)}
	isChecked={item.isSelected}
	containerStyle={[StyleUtils.getCheckboxContainerStyle(20), StyleUtils.getMultiselectListStyles(!!item.isSelected, !!item.isDisabled)]}
	disabled={!!isDisabled || item.isDisabledCheckbox}
	accessibilityLabel={item.text ?? ''}
	shouldStopMouseDownPropagation
	style={[styles.cursorUnset, StyleUtils.getCheckboxPressableStyle(), item.isDisabledCheckbox && styles.cursorDisabled, !isLargeScreenWidth && styles.mr3]}
	/>

                                    isIndeterminateState={!item.isSelected && reportItem.transactions.some((tr) => tr.isSelected)}

And then to toggle the selected transactions under the report in indeterminate state we will need to update

App/src/components/Search/index.tsx

Line 394 in 7087610

if (item.transactions.every((transaction) => selectedTransactions[transaction.keyForList]?.isSelected)) {

        if (item.transactions.some((transaction) => selectedTransactions[transaction.keyForList]?.isSelected)) {

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

N/ A

What alternative solutions did you explore? (Optional)

[github-actions]

⚠️ @FitseTLT Thanks for your proposal. Please update it to follow the proposal template, as proposals are only reviewed if they follow that format (note the mandatory sections).

[daledah]

🚨 Edited by proposal-police: This proposal was edited at 2025-03-26 19:58:45 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Checkbox on Reports table header does not show indeterminate state

What is the root cause of that problem?

New feature

What changes do you think we should make in order to solve the problem?

First, create a new prop isIndeterminate for Checkbox, defaults to false

App/src/components/Checkbox.tsx

Line 52 in 8893341

function Checkbox(

Add Icon if isIndeterminate is true

App/src/components/Checkbox.tsx

Lines 122 to 129 in 8893341

	{isChecked && (
	<Icon
	src={Expensicons.Checkmark}
	fill={theme.textLight}
	height={caretSize}
	width={caretSize}
	/>
	)}

{isChecked && !isIndeterminate && (
                        <Icon
                            src={Expensicons.Checkmark}
                            fill={theme.textLight}
                            height={caretSize}
                            width={caretSize}
                        />
                    )}
                    {isIndeterminate && !isChecked && (
                        <Icon
                            src={Expensicons.ArrowRight} // change later
                            fill={theme.textLight}
                            height={caretSize}
                            width={caretSize}
                        />
                    )}

Update style here as well

App/src/components/Checkbox.tsx

Line 115 in 8893341

isChecked && styles.checkedContainer,

App/src/components/Checkbox.tsx

Line 119 in 8893341

isChecked && styles.borderColorFocus,

(isChecked || isIndeterminate) && styles.checkedContainer
(isChecked || isIndeterminate) && styles.borderColorFocus

Then pass isIndeterminate in SearchList

App/src/components/Search/SearchList.tsx

Line 299 in 8893341

<Checkbox

isIndeterminate={selectedItemsLength > 0 && selectedItemsLength < data.length}

To remove all selections when on indeterminate state, we can modify this logic:

App/src/components/Search/index.tsx

Lines 424 to 426 in 8893341

	const isAllSelected = flattenedItems.length === Object.keys(selectedTransactions).length;
	if (isAllSelected) {

const shouldClearTransactions = Object.keys(selectedTransactions).length;

        if (shouldClearTransactions) {

Result

Screen.Recording.2025-03-27.at.02.38.36.mov

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

None

What alternative solutions did you explore? (Optional)

NA

Reminder: Please use plain English, be brief and avoid jargon. Feel free to use images, charts or pseudo-code if necessary. Do not post large multi-line diffs or write walls of text. Do not create PRs unless you have been hired for this job.

[github-actions]

⚠️ @daledah Thanks for your proposal. Please update it to follow the proposal template, as proposals are only reviewed if they follow that format (note the mandatory sections).

[naftalimurgor]

Hello,
Here's how the checkbox state may be handled:

• checked state, unchecked, indeterminate track on a single state object and toggled based on the current state of the items.

[melvin-bot]

📣 @naftalimurgor! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Make sure you've read and understood the contributing guidelines.
2. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
3. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
4. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[FitseTLT]

Updated to add the handling of clearing the selected items in indeterminate state

[abzokhattab]

🚨 Edited by proposal-police: This proposal was edited at 2025-03-26 20:11:17 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Checkbox on Reports table header does not show indeterminate state

What is the root cause of that problem?

new feature

What changes do you think we should make in order to solve the problem?

1. Create an optional prop isIndeterminate in the Checkbox component
2. Change the styles here to

                 style={[
                        StyleUtils.getCheckboxContainerStyle(containerSize, containerBorderRadius),
                        containerStyle,
                        // Show a “checked” style or color if it's checked or indeterminate
                        (isChecked || isIndeterminate) && styles.checkedContainer,
                        hasError && styles.borderColorDanger,
                        disabled && styles.cursorDisabled,
                        disabled && styles.buttonOpacityDisabled,
                        (isChecked || isIndeterminate) && styles.borderColorFocus,
                    ]}

• also change the aria-checked to ensure that it accurately reflects “true,” “false,” or “mixed,” so screen readers recognize the checkbox’s exact state (checked, unchecked, or indeterminate):

            aria-checked={isIndeterminate ? 'mixed' : isChecked}

• then change the icon to

         {(isChecked || isIndeterminate) && (
                        <Icon
                            // Use a dash or "minus" icon for indeterminate; checkmark otherwise
                            src={isIndeterminate ? Expensicons.Minus : Expensicons.Checkmark}
                            fill={theme.textLight}
                            height={caretSize}
                            width={caretSize}
                        />

3. the icon should be provided by the design team and added to the images/ folder then imported and exported in the Expensicons.tsfile
4. now inside the SearchList, pass the isIndeterminate prop:

                        isIndeterminate={selectedItemsLength > 0 && selectedItemsLength !== data.length}

• then modify this part inside the toggleAllTransactions function to:

    const totalSelected = Object.keys(selectedTransactions).length;

    // If *any* are selected, unselect everything
    if (totalSelected > 0) {
        clearSelectedTransactions();
        return;
    }

• I noticed there is a bug in the selectedItemsLength function for Expense reports. It does not account for the nested selected transactions when counting the selected items for the expense reports.

Video

Screen.Recording.2025-03-26.at.22.08.04.mov

!

To fix this, we need to modify the function to flat group reports transactions, we should create a new prop shouldGroupByReports to the SearchList and pass it in the Search as shouldGroupByReports={shouldGroupByReports}

then update the lenght function to:

    const selectedItemsLength = (shouldGroupByReports ? (data as ReportListItemType[]).flatMap((item) => item.transactions) : data).reduce((acc, item) => {
        return item.isSelected ? acc + 1 : acc;
    }, 0);

• if we want to enable the indeterminate state on the nested transactions inside expense reports we should add the isIndeterminate to this checkbox as well where the value is isIndeterminate={reportItem.transactions.some((transaction) => transaction.isSelected) && !item.isSelected}

• then update this to use some instead of every

What specific scenarios should we cover in automated tests to prevent reintroducing this issue in the future?

NA

What alternative solutions did you explore? (Optional)

To acheive this effect with all other tables and ensure table consistency, we should add the isIndeterminate prop to the checkbox inside the BaseSelectionList where the value

                            isIndeterminate={flattenedSections.selectedOptions.length > 0 && !flattenedSections.allSelected }

then modify the toggle functions in the follwoing occurences so that it clears the selection if the total selected is greater than 0