Skip to content

docs(header, footer, tab-bar): document the scrollEffect prop - #4845

Open
thetaPC wants to merge 5 commits into
major-10.0from
FW-7616
Open

thetaPC wants to merge 5 commits into
major-10.0from
FW-7616

Conversation

@thetaPC

@thetaPC thetaPC commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Issue number: internal

scrollEffect replaces the deprecated collapse prop on ion-header and ion-footer, and condense and fade now work in every mode, not just iOS. The iOS-only notes and mode="ios" playground pins are removed where the effect no longer needs them.

  • Adds a Hide section and playground to Header, Footer, and Tab Bar
  • Moves every collapse="condense" and collapse="fade" to scrollEffect: 67 lines across 55 files, including the Title playgrounds and the Angular, React, and Vue tutorials
  • Removes the iOS-only notes from Collapsible Large Titles and Collapsible Buttons

Dev build: 9.0.12-dev.11794527713.1ebd1ea1

@vercel

vercel Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
ionic-docs Ready Ready Preview Nov 13, 2026 7:11pm UTC

Request Review

@thetaPC
thetaPC marked this pull request as ready for review November 13, 2026 04:09
@thetaPC
thetaPC requested a review from a team as a code owner November 13, 2026 04:09
@thetaPC
thetaPC requested review from brandyscarney and removed request for a team November 13, 2026 04:09

@ShaneK ShaneK left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Just a few leftover iOS-only bits and a couple of things to line up before v10 goes out, none of them blocking.


<ion-content [fullscreen]="true">
<ion-header collapse="condense">
<ion-header scrollEffect="condense">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The paragraph under this block still says the large title "displays on iOS devices", but with scrollEffect it condenses in every theme now. I think we can just drop "on iOS devices" from it. The React and Vue quickstarts have the same sentence, and I think the Your First App pages have a similar "due to iOS Collapsible Large Title support" line that could lose the "iOS" too. Since this PR removes the iOS-only note from the title page, the tutorials would end up contradicting it otherwise.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in ae78843.

Comment thread docs/api/header.mdx
## Condensed Header {/* #condensed-header */}

Ionic provides the functionality found in native iOS applications to show a large toolbar title and then collapse it to a small title when scrolling. This can be done by adding two headers, one above the content and one inside of the content, and then setting the `collapse` property to `"condense"` on the header inside of the content. This effect will only apply when the mode is "ios".
Ionic provides the functionality found in native iOS applications to show a large toolbar title and then collapse it to a small title when scrolling. This can be done by adding two headers, one above the content and one inside of the content, and then setting the `scrollEffect` property to `"condense"` on the header inside of the content.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the v10 updating guide needs a header/footer entry for this, since switching from collapse to scrollEffect isn't a straight rename. With scrollEffect the condense and fade effects apply on md too, so an app that follows the deprecation warning will suddenly show its large-title header on Android, where md used to hide it. The guide doesn't mention collapse at all right now. A follow-up PR is fine if you'd rather, it'd just be nice to note that in the PR body.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in b9508a8.


<ion-content [fullscreen]="true">
<ion-header collapse="condense">
<ion-header scrollEffect="condense">

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text above this block says it's what the generated file contains, but the starters still generate <ion-header collapse="condense">, so anyone who runs ionic start will see something different from the docs. That's fine today since the starters are still on v9, but I think we'll want a matching change in the starters repo (tabs and blank, for Angular, React and Vue) before v10 ships. Is that tracked anywhere? The React and Vue versions of this page and the quickstarts have the same mismatch.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It wasn't tracked, it is now internally. The change is in ionic-team/starters#1936 against the new major-10.0 branch, covering list and sidemenu too.

@brandyscarney brandyscarney left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good! I tested the playgrounds out using a dev build and I only found one issue related to icons but it's an easy fix!

Comment thread docs/react/your-first-app.mdx Resolved
Comment thread docs/vue/your-first-app.mdx Resolved
Comment thread docs/angular/your-first-app.mdx Resolved

@ShaneK ShaneK left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

This branch was successfully deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants