docs: add hint about using setSplitterPosition with vertical orientat…

…ion (#1817) (#1825) Added hint that when using `setSplitterPosition` in a vertical split layout, the split layout must have an explicit height. Part of #1002 , addresses [this comment](#1002 (comment)) Co-authored-by: Sascha Ißbrücker <[email protected]>
vaadin · Jun 21, 2021 · e4aee3d · e4aee3d
1 parent 8c9f27d
commit e4aee3d
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...in-split-layout-flow/src/main/java/com/vaadin/flow/component/splitlayout/SplitLayout.java b/...in-split-layout-flow/src/main/java/com/vaadin/flow/component/splitlayout/SplitLayout.java
@@ -284,6 +284,11 @@ public Component getSecondaryComponent() {
      * of the component and in vertical mode this is the height. The given value
      * will automatically be clamped to the range [0, 100].
      *
+     * Note that when using vertical orientation, this method only works if the
+     * split layout has an explicit height, either as an absolute value or as
+     * percentage. When using a percentage value, ensure that ancestors have an
+     * explicit height as well.
+     *
      * @param position
      *            the relative position of the splitter, in percentages
      */