furnace/doc/2-interface/components.md
2023-09-08 20:16:43 -05:00

86 lines
2.9 KiB
Markdown

# UI components
the user interface consists of several kinds of components, some of which benefit from explanation.
## text fields
text fields are able to hold... text.
click on a text field to start editing, and click away to stop editing.
the following keyboard shortcuts work while on a text field:
- `Ctrl-X`: cut
- `Ctrl-C`: copy
- `Ctrl-V`: paste
- `Ctrl-A`: select all
(replace Ctrl with Command on macOS)
## number input fields
these work similar to text fields, but you may only input numbers.
they also usually have `+` and `-` buttons which allow you to increase/decrease the amount when clicked (and rapidly do so when click-holding).
## sliders
sliders are used for controlling values in a quick manner by being dragged.
using the scroll wheel while holding Ctrl will change the slider's value by small amounts.
right-clicking or Ctrl-clicking or a slider (Command-click on macOS) will turn it into a number input field for a short period of time, allowing you to input precise values.
## windows
![window](window.png)
windows may be moved, collapsed, closed or even docked around the workspace.
to move a window, press and hold the mouse button while on title bar or any empty space on it.
then drag your mouse, and release it to stop moving.
to resize a window, drag the bottom right corner (marked by a triangular tab) or the borders.
to collapse a window, click on the triangle in the title bar.
clicking again expands it.
to close a window, click on the `X` at the top right corner, or select it from the "window" menu.
### arrangement and docking
windows may be docked, which comes in handy.
to dock a window, drag it from its title bar to another location in the workspace or to the location of another window.
while dragging, an overlay with some options will appear, allowing you to select where and how to dock that window.
the options are:
![docking options](docking.png)
drag your mouse cursor to any of the options to dock the window.
if you drag to the sides, the window will cover that side of the workspace.
if you drag it to a window or empty space, five docking positions will appear.
if you drag the window to the center of another window, it will appear as another tab.
if you drag the window to the center of empty space, the window will cover aforementioned empty space.
otherwise the window will be split in two, with the first half covered by the window you docked and the second half covered by the other window.
![tab1](tab1.png)
when a window is docked, its title bar turns into a tab bar, and the function provided by the "collapse" triangle at the top left changes.
![tab2](tab2.png)
if this triangle is clicked, a menu will appear with a list of tabs, or a single option if there's only one tab: "Hide tab bar".
selecting this option will hide the tab bar of that window.
![tab3](tab3.png)
to bring it back, click on the top left corner.
to undock a window, drag its tab away from where it is docked. then it will be floating again.