TranslationViewDragHelper

A version of ViewDragHelper which accounts for X and Y translations.

Gradle

dependencies {
    implementation("com.commit451:translationviewdraghelper:latest.release.here")
}

Usage

If you have ever used a ViewDragHelper before, you may have noticed that if you were to translate your views using View.setX() or View.setY(), your helper would no longer correctly allow you to drag the views. This library seeks to correct this. Usage is identical to ViewDragHelper usage:

val callback = TranslationViewDragHelper.Callback {
    override fun tryCaptureView(child: View, pointerId: Int): Boolean {
        // Any children can be captured
        return true
    }
    
    override fun clampViewPositionHorizontal(child: View, left: Int, dx: Int): Int {
        // allow full movement along horizontal axis
        return left
    }
    
    override fun clampViewPositionVertical(child: View, top: Int, dy: Int): Int {
        // allow full movement along vertical axis
        return top
    }
}

val viewDragHelper = TranslationViewDragHelper.create(
    viewGroup,
    1.0f,
    callback
)

See the sample custom view for a more complete example

Basis

The current version of this helper is derived from ViewDragHelper source from 1.0.0 of the androidx.customview library. Due to private constructor access on ViewDragHelper, the source has to be copied out into the TranslationViewDragHelper. You can check to see if anything has changed here

License

Copyright 2024 Commit 451

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.