prioritise tooltip rendering above & filter empty tooltips

Author: isXander

build.gradle.kts

@@ -16,7 +16,7 @@ plugins {
 val ciRun = System.getenv().containsKey("GITHUB_ACTIONS")
 
 group = "dev.isxander"
-version = "2.4.1"
+version = "2.4.2"
 
 if (ciRun)
     version = "$version+${grgit.branch.current().name.replace('/', '.')}-SNAPSHOT"

changelogs/2.4.2.md

@@ -0,0 +1,2 @@
+- Prioritised tooltip rendering to above the option rather than below.
+- Fix empty tooltips rendering a newline.

src/client/java/dev/isxander/yacl/gui/ElementListWidgetExt.java

@@ -96,17 +96,6 @@ protected E getEntryAtPosition(double x, double y) {
         return null;
     }
 
-    @Override
-    public boolean mouseReleased(double mouseX, double mouseY, int button) {
-        // on mouseClicked, the clicked element becomes focused so you can drag. on release, we should clear the focus
-        boolean clicked = super.mouseReleased(mouseX, mouseY, button);
-//        if (getFocused() != null) {
-//            this.getFocused().setFocused(null);
-////            this.setFocused(null);
-//        }
-        return clicked;
-    }
-
     /*
       below code is licensed from cloth-config under LGPL3
       modified to inherit vanilla's EntryListWidget and use yarn mappings

src/client/java/dev/isxander/yacl/gui/YACLScreen.java

@@ -276,8 +276,8 @@ public static void renderMultilineTooltip(PoseStack matrices, Font font, MultiLi
             int aboveY = yAbove - height + 12;
             int maxBelow = screenHeight - (belowY + height);
             int minAbove = aboveY - height;
-            int y = belowY;
-            if (maxBelow < -8)
+            int y = aboveY;
+            if (minAbove < 8)
                 y = maxBelow > minAbove ? belowY : aboveY;
 
             int x = Math.max(centerX - text.getWidth() / 2 - 12, -6);

src/client/java/dev/isxander/yacl/impl/ConfigCategoryImpl.java

@@ -7,6 +7,7 @@
 import dev.isxander.yacl.api.OptionGroup;
 import dev.isxander.yacl.impl.utils.YACLConstants;
 import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.ComponentContents;
 import net.minecraft.network.chat.MutableComponent;
 import org.apache.commons.lang3.Validate;
 import org.jetbrains.annotations.ApiStatus;
@@ -121,6 +122,9 @@ public ConfigCategory build() {
             MutableComponent concatenatedTooltip = Component.empty();
             boolean first = true;
             for (Component line : tooltipLines) {
+                if (line.getContents() == ComponentContents.EMPTY)
+                    continue;
+
                 if (!first) concatenatedTooltip.append("\n");
                 first = false;
 

src/client/java/dev/isxander/yacl/impl/OptionGroupImpl.java

@@ -5,6 +5,7 @@
 import dev.isxander.yacl.api.Option;
 import dev.isxander.yacl.api.OptionGroup;
 import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.ComponentContents;
 import net.minecraft.network.chat.MutableComponent;
 import org.apache.commons.lang3.Validate;
 import org.jetbrains.annotations.ApiStatus;
@@ -113,6 +114,9 @@ public OptionGroup build() {
             MutableComponent concatenatedTooltip = Component.empty();
             boolean first = true;
             for (Component line : tooltipLines) {
+                if (line.getContents() == ComponentContents.EMPTY)
+                    continue;
+
                 if (!first) concatenatedTooltip.append("\n");
                 first = false;
 

src/client/java/dev/isxander/yacl/impl/OptionImpl.java

@@ -7,6 +7,7 @@
 import dev.isxander.yacl.api.OptionFlag;
 import net.minecraft.ChatFormatting;
 import net.minecraft.network.chat.Component;
+import net.minecraft.network.chat.ComponentContents;
 import net.minecraft.network.chat.MutableComponent;
 import org.apache.commons.lang3.Validate;
 import org.jetbrains.annotations.ApiStatus;
@@ -195,9 +196,11 @@ public final Option.Builder<T> tooltip(@NotNull Function<T, Component>... toolti
 
         @Override
         public Option.Builder<T> tooltip(@NotNull Component... tooltips) {
-            Validate.notNull(tooltips, "`tooltips` cannot be empty");
+            var tooltipFunctions = Arrays.stream(tooltips)
+                    .map(t -> (Function<T, Component>) opt -> t)
+                    .toList();
 
-            this.tooltipGetters.addAll(Stream.of(tooltips).map(Component -> (Function<T, Component>) t -> Component).toList());
+            this.tooltipGetters.addAll(tooltipFunctions);
             return this;
         }
 
@@ -277,10 +280,15 @@ public Option<T> build() {
                 MutableComponent concatenatedTooltip = Component.empty();
                 boolean first = true;
                 for (Function<T, Component> line : tooltipGetters) {
+                    Component lineComponent = line.apply(value);
+
+                    if (lineComponent.getContents() == ComponentContents.EMPTY)
+                        continue;
+
                     if (!first) concatenatedTooltip.append("\n");
                     first = false;
 
-                    concatenatedTooltip.append(line.apply(value));
+                    concatenatedTooltip.append(lineComponent);
                 }
 
                 return concatenatedTooltip;

src/testmod/java/dev/isxander/yacl/test/config/GuiTest.java

@@ -57,7 +57,6 @@ private static Screen getFullTestSuite(Screen parent) {
                             .group(OptionGroup.createBuilder()
                                     .name(Component.literal("Boolean Controllers"))
                                     .tooltip(Component.literal("Test!"))
-                                    .collapsed(true)
                                     .option(Option.createBuilder(boolean.class)
                                             .name(Component.literal("Boolean Toggle"))
                                             .tooltip(value -> Component.literal("A simple toggle button that contains the value '" + value + "'"))
@@ -72,6 +71,8 @@ private static Screen getFullTestSuite(Screen parent) {
                                     .option(Option.createBuilder(boolean.class)
                                             .name(Component.literal("Custom Boolean Toggle"))
                                             .tooltip(Component.literal("You can customize these controllers like this!"))
+                                            .tooltip(Component.empty())
+                                            .tooltip(opt -> Component.empty())
                                             .binding(
                                                     defaults.customBooleanToggle,
                                                     () -> config.customBooleanToggle,