language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-01 14:21:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update the Flickable and ScrollView docs...

Browse source 
...to include mention that the default is for the viewport dimensions to
be calculated automatically and add properties and and an example to the
Flickable docs
This commit is contained in:
Jared Moulton 2021-12-05 10:35:37 -07:00 • committed by Olivier Goffart
parent a3c0771a2a
commit 63fd204dda
2 changed files with 40 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docs/builtin_elements.md
View file

@ -576,22 +576,43 @@ FIXME: write docs
## `Flickable`
FIXME: write docs
The `Flickable` is a lower-level item that is the base for scrollable
elements, such as the ScrollView widget. When the viewport-width or the
viewport-height is greater than the parent width or parent height
respectively the element becomes scrollable although the `Flickable`
does not create a scrollbar. When using a for loop to populate the
elements, the viewport-width and viewport-height are not automatically
calculated and scrolling will not work properly until the viewport-width
or viewport-height are set manually for the horizontal and vertical
scrolling respectively. The ability to automatically calculate the
viewport-width and viewport-height when using for loops may be added in
the future and is tracked in issue #407.
does not create a scrollbar. The viewport-width and viewport-height are
calculated automatically except for when using a for loop to populate
the elements. In that case they are not automatically calculated. The
ability to automatically calculate the viewport-width and
viewport-height when using for loops may be added in the future and is
tracked in issue #407.
When not part of a layout, its width or height defaults to 100% of the parent element when not specified.
### Properties
* **`viewport-height`** (*length*): The total scrollable height
* **`viewport-width`** (*length*): The total scrollable width
* **`viewport-x: native_output`** (*length*):
* **`viewport-y: native_output`** (*length*):
* **`interactive: true (*bool*):
### Example
```60
Example := Window {
width: 270px;
height: 100px;
Flickable {
viewport-height: 300px;
Text {
y: 150px;
text: "This is some text that you have to scroll to see";
}
}
}
```
## `TextInput`
The `TextInput` is a lower-level item that shows text and allows entering text.

17
docs/widgets.md
View file

@ -225,15 +225,14 @@ Example := Window {
## `ScrollView`
A Scrollview contains a viewport that is bigger than the view and can be scrolled.
It has scrollbar to interact with.
When using a for loop to populate the elements, the viewport-width and
viewport-height are not automatically calculated and scrolling will not
work properly until the viewport-width or viewport-height are set
manually for the horizontal and vertical scrolling respectively.
The ability to automatically calculate the viewport-width and
viewport-height when using for loops may be added in the future and is
tracked in issue #407.
A Scrollview contains a viewport that is bigger than the view and can be
scrolled. It has scrollbar to interact with. The viewport-width and
viewport-height are calculated automatically to create a scollable view
except for when using a for loop to populate the elements. In that case
the viewport-width and viewport-height are not calculated automatically
and must be set manually for scrolling to work. The ability to
automatically calculate the viewport-width and viewport-height when
using for loops may be added in the future and is tracked in issue #407.
### Properties