README
¶
gio-x
This repository hosts gioui.org/x. Two kinds of package exist in this namespace. Some are extensions that will eventually be merged into gioui.org's core repository once their APIs stabilize and their value to the community is proven. The rest are extensions to Gio that are not likely to be needed by every application and require new dependencies. These will likely never be merged to the core repository, but will be maintained here.
This table describes the current status of each package in gioui.org/x:
| Name | Purpose | Intended for core? | Non-core dependencies? | API Stability |
|---|---|---|---|---|
| colorpicker | Widgets for choosing colors | uncertain | no | unstable |
| component | Material.io components | uncertain | no | unstable |
| haptic | Haptic feedback for mobile devices | no | yes | unstable |
| notify | Background notifications | no | yes | unstable |
| outlay | Extra layouts | yes | no | unstable |
| pref | Query user/device preferences | no | yes | unstable |
| richtext | Printing text objects with different styles | uncertain | no | unstable |
| explorer | Opening a native file dialog | uncertain | yes | unstable |
| markdown | Rendering markdown text as richtext | uncertain | yes | unstable |
| stroke | Complex stroked path support | no | no | unstable |
Contributing
Report bugs on the gio issue tracker with the prefix gio-x: in your issue title.
Ask questions on the gio discussion mailing list.
Send patches on the gio patches mailing list with the subject line prefix [PATCH gio-x]
All patches should be Signed-off to indicate conformance with the LICENSE of this repo.
Tags
Pre-1.0 tags are provided for reference only, and do not designate releases with ongoing support. Bugfixes will not be backported to older tags.
Tags follow semantic versioning. In particular, as the major version is zero:
- breaking API or behavior changes will increment the minor version component.
- non-breaking changes will increment the patch version component.
Maintainers
This repository is primarily maintained by Chris Waldon.
License
Dual MIT/Unlicense; same as Gio
Support
If gio provides value to you, please consider supporting one or more of its developers and maintainers:
Elias Naur: https://github.com/sponsors/eliasnaur
Chris Waldon: https://github.com/sponsors/whereswaldon https://liberapay.com/whereswaldon
Directories
¶
| Path | Synopsis |
|---|---|
|
Package colorpicker provides simple widgets for selecting an RGBA color and for choosing one of a set of colors.
|
Package colorpicker provides simple widgets for selecting an RGBA color and for choosing one of a set of colors. |
|
Package component provides material design UI components as described by https://material.io
|
Package component provides material design UI components as described by https://material.io |
|
Package debug provides tools for layout debugging.
|
Package debug provides tools for layout debugging. |
|
Package haptic implements haptic feedback support for gio.
|
Package haptic implements haptic feedback support for gio. |
|
Package markdown transforms markdown text into gio richtext.
|
Package markdown transforms markdown text into gio richtext. |
|
Package notify provides cross-platform notifications for Gio applications.
|
Package notify provides cross-platform notifications for Gio applications. |
|
Package outlay provides extra layouts for gio.
|
Package outlay provides extra layouts for gio. |
|
pref
module
|
|
|
battery
Package battery provides functions to get the current status of the batteries.
|
Package battery provides functions to get the current status of the batteries. |
|
locale
Package locale can be used to get the end-user preferred language, useful for multi-language apps.
|
Package locale can be used to get the end-user preferred language, useful for multi-language apps. |
|
theme
Package theme provides functions to retrieve user preferences related to theme and accessibility.
|
Package theme provides functions to retrieve user preferences related to theme and accessibility. |
|
Package richtext provides rendering of text containing multiple fonts, styles, and levels of interactivity.
|
Package richtext provides rendering of text containing multiple fonts, styles, and levels of interactivity. |
|
Package stroke converts complex strokes to gioui.org/op/clip operations.
|
Package stroke converts complex strokes to gioui.org/op/clip operations. |
|
Package styledtext provides rendering of text containing multiple fonts and styles.
|
Package styledtext provides rendering of text containing multiple fonts and styles. |