chore(react-utilities): updates useControllableState comments

[bsunderhus]

New Behavior

Improves documentation for useControllableState to ensure a better understanding of how the hook properly operates.

Related Issue(s)

• [Bug]: useControllableState is not able to sync internal state with incoming state #25748

[fabricteam]

Perf Analysis (@fluentui/react-components)

Scenario	Render type	Master Ticks	PR Ticks	Iterations	Status
InfoButton	mount	21	19	5000	Possible regression

All results

Scenario	Render type	Master Ticks	PR Ticks	Iterations	Status
Avatar	mount	710	712	5000
Button	mount	376	370	5000
Field	mount	1271	1244	5000
FluentProvider	mount	919	919	5000
FluentProviderWithTheme	mount	120	120	10
FluentProviderWithTheme	virtual-rerender	96	99	10
FluentProviderWithTheme	virtual-rerender-with-unmount	108	110	10
InfoButton	mount	21	19	5000	Possible regression
MakeStyles	mount	1128	1128	50000
Persona	mount	2029	1955	5000
SpinButton	mount	1553	1549	5000

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 34773da:

Sandbox	Source
@fluentui/react 8 starter	Configuration
@fluentui/react-components 9 starter	Configuration

[size-auditor]

Asset size changes

Size Auditor did not detect a change in bundle size for any component!

Baseline commit: 43d6e99d28aa0e7bd7111f1043348683646eaa5b (build)

[fabricteam]

📊 Bundle size report

Unchanged fixtures

Package & Exports	Size (minified/GZIP)
global-context createContext	533 B 341 B
global-context createContextSelector	560 B 352 B
react-accordion Accordion (including children components)	86.012 kB 26.086 kB
react-alert Alert	93.799 kB 22.502 kB
react-avatar Avatar	57.564 kB 14.976 kB
react-avatar AvatarGroup	15.632 kB 6.258 kB
react-avatar AvatarGroupItem	73.778 kB 19.491 kB
react-badge Badge	23.512 kB 7.197 kB
react-badge CounterBadge	24.416 kB 7.506 kB
react-badge PresenceBadge	31.904 kB 8.296 kB
react-button Button	37.179 kB 9.534 kB
react-button CompoundButton	44.328 kB 11.016 kB
react-button MenuButton	41.866 kB 10.861 kB
react-button SplitButton	50.254 kB 12.441 kB
react-button ToggleButton	55.397 kB 11.435 kB
react-card Card - All	86.061 kB 24.345 kB
react-card Card	80.997 kB 22.895 kB
react-card CardFooter	9.158 kB 3.844 kB
react-card CardHeader	11.048 kB 4.538 kB
react-card CardPreview	9.963 kB 4.192 kB
react-checkbox Checkbox	34.216 kB 10.784 kB
react-combobox Combobox (including child components)	87.199 kB 28.095 kB
react-combobox Dropdown (including child components)	85.583 kB 27.692 kB
react-components react-components: Button, FluentProvider & webLightTheme	65.31 kB 17.931 kB
react-components react-components: Accordion, Button, FluentProvider, Image, Menu, Popover	204.34 kB 57.141 kB
react-components react-components: FluentProvider & webLightTheme	36.086 kB 11.9 kB
react-datepicker-compat DatePicker Compat	220.251 kB 58.471 kB
react-dialog Dialog (including children components)	90.867 kB 27.047 kB
react-divider Divider	17.399 kB 6.298 kB
react-field Field	18.864 kB 7.004 kB
react-image Image	11.479 kB 4.573 kB
react-infobutton InfoButton	127.925 kB 39.003 kB
react-infobutton InfoLabel	131.208 kB 39.996 kB
react-input Input	23.972 kB 7.676 kB
react-label Label	10.104 kB 4.185 kB
react-link Link	12.357 kB 5.091 kB
react-menu Menu (including children components)	128.202 kB 39.18 kB
react-menu Menu (including selectable components)	131.186 kB 39.696 kB
react-overflow hooks only	11.214 kB 4.271 kB
react-persona Persona	64.485 kB 16.9 kB
react-popover Popover	114.917 kB 35.388 kB
react-portal Portal	11.649 kB 4.262 kB
react-portal-compat PortalCompatProvider	6.446 kB 2.186 kB
react-positioning usePositioning	24.008 kB 8.798 kB
react-progress ProgressBar	13.856 kB 5.434 kB
react-provider FluentProvider	18.033 kB 6.666 kB
react-radio Radio	27.282 kB 8.661 kB
react-radio RadioGroup	11.312 kB 4.71 kB
react-select Select	25.357 kB 8.798 kB
react-slider Slider	34.112 kB 11.018 kB
react-spinbutton SpinButton	33.882 kB 10.325 kB
react-spinner Spinner	20.882 kB 6.798 kB
react-switch Switch	29.806 kB 9.274 kB
react-table DataGrid	147.659 kB 40.567 kB
react-table Table (Primitives only)	44.348 kB 12.347 kB
react-table Table as DataGrid	130.218 kB 33.128 kB
react-table Table (Selection only)	78.132 kB 19.127 kB
react-table Table (Sort only)	77.462 kB 18.939 kB
react-text Text - Default	12.492 kB 4.92 kB
react-text Text - Wrappers	15.624 kB 5.232 kB
react-textarea Textarea	27.399 kB 9.041 kB
react-tooltip Tooltip	46.656 kB 16.369 kB
react-utilities SSRProvider	180 B 159 B

_{🤖 This report was generated against 43d6e99d28aa0e7bd7111f1043348683646eaa5b}

[layershifter]

Can you please also apply comments from the previous PR #27702 (review)? 🙏

[fabricteam]

🕵 fluentuiv9 No visual regressions between this PR and main

[bsunderhus]

Can you please also apply comments from the previous PR #27702 (review)? 🙏

The follow up on that is here: #27717

[msft-fluent-ui-bot]

🎉@fluentui/react-utilities@v9.8.1 has been released which incorporates this pull request.:tada:

Handy links:

• Release Notes
• Official NPM Release