ResistanceConfig

Artifact: androidx.compose.material:material

View Source

Added in 1.0.0

Deprecated in 1.6.0

Common/AllAndroid/JVM

• Cmn

  class ResistanceConfig

---

This class is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

Specifies how resistance is calculated in swipeable.

There are two things needed to calculate resistance: the resistance basis determines how much overflow will be consumed to achieve maximum resistance, and the resistance factor determines the amount of resistance (the larger the resistance factor, the stronger the resistance).

The resistance basis is usually either the size of the component which swipeable is applied to, or the distance between the minimum and maximum anchors. For a constructor in which the resistance basis defaults to the latter, consider using resistanceConfig.

You may specify different resistance factors for each bound. Consider using one of the default resistance factors in SwipeableDefaults: StandardResistanceFactor to convey that the user has run out of things to see, and StiffResistanceFactor to convey that the user cannot swipe this right now. Also, you can set either factor to 0 to disable resistance at that bound.

Summary

Public constructors
ResistanceConfig(basis: Float, factorAtMin: Float, factorAtMax: Float) This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn

Public functions
Float	computeResistance(overflow: Float) This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn
open operator Boolean	equals(other: Any?) This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn
open Int	hashCode() This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn
open String	toString() This function is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn

Public properties
Float	basis This property is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn
Float	factorAtMax This property is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn
Float	factorAtMin This property is deprecated. Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs.	Cmn

Public constructors

ResistanceConfig

Cmn

Added in 1.0.0

Deprecated in 1.6.0

ResistanceConfig(
    basis: Float,
    factorAtMin: Float = StandardResistanceFactor,
    factorAtMax: Float = StandardResistanceFactor
)

This function is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

Parameters
basis: Float	Specifies the maximum amount of overflow that will be consumed. Must be positive.
factorAtMin: Float = StandardResistanceFactor	The factor by which to scale the resistance at the minimum bound. Must not be negative.
factorAtMax: Float = StandardResistanceFactor	The factor by which to scale the resistance at the maximum bound. Must not be negative.

Public functions

computeResistance

Cmn

Added in 1.0.0

Deprecated in 1.6.0

fun computeResistance(overflow: Float): Float

This function is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

equals

Cmn

open operator fun equals(other: Any?): Boolean

This function is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

hashCode

Cmn

open fun hashCode(): Int

This function is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

toString

Cmn

open fun toString(): String

This function is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

Public properties

basis

Cmn

Added in 1.0.0

Deprecated in 1.6.0

val basis: Float

This property is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

Specifies the maximum amount of overflow that will be consumed. Must be positive.

factorAtMax

Cmn

Added in 1.0.0

Deprecated in 1.6.0

val factorAtMax: Float

This property is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

The factor by which to scale the resistance at the maximum bound. Must not be negative.

factorAtMin

Cmn

Added in 1.0.0

Deprecated in 1.6.0

val factorAtMin: Float

This property is deprecated.
Material's Swipeable has been replaced by Foundation's AnchoredDraggable APIs. Please see developer.android.com for an overview of the changes and a migration guide.

The factor by which to scale the resistance at the minimum bound. Must not be negative.