fluid.scroll_frame

ScrollFrame is a container node that can be "scrolled" to display content that can't normally fit in view.

ScrollFrame can be created using either vscrollFrame to create a vertical frame (column) or hscrollFrame to create a horizontal frame (row).

Contents can be scrolled using mouse wheel or the included scroll bar (see ScrollFrame.scrollBar). Keyboard users may be able to tab into the scrollbar and use arrow, page up, and page down keys to scroll.

You can use fluid.actions.scrollToTop or fluid.actions.scrollIntoView to move child nodes into view by calculating the right offsets. The two functions work even if multiple scroll frames (and other scrollable nodes) are nested.

```
alias vscrollFrame = fluid.utils.nodeBuilder!(ScrollFrame, "a").nodeBuilder;
```
Create a new vertical ScrollFrame node. The frame will display its contents in a column.

alias hscrollFrame = fluid.utils.nodeBuilder!(ScrollFrame, (a)
{
a.directionHorizontal = true;
}
).nodeBuilder;

Create a new horizontal ScrollFrame node. The frame will display its contents in a row.

```
class ScrollFrame: fluid.frame.Frame, fluid.input.FluidScrollable, fluid.io.hover.HoverScrollable;
```
The ScrollFrame is a Frame that can be scrolled to display content that would not normally fit into the frame.

The frame features a scrollBar on the side that can be used to control the frame using a mouse or keyboard. The frame can also be scrolled using a mouse wheel through the HoverScrollable interface.
This node only supports scrolling in one axis.
- ScrollInput scrollBar;
  Scrollbar node used by the frame. The scrollbar shows how far the frame has been scrolled and can be used to control the frame.
  
  A scrollbar will be provided by default but can be replaced with another ScrollInput node.
  
  Bugs
  The scrollbar is internally used by the frame to perform calculations. The frame will malfunction if the scrollbar is hidden. See https://git.samerion.com/Samerion/Fluid/issues/495
  This can be worked around by setting scrollBar.width to 0.
- ref @safe inout(float) scroll() inout; @safe float scroll() const;
  Return value
  Distance in pixels the node is scrolled by. For vscrollFrame, this is distance from the top of the frame, and from the left for hscrollFrame.
  The value of 0 means the frame is currently scrolled to the very top or the very left.
- @safe float scroll(float value);
  Set the scroll offset for the frame.
  
  Parameters
  
  float value New scroll offset to set.
  
  Return value
  The distance as passed.
- @safe void scrollToStart();
  Scroll to the beginning of the node, that is, set scroll to 0.
- @safe void scrollToEnd();
  Scroll to the end of the node, changing scroll to maxScroll. The frame must have been resized at least once for this to work.
- @safe float maxScroll() const;
  Return value
  The maximum value this container can be scrolled to. The frame must have been resized at least once for this to return a correct value, otherwise it will return 0.

fluid.scroll_frame

Bugs

Return value

Parameters

Return value

Return value