Skip to content

[Feature] Allow the programmer to pass an object for configuring the scroll #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Feature] Allow the programmer to pass an object for configuring the scroll #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e673f77
#pr-102 allow set scrollToOptions, behavior
ChillMouse Oct 29, 2025
d71ced2
#pr-102 docs about second argument
ChillMouse Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/documentation/examples/date-and-time.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ example(title="Scroll the View to a Particular Time" anchor="scroll-to-time")
code view.scrollTop()
p Scrolls the calendar body to the top.
li.mt3
code view.scrollToTime(minutes)
code view.scrollToTime(minutes, scrollToOptions)
p Scrolls the calendar body to the given time in minutes. E.g. #[code view.scrollToCurrentTime(13 * 60)].
p If you need to disable smooth behavior, you can set second argument of the function as options, e.g. #[code view.scrollToCurrentTime(13 * 60, { behavior: undefined })].
li.mt3
code view.scrollToCurrentTime()
p Scrolls the calendar body to the current time.
Expand All @@ -98,9 +99,12 @@ example(title="Scroll the View to a Particular Time" anchor="scroll-to-time")
w-button.mt2.mr2(@click="exScrollToTime.scrollTop")
w-icon mdi mdi-format-vertical-align-top
| Scroll top
w-button.mt2.mr2(@click="exScrollToTime.scrollToTime(12 * 60, { behavior: undefined })")
w-icon mdi mdi-format-vertical-align-center
| Scroll to 12:00, fast
w-button.mt2.mr2(@click="exScrollToTime.scrollToTime(12 * 60)")
w-icon mdi mdi-format-vertical-align-center
| Scroll to 12:00
| Scroll to 12:00, smooth
w-button.mt2.mr2(@click="exScrollToTime.scrollToCurrentTime")
w-icon mdi mdi-format-vertical-align-bottom
| Scroll to current time
Expand Down
2 changes: 1 addition & 1 deletion src/types/vue-cal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ export interface VueCalView {
createEvent: (event: VueCalEvent) => void
deleteEvent: (eventId: number, forceStage?: number) => void
scrollToCurrentTime: () => void
scrollToTime: (minutes: number) => void
scrollToTime: (minutes: number, scrollToOptions?: ScrollToOptions) => void
scrollTop: () => void
// Others
viewDate: Date
Expand Down
4 changes: 2 additions & 2 deletions src/vue-cal/core/view.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,10 +535,10 @@ export const useView = ({ config, dateUtils, emit, texts, eventsManager }, vueca
updateView()
}

function scrollToTime (minutes) {
function scrollToTime (minutes, scrollToOptions = { behavior: 'smooth' }) {
const scrollableEl = vuecalEl.value?.querySelector('.vuecal__scrollable')
const anchor = minutes ? minutes * config.timeCellHeight / config.timeStep : 0
scrollableEl?.scrollTo({ top: anchor, behavior: 'smooth' })
scrollableEl?.scrollTo({ ...scrollToOptions, top: anchor })
}

function scrollToCurrentTime () {
Expand Down