Skip to content

feat(useSortable): add target watch for recreate Sortable instance #4766

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(useSortable): add target watch for recreate Sortable instance #4766

wants to merge 3 commits into from

Conversation

nknwns
Copy link

@nknwns nknwns commented May 22, 2025

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

Right now this composable doesn't work correct when target element rendering later. Example:

<script setup lang="ts">
const el = useTemplateRef<HTMLElement>('el')
const list = shallowRef([{ id: 1, name: 'a' }, { id: 2, name: 'b' }, { id: 3, name: 'c' }])

useSortable(el, list)

const isVisible = ref(false)

setTimeout(() => {
  isVisible.value = true
}, 1000)
</script>

<template>
  <div v-if="isVisible" ref="el">
    <div v-for="item in list" :key="item.id">
      {{ item.name }}
    </div>
  </div>
</template>

The solution is simple and it exists.

const { start } = useSortable(el, list, {
  animation: 150,
})

const isVisible = ref(false)

setTimeout(() => {
  isVisible.value = true
  nextTick(start)
}, 1000)

But I suggest adding watch to the target element to provide for such options.

Additional context

Perhaps to test whether there was an attempt to create a Sortable, you can make a mock Sortable constructor. But I limited myself to checking isActive in composable

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request new function labels May 22, 2025
OrbisK
OrbisK reviewed May 22, 2025
View reviewed changes
packages/integrations/useSortable/index.ts Outdated

if (value)
start()
}, { flush: 'post' })
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you for your PR: Please note https://vueuse.org/guidelines.html#watch-options

@nknwns nknwns requested a review from OrbisK May 22, 2025 14:16
OrbisK
OrbisK requested changes May 22, 2025
View reviewed changes
@OrbisK OrbisK requested review from 43081j and ilyaliao May 22, 2025 14:30
ilyaliao
ilyaliao reviewed May 23, 2025
View reviewed changes
@ilyaliao
Copy link
Member

ilyaliao commented May 23, 2025 •
edited
Loading

Not sure if it makes sense to include watchOptions in options.
For this example, it seems to work fine without flush: post.

/cc @OrbisK WDYT?

@nknwns nknwns requested a review from OrbisK May 27, 2025 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ilyaliao ilyaliao ilyaliao left review comments

@43081j 43081j Awaiting requested review from 43081j

@OrbisK OrbisK Awaiting requested review from OrbisK

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
enhancement New feature or request size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nknwns @ilyaliao @OrbisK @antfu