More guide stubbing

This commit is contained in:
Jonathan Johnson 2024-05-11 18:11:24 -07:00
parent 07f1febe9f
commit ddacd53084
No known key found for this signature in database
GPG key ID: A66D6A34D6620579
9 changed files with 90 additions and 3 deletions

View file

@ -30,10 +30,15 @@
- [Canvas](./widgets/controls/canvas.md)
- [Color Pickers](./widgets/controls/color-pickers.md)
- [Delimiter](./widgets/controls/delimiter.md)
- [Disclose](./widgets/controls/disclose.md)
- [Image](./widgets/controls/image.md)
- [Input](./widgets/controls/input.md)
- [Label](./widgets/controls/label.md)
- [ProgressBar](./widgets/controls/progress.md)
- [Scroll](./widgets/controls/scroll.md)
- [Slider](./widgets/controls/slider.md)
- [Space](./widgets/controls/space.md)
- [Switcher]()
- [Image]()
- [TileMap]()
- [Switcher](./widgets/controls/switcher.md)
- [Utility Widgets](./widgets/utility.md)
- [Custom]()
- [Data]()

View file

@ -0,0 +1,6 @@
# Disclose
The [`Disclose`][Disclose] widget hides and shows another widget with a
triangular disclosure indicator and an optional label.
[Disclose]: <{{ docs }}/widgets/disclose/struct.Disclose.html>

View file

@ -0,0 +1,6 @@
# Image
The [`Image`][image] widget displays an image/texture with configurable scaling
options.
[image]: <{{ docs }}/widgets/image/struct.Image.html>

View file

@ -0,0 +1,14 @@
# Input
The [`Input`][Input] widget is a basic text entry widget. It supports
generic-driven storage for some intuitive behaviors:
- When using a `String`, a default text entry widget is used.
- When using a [`MaskedString`][MaskedString], the text entry will be masked and
the contained value will be zeroed before the storage is freed.
When an `Input` is masked, the system input manager is notified that it is a
password entry field.
[Input]: <{{ docs }}/widgets/input/struct.Input.html>
[MaskedString]: <{{ docs }}/widgets/input/struct.MaskedString.html>

View file

@ -0,0 +1,6 @@
# Label
The [`Label`][Label] widget is a read-only text widget. It is intended for
displaying information to the user in a non-interactive manner.
[Label]: <{{ docs }}/widgets/label/struct.Label.html>

View file

@ -0,0 +1,20 @@
# ProgressBar
The [`ProgressBar`][ProgressBar] widget draws an indicator to represent
progress. A progress bar can be indeterminant, empty, partially complete, or
fully complete.
The [`Progressable`][Progressable] trait allows many types to be used within progress bars by
implementing one of several helper traits:
- [`ProgressValue`][ProgressValue]: This trait can be implemented for full control over how
progress is reported.
- Types that ipmlement [`Ranged`][Ranged] and [`PercentBetween`][PercentBetween]
have [`ProgressValue`][ProgressValue] implemented automatically. This includes
all numeric types in Rust..
[ProgressBar]: <{{ docs }}/widgets/progress/struct.ProgressBar.html>
[Progressable]: <{{ docs }}/widgets/progress/trait.Progressable.html>
[ProgressValue]: <{{ docs }}/widgets/progress/trait.ProgressValue.html>
[PercentBetween]: <{{ docs }}/animation/trait.PercentBetween.html>
[Ranged]: <https://docs.rs/figures/latest/figures/trait.Ranged.html>

View file

@ -0,0 +1,6 @@
# Scroll
The [`Scroll`][Scroll] widget presents the widge tit contains in a virtual
surface that can be scrolled horizontally and/or vertically.
[Scroll]: <{{ docs }}/widgets/scroll/struct.Scroll.html>

View file

@ -0,0 +1,16 @@
# Slider
The [`Slider`][Slider] widget allows selecting one or two values between a
minimum and a maximum. This is implemented using the trait
[`SliderValue`][SliderValue], which is automatically implemented for types that
implement [`Ranged`][Ranged] and [`PercentBetween`][PercentBetween]. This
includes all numeric types in Rust.
The `Slider` widget can set either a single value or a tuple of 2 elements. When
a two element tuple is used, the slider highlights the area between the two
selected values.
[Slider]: <{{ docs }}/widgets/slider/struct.Slider.html>
[SliderValue]: <{{ docs }}/widgets/slider/trait.SliderValue.html>
[PercentBetween]: <{{ docs }}/animation/trait.PercentBetween.html>
[Ranged]: <https://docs.rs/figures/latest/figures/trait.Ranged.html>

View file

@ -0,0 +1,8 @@
# Switcher
The [`Switcher`][Switcher] widget allows switching between different widgets at
runtime. It can be used with a read-only `WidgetInstance` dynamic or a
convenience function that allows switching based on a mapping function that
produces the new widget to display.
[Switcher]: <{{ docs }}/widgets/struct.Switcher.html>