Skip to content

feat: add hideWrapBanner widget config - #677

Open
azebuado wants to merge 1 commit into
mainfrom
feat/document-hideWrapBanner
Open

azebuado wants to merge 1 commit into
mainfrom
feat/document-hideWrapBanner

Conversation

@azebuado

@azebuado azebuado commented Oct 23, 2026 •

Copy link
Copy Markdown

Summary

⚠️ Don't merge before cowprotocol/cowswap#8461 is published ⚠️

Documents the new hideWrapBanner widget parameter from cowprotocol/cowswap#8461 in the CowSwapWidgetParams table.

Fixes FE-979

Details

What changed

  • Added a hideWrapBanner row (boolean, default false) after hideBridgeInfo in docs/cow-protocol/tutorials/widget/widget.md.

Why

  • When a user sells native ETH, the widget shows a "Wrap your ETH and use the classic WETH experience!" banner. Lido's integration doesn't support wrapping and asked for a way to hide it.

Risks

  • The parameter only takes effect once a widget build that includes cowswap#8461 is deployed, and it won't be in the TypeScript types until the next @cowprotocol/widget-lib release after 4.6.0. If this lands first, the docs will list an option that doesn't work yet.

To test

  1. Open /cow-protocol/tutorials/widget#cowswapwidgetparams
  2. Make sure the table has a hideWrapBanner row right after hideBridgeInfo, and the table still renders normally

Preview URLs

Self-checks

  • I have read CONTRIBUTING.md
  • I have manually tested changes on Vercel preview deployment
  • I have done self-review and (or) AI review
  • I have addressed all comments from @coderabbitai
  • I have less than three open PRs/Stacks in this repo at the moment of creating this PR

Summary by CodeRabbit

  • Documentation
    • Documented the hideWrapBanner option for hiding the native-token wrapping banner below the Swap button when selling a native token.

@vercel

vercel Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 23, 2026 2:48pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

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: 6b4e2359-f388-4267-b0b9-6066439240ba
📥 Commits

Reviewing files that changed from the base of the PR and between b5e4e68 and 79ab06b.

📒 Files selected for processing: 1
  • docs/cow-protocol/tutorials/widget/widget.md

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

📝 Walkthrough

The widget tutorial now documents the hideWrapBanner option. It describes hiding the native-token wrapping suggestion below the Swap button when selling the native token.

Changes: Widget documentation

Layer / File(s) Summary
Document wrap banner option
docs/cow-protocol/tutorials/widget/widget.md
The parameter documentation describes when hideWrapBanner hides the native-token wrapping suggestion.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 79ab0

No documentation defect is established. Confirm the stated widget-release prerequisite before publishing the option to integrations.

Pre-merge checks: Passed 5
Check name Status Explanation
Description check Passed The description provides the change, reason, implementation details, risks, testing steps, preview URL, and related issue. It does not use the template headings exactly, but it contains the required i…
Title check Passed The title clearly identifies the main change: adding the hideWrapBanner widget configuration option.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Description check

Explanation

The description provides the change, reason, implementation details, risks, testing steps, preview URL, and related issue. It does not use the template headings exactly, but it contains the required information and is complete.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. 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

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

@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@linear-code

linear-code Bot commented Oct 23, 2026

Copy link
Copy Markdown

FE-979

@azebuado azebuado self-assigned this Oct 23, 2026
@azebuado
azebuado requested review from a team and shoom3301 October 23, 2026 14:56
@azebuado
azebuado marked this pull request as ready for review October 23, 2026 14:56
@azebuado
azebuado requested a review from a team as a code owner October 23, 2026 14:56
@azebuado

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Oct 23, 2026
@azebuado azebuado added the blocked This issue is blocked by some other work label Oct 23, 2026

This branch was successfully deployed

1 active deployment
Preview — 79ab06b5 Deployed Oct 23, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked This issue is blocked by some other work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant