Repository navigation
docs(range): document knob and position in ionKnobMoveStart and ionKnobMoveEnd event details - #4849
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
1 of 2 tasks
brandyscarney
requested changes
Nov 17, 2026
brandyscarney
left a comment
Member
There was a problem hiding this comment.
The updates look good! Just one minor issue with the console on the demo. I'll leave it up to you if you want to update the individual playgrounds as well.
…obMoveEnd event details
…sing knob wording
ShaneK
added a commit
to ionic-team/ionic-framework
that referenced
this pull request
Nov 20, 2026
Issue number: resolves #25216 --------- ## What is the current behavior? Currently, `ionKnobMoveStart` and `ionKnobMoveEnd` only include `value`, so a range with `dualKnobs` has no way to tell you which knob the user moved. ## What is the new behavior? Both events now include `knob` and `position` in their detail. The `knob` field is `'A'` or `'B'` and stays the same if the knobs cross. The `position` field is `'lower'` or `'upper'`, based on the value that knob holds before the move on start and after it on end, so dragging knob A past knob B reports `lower` and then `upper`. A single knob range always reports `'A'` and `'lower'`. To report the knob on `ionKnobMoveStart`, we now pick it in `onStart`. Before this, it was picked on the first `onMove`, after the start event had already fired. ## Does this introduce a breaking change? - [ ] Yes - [X] No ## Other information The field names match range's existing shadow parts, where `knob-a` and `knob-b` stick with a knob and `knob-lower` and `knob-upper` swap when the knobs cross. We expose both because the issue asks for different behavior per knob, and some apps will care about the knob while others care about which value it changed. The new types use the `Range` prefix like the other range types (`RangeValue`, `RangeCustomEvent`). There's a `RangeKnobName` and `RangeKnobPosition` for the field values, plus a `RangeKnobMoveStartCustomEvent` and `RangeKnobMoveEndCustomEvent` per event, the same way we added `ReorderMoveCustomEvent` and `RefresherPullEndCustomEvent`. The custom event types are exported from core and from the Angular, React and Vue packages. We export them because otherwise `RangeCustomEvent` is the only typed option, and its `detail` is a union that includes `RangeChangeEventDetail`, so reading `knob` needs a cast: ```ts // Without the new types const onKnobMoveEnd = (ev: RangeCustomEvent) => { const { knob } = ev.detail as RangeKnobMoveEndEventDetail; }; const handlers: Record<RangeKnobMoveEndEventDetail['knob'], () => void> = { A: moveA, B: moveB }; // With them const onKnobMoveEnd = (ev: RangeKnobMoveEndCustomEvent) => { const { knob } = ev.detail; }; const handlers: Record<RangeKnobName, () => void> = { A: moveA, B: moveB }; ``` Tapping a range inside an `ion-content` with `scroll-y="false"` also no longer turns scrolling back on, since the tap now saves the scroll state before restoring it. This was sort of an unexpected bug fix that came along for the ride (resolves #30952) ## Docs PR ionic-team/ionic-docs#4849
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue number: internal
What is the current behavior?
Currently, the Range docs only describe
valuein theionKnobMoveStartandionKnobMoveEndevent details, and the knob move playground uses a single knob range, so it can't show which knob moved.What is the new behavior?
The Event Handling section now explains the
knobandpositionfields that ionic-team/ionic-framework#31754 adds to both events. It links to the CSS Shadow Parts section, since the fields use the same static identity and dynamic position as the knob parts. The Interfaces section addsknobandpositionto both event details, along with the newRangeKnobMoveStartCustomEventandRangeKnobMoveEndCustomEventinterfaces and theRangeKnobNameandRangeKnobPositiontypes.The
ion-knob-move-eventplayground now uses dual knobs starting at 20 and 80, and every framework logsknobandpositionnext tovalue. The Angular example uses the new custom event types instead ofRangeCustomEvent.Does this introduce a breaking change?
Other information