https://github.com/funcui/avalonia.funcui
Develop cross-plattform GUI Applications using F# and Avalonia!
https://github.com/funcui/avalonia.funcui
avalonia avaloniaui dotnet elmish fsharp gui mvu ui
Last synced: 3 months ago
JSON representation
Develop cross-plattform GUI Applications using F# and Avalonia!
- Host: GitHub
- URL: https://github.com/funcui/avalonia.funcui
- Owner: fsprojects
- License: mit
- Created: 2019-05-09T19:51:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-25T09:03:26.000Z (4 months ago)
- Last Synced: 2025-07-17T00:12:19.633Z (3 months ago)
- Topics: avalonia, avaloniaui, dotnet, elmish, fsharp, gui, mvu, ui
- Language: F#
- Homepage: https://funcui.avaloniaui.net/
- Size: 20.6 MB
- Stars: 1,084
- Watchers: 33
- Forks: 77
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://vshymanskyy.github.io/StandWithUkraine)
Avalonia FuncUI
Develop cross-platform GUI Applications using F# and AvaloniaUI!
## About
FuncUI is a thin layer built on top of [AvaloniaUI](https://github.com/AvaloniaUI/Avalonia). It contains abstractions
for writing UI applications in different programming styles. It also contains a component & state management system.
FuncUI mostly consists of:
- Virtual DOM
- View DSL
- Component model
## Resources
- 💨 [Getting started](https://funcui.avaloniaui.net)
- 📚 [Documentation](https://funcui.avaloniaui.net/)
- 📓 [Examples](https://github.com/fsprojects/Avalonia.FuncUI/tree/master/src/Examples)
## Contributing
Please contribute to this library through issue reports, pull requests, code reviews, documentation, and discussion.
## Examples
### Example using components
A simple counter made with the component library:
``` f#
type Components =
static member Counter () =
Component (fun ctx ->
let state = ctx.useState 0
DockPanel.create [
DockPanel.children [
Button.create [
Button.onClick (fun _ -> state.Set(state.Current - 1))
Button.content "click to decrement"
]
Button.create [
Button.onClick (fun _ -> state.Set(state.Current + 1))
Button.content "click to increment"
]
TextBlock.create [
TextBlock.dock Dock.Top
TextBlock.text (string state.Current)
]
]
]
)
```
Find more examples using components in the [Components Examples folder](https://github.com/fsprojects/Avalonia.FuncUI/tree/master/src/Examples/Component%20Examples).
### Example using Elmish
The same counter as above but using the `Avalonia.FuncUI.Elmish` package:
```f#
module Counter =
type CounterState = { count : int }
let init = { count = 0 }
type Msg = Increment | Decrement
let update (msg: Msg) (state: CounterState) : CounterState =
match msg with
| Increment -> { state with count = state.count + 1 }
| Decrement -> { state with count = state.count - 1 }
let view (state: CounterState) (dispatch): IView =
DockPanel.create [
DockPanel.children [
Button.create [
Button.onClick (fun _ -> dispatch Increment)
Button.content "click to increment"
]
Button.create [
Button.onClick (fun _ -> dispatch Decrement)
Button.content "click to decrement"
]
TextBlock.create [
TextBlock.dock Dock.Top
TextBlock.text (sprintf "the count is %i" state.count)
]
]
]
```
Find more examples using Elmish in the [Elmish Examples folder](https://github.com/fsprojects/Avalonia.FuncUI/tree/master/src/Examples/Elmish%20Examples)
# Maintainer(s)
The current co-maintainers of Avalonia.FuncUI are
* @Numpsy
* @JordanMarr
* @sleepyfran
* @JaggerJo (project originator)
The default maintainer account for projects under "fsprojects" is @fsprojectsgit - F# Community Project Incubation Space (repo management)
# Commercial Support
**Provided by [Voynoic Systems GmbH](https://www.voyonic-systems.de)**
Please reach out to contact@voyonic-systmes.de if you need a commercial support contract or are interested in contract work.
# Star History
