Org Unit Checkbox Filter

ProNew

A checkbox tree of org units with a switch that decides whether choosing a unit includes its sub-units. Use this when a report or list can be limited to units, and sometimes only to the unit itself.

Customize

This item has no props to tune. Use the lens above to change theme, density, direction and more.

Guide and examples

When to use it

Use it for reports, dashboards and exports filtered by organisation unit or region.

Do not use it when the choice always includes sub-units (use checkbox-tree with cascade) or the units are flat.

Installation

This item is part of tealmac UI Pro

The source for this item installs with a Pro licence key. Log in with your key to see the install command, or read the Pro setup page.

Props

Prop	Type	Default	Description
`units`	`TreeNode[]`	-	The org units.
`onChange`	`(unitIds) => void`	-	The units that apply, with sub-units when the switch is on.

Accessibility

The switch is a real role="switch" with a visible label, and changing it re-reports the filter.
The line under the tree says how many units are chosen and how many apply (polite live region).
Parents and children tick independently, so the tree shows exactly what was chosen.

Testing

The pattern ships with a Testing Library test (org-unit-checkbox-filter.test.tsx) that covers the expansion rule, both switch states and independent ticking.

Guide and examples

When to use it

Use it for reports, dashboards and exports filtered by organisation unit or region.

Do not use it when the choice always includes sub-units (use checkbox-tree with cascade) or the units are flat.

Installation

This item is part of tealmac UI Pro

The source for this item installs with a Pro licence key. Log in with your key to see the install command, or read the Pro setup page.

Props

Prop	Type	Default	Description
`units`	`TreeNode[]`	-	The org units.
`onChange`	`(unitIds) => void`	-	The units that apply, with sub-units when the switch is on.

Accessibility

The switch is a real role="switch" with a visible label, and changing it re-reports the filter.
The line under the tree says how many units are chosen and how many apply (polite live region).
Parents and children tick independently, so the tree shows exactly what was chosen.

Testing

The pattern ships with a Testing Library test (org-unit-checkbox-filter.test.tsx) that covers the expansion rule, both switch states and independent ticking.