Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat(useBeforeUnload): add new Function#4847

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.

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

Already on GitHub?Sign in to your account

Open
ryanuo wants to merge2 commits intovueuse:main
base:main
Choose a base branch
Loading
fromryanuo:main

Conversation

ryanuo
Copy link

useBeforeUnload

Reactive state to handle beforeunload event.

Usage

import{useBeforeUnload}from'@vueuse/core'// Basic usageconst{ setMessage, remove}=useBeforeUnload({message:'Are you sure you want to leave?'})// Dynamic messageconst{ setMessage}=useBeforeUnload()setMessage('You have unsaved changes!')// Remove the event listenerconst{ remove}=useBeforeUnload()remove()

Type Declarations

exportinterfaceUseBeforeUnloadOptionsextendsConfigurableWindow{/**   * The message to show when the user tries to leave the page.   * This is used to show a confirmation dialog.   */message?:string}exportfunctionuseBeforeUnload(options?:UseBeforeUnloadOptions):{setMessage:(message:string)=>voidremove:()=>void}

Parameters

NameTypeDefaultDescription
optionsUseBeforeUnloadOptions{}Options object

UseBeforeUnloadOptions

NameTypeDefaultDescription
windowWindowdefaultWindowCustom window instance
messagestringundefinedMessage to show in confirmation dialog

Return Value

NameTypeDescription
setMessage(message: string) => voidFunction to set a new message
remove() => voidFunction to remove the event listener

Examples

Basic Usage

<script setup>import {useBeforeUnload }from'@vueuse/core'const {setMessage,remove }=useBeforeUnload({  message:'You have unsaved changes. Are you sure you want to leave?'})</script>

Dynamic Message

<script setup>import {useBeforeUnload }from'@vueuse/core'import {ref }from'vue'consthasUnsavedChanges=ref(false)const {setMessage }=useBeforeUnload()// Update message based on statewatch(hasUnsavedChanges, (newValue)=> {if (newValue) {setMessage('You have unsaved changes. Are you sure you want to leave?')  }})</script>

Conditional Usage

<script setup>import {useBeforeUnload }from'@vueuse/core'import {computed }from'vue'constformData=ref({})consthasChanges=computed(()=>Object.keys(formData.value).length>0)const {setMessage,remove }=useBeforeUnload()watch(hasChanges, (newValue)=> {if (newValue) {setMessage('You have unsaved changes!')  }else {remove()  }})</script>

@dosubotdosubotbot added size:LThis PR changes 100-499 lines, ignoring generated files. enhancementNew feature or request new function labelsJun 30, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancementNew feature or requestnew functionsize:LThis PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

1 participant
@ryanuo

[8]ページ先頭

©2009-2025 Movatter.jp