Skip to content
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

ScrollComponent: Add a minimum scrollbar grip size #146

Merged
merged 8 commits into from
Jul 22, 2024
Merged

ScrollComponent: Add a minimum scrollbar grip size #146

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
93a8aa9
ScrollComponent: Add a `limitScrollBarGripHeight` option
caoimhebyrne Jul 12, 2024
95a7601
ScrollComponent: Replace limitScrollBarGripHeight with ElementaVersion 6
caoimhebyrne Jul 15, 2024
575172f
ScrollBarGripMinHeightConstraint: Call `desiredHeight.animationFrame()`
caoimhebyrne Jul 15, 2024
4749845
ScrollBarGripMinHeightConstraint: Don't visit children
caoimhebyrne Jul 15, 2024
79a4357
ScrollBarGripMinHeightConstraint: Don't create intermediate constraints
caoimhebyrne Jul 15, 2024
6b3fd25
ScrollBarGripMinHeightConstraint: Convert to `SizeConstraint`
caoimhebyrne Jul 15, 2024
827d55c
ScrollBarGripMinSizeConstraint: Make class `private`
caoimhebyrne Jul 15, 2024
164bf7e
ElementaVersion: Update comment for V6
caoimhebyrne Jul 15, 2024
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
22 changes: 19 additions & 3 deletions api/Elementa.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,16 +343,18 @@ public final class gg/essential/elementa/components/ScrollComponent : gg/essenti
public fun <init> (Ljava/lang/String;)V
public fun <init> (Ljava/lang/String;F)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;Lgg/essential/elementa/components/ScrollComponent$Direction;ZZFFLgg/essential/elementa/UIComponent;Z)V
public synthetic fun <init> (Ljava/lang/String;FLjava/awt/Color;Lgg/essential/elementa/components/ScrollComponent$Direction;ZZFFLgg/essential/elementa/UIComponent;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
public fun <init> (Ljava/lang/String;FLjava/awt/Color;Lgg/essential/elementa/components/ScrollComponent$Direction;ZZFFLgg/essential/elementa/UIComponent;ZZ)V
public synthetic fun <init> (Ljava/lang/String;FLjava/awt/Color;Lgg/essential/elementa/components/ScrollComponent$Direction;ZZFFLgg/essential/elementa/UIComponent;ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;Z)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZ)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZ)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZ)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZF)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZFF)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZFFLgg/essential/elementa/UIComponent;)V
public synthetic fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZFFLgg/essential/elementa/UIComponent;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZFFLgg/essential/elementa/UIComponent;Z)V
public fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZFFLgg/essential/elementa/UIComponent;ZZ)V
public synthetic fun <init> (Ljava/lang/String;FLjava/awt/Color;ZZZZFFLgg/essential/elementa/UIComponent;ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
public synthetic fun addChild (Lgg/essential/elementa/UIComponent;)Lgg/essential/elementa/UIComponent;
public fun addChild (Lgg/essential/elementa/UIComponent;)Lgg/essential/elementa/components/ScrollComponent;
public final fun addScrollAdjustEvent (ZLkotlin/jvm/functions/Function2;)V
Expand Down Expand Up @@ -426,6 +428,20 @@ public final class gg/essential/elementa/components/ScrollComponent$Direction :
public static fun values ()[Lgg/essential/elementa/components/ScrollComponent$Direction;
}

public final class gg/essential/elementa/components/ScrollComponent$ScrollBarGripMinHeightConstraint : gg/essential/elementa/constraints/HeightConstraint {
public fun <init> (Lgg/essential/elementa/components/ScrollComponent;Lgg/essential/elementa/constraints/HeightConstraint;)V
public fun getCachedValue ()Ljava/lang/Float;
public synthetic fun getCachedValue ()Ljava/lang/Object;
public fun getConstrainTo ()Lgg/essential/elementa/UIComponent;
public fun getHeightImpl (Lgg/essential/elementa/UIComponent;)F
public fun getRecalculate ()Z
public fun setCachedValue (F)V
public synthetic fun setCachedValue (Ljava/lang/Object;)V
public fun setConstrainTo (Lgg/essential/elementa/UIComponent;)V
public fun setRecalculate (Z)V
public fun visitImpl (Lgg/essential/elementa/constraints/resolution/ConstraintVisitor;Lgg/essential/elementa/constraints/ConstraintType;)V
}

public final class gg/essential/elementa/components/ScrollComponent$ScrollChildConstraint : gg/essential/elementa/constraints/HeightConstraint, gg/essential/elementa/constraints/WidthConstraint {
public fun <init> (Lgg/essential/elementa/components/ScrollComponent;F)V
public synthetic fun <init> (Lgg/essential/elementa/components/ScrollComponent;FILkotlin/jvm/internal/DefaultConstructorMarker;)V
Expand Down
38 changes: 34 additions & 4 deletions src/main/kotlin/gg/essential/elementa/components/ScrollComponent.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ class ScrollComponent constructor(
private val pixelsPerScroll: Float = 15f,
private val scrollAcceleration: Float = 1.0f,
customScissorBoundingBox: UIComponent? = null,
private val passthroughScroll: Boolean = true
private val passthroughScroll: Boolean = true,
private val limitScrollBarGripHeight: Boolean = false,
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
) : UIContainer() {
@JvmOverloads constructor(
emptyString: String = "",
Expand All @@ -44,7 +45,9 @@ class ScrollComponent constructor(
verticalScrollOpposite: Boolean = false,
pixelsPerScroll: Float = 15f,
scrollAcceleration: Float = 1.0f,
customScissorBoundingBox: UIComponent? = null
customScissorBoundingBox: UIComponent? = null,
passthroughScroll: Boolean = true,
limitScrollBarGripHeight: Boolean = false,
) : this (
emptyString,
innerPadding,
Expand All @@ -59,7 +62,9 @@ class ScrollComponent constructor(
verticalScrollOpposite,
pixelsPerScroll,
scrollAcceleration,
customScissorBoundingBox
customScissorBoundingBox,
passthroughScroll,
limitScrollBarGripHeight,
)

private val primaryScrollDirection
Expand Down Expand Up @@ -469,7 +474,8 @@ class ScrollComponent constructor(
if (isHorizontal) {
component.setWidth(RelativeConstraint(clampedPercentage))
} else {
component.setHeight(RelativeConstraint(clampedPercentage))
val heightConstraint = RelativeConstraint(clampedPercentage)
component.setHeight(if (limitScrollBarGripHeight) ScrollBarGripMinHeightConstraint(heightConstraint) else heightConstraint)
}
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved

component.animate {
Expand Down Expand Up @@ -800,6 +806,30 @@ class ScrollComponent constructor(

}

/**
* Constraints the scrollbar grip's height to be a certain minimum height, or the [desiredHeight].
* This is the default constraint for vertical scrollbar grips if [limitScrollBarGripHeight] is enabled.
*
* @param desiredHeight The intended height for the scrollbar grip.
*/
inner class ScrollBarGripMinHeightConstraint(
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
private val desiredHeight: HeightConstraint
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
) : HeightConstraint {
override var cachedValue: Float = 0f
override var recalculate: Boolean = true
override var constrainTo: UIComponent? = null

override fun getHeightImpl(component: UIComponent): Float {
val parent = component.parent
val minimumHeight = if (parent.getHeight() < 200) { 15.percent } else { 10.percent }
return desiredHeight.coerceAtLeast(minimumHeight).getHeight(component)
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
}

override fun visitImpl(visitor: ConstraintVisitor, type: ConstraintType) {
if (type == ConstraintType.HEIGHT) visitor.visitChildren(type)
Johni0702 marked this conversation as resolved.
Show resolved Hide resolved
}
}

enum class Direction {
Vertical,
Horizontal,
Expand Down
Loading