[dolanmiu]

Closes #3007

#3007 asked for checkbox docs. Since #3353 (February), Checkboxes has covered them, in the sidebar under Usage. Reading it against src/file/checkbox/ turned up a few things that were wrong, which this PR fixes:

• The options table gave checkedState and uncheckedState the type SymbolState, which doesn't exist. The exported type is ICheckboxSymbolProperties.
• It marked value as required. Both value and font are optional. The page now says what they default to: ☒ (2612) when checked and ☐ (2610) when not, both in MS Gothic, as Word's own checkboxes are.
• It called alias an accessibility label. alias writes the content control's w:alias, its title, which Word shows on a tab above the checkbox when the cursor is in it. The "Accessibility" section is now "Title" and says that.
• The sentence about custom symbols being for "branding consistency, platform compatibility" now says what the defaults are and what the two options set.

The code examples are unchanged.

Tested

• In Word for Mac 16 with the published docx 9.15.0, the defaults draw ☐ and ☒. checkedState: { value: "2611" } with no font draws ☑ in MS Gothic, and a checkbox with an alias shows the alias on a tab above it when the cursor is in it.
• prettier and cspell on the page.

Summary by CodeRabbit

• Documentation
  • Updated checkbox guidance to clarify the default checked and unchecked symbols, their font, and how to specify alternatives.
  • Clarified that the checkbox alias appears as a title in Word when the cursor is inside the checkbox.

[coderabbitai]

No actionable comments were generated in the recent review.

Recent review info

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: be260c31-27eb-499b-8ce1-2494079ac30e

Commits

Reviewing files that changed from the base of the PR and between b65e653 and 039a324.

Files selected for processing: 1

• docs/usage/checkboxes.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

Walkthrough

The checkbox guide now documents default checked and unchecked symbols, the default font, and how to specify alternate symbols. It also describes the checkbox alias as a title that Word displays above the checkbox when the cursor is in it.

Changes: Checkbox documentation

Layer / File(s)	Summary
Checkbox options and display behavior docs/usage/checkboxes.md	The guide documents ICheckboxSymbolProperties, the default symbols and font, and the optional symbol value. It describes the alias as a title displayed by Word when the cursor is in the checkbox.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: Minimal · up to 039a3

The documentation update is ready to merge with normal checks.

Pre-merge checks: 5

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly summarizes the documentation changes: it identifies the corrected checkbox option type, defaults, and alias behavior.
Linked Issues check		Issue #3007 requests Checkbox documentation. The reviewed page docs/usage/checkboxes.md provides usage examples and an options reference. This pull request corrects the public type name, optional fi…
Out of Scope Changes check		The diff changes only docs/usage/checkboxes.md. Each change clarifies Checkbox options or Checkbox behavior. The examples remain unchanged. No unrelated implementation or documentation change is pre…
Docstring Coverage		No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi…

Full details: Linked Issues check

Explanation

Issue #3007 requests Checkbox documentation. The reviewed page docs/usage/checkboxes.md provides usage examples and an options reference. This pull request corrects the public type name, optional fields, default symbols and font, and alias title behavior. These changes support the issue objective. No additional coding requirement is stated in #3007.

Full details: Out of Scope Changes check

Explanation

The diff changes only docs/usage/checkboxes.md. Each change clarifies Checkbox options or Checkbox behavior. The examples remain unchanged. No unrelated implementation or documentation change is present.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (b65e653) to head (039a324).

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #3855   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          576       576           
  Lines        27806     27806           
  Branches     10185     10185           
=========================================
  Hits         27806     27806           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.