feat: add showIncludeCaretField option to StyledLinkField

[briantstephan]

By default, we will still always show the "Include Caret" field, but this gives us the option to hide it for links where it is not relevant, including the navigation links in the shared header.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 63e77e89-eb6f-4f8a-b2bc-561d81c34444

📥 Commits

Reviewing files that changed from the base of the PR and between cafaf4d and 3c4efd6.

📒 Files selected for processing (1)

• packages/visual-editor/src/fields/styledFields/StyledLinkField.tsx

---

Walkthrough

StyledLinkField now accepts an optional showIncludeCaretField boolean. The override logic defaults this value to true when it is not provided. The “Include Caret” combobox is only rendered when the flag is truthy.

Possibly related PRs

• yext/visual-editor#1199: Introduces the includeCaret control that this PR now conditionally renders.

Suggested reviewers

• jwartofsky-yext
• benlife5
• mkilpatrick

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: adding showIncludeCaretField to StyledLinkField.
Description check	✅ Passed	The description matches the change by explaining that Include Caret stays on by default but can now be hidden when irrelevant.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch show-include-caret-field

---

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.}