v11 How-To Guides - Requesting suggestions #11182
Replies: 30 comments 50 replies
-
But first you need to implement a mechanism similar to readthedocs which allows you to manage different versions (0.9.x, 0.10.x, 11.x) of the documentation. |
Beta Was this translation helpful? Give feedback.
-
Can I suggest -> How to implement a column filter on the datagrid. Additionally, v11.docs.avaloniaui are really difficult to find from the standard docs docs.avaloniaui. It would be good to have a direct link to v11 on the standard docs. |
Beta Was this translation helpful? Give feedback.
-
I know there are examples for this, but I think a guide |
Beta Was this translation helpful? Give feedback.
-
As CJK user, embedding and using fonts is always painful, especially in wasm project. Could be nice to have a guide guarantee to work. |
Beta Was this translation helpful? Give feedback.
-
Some release oriented How To would be really useful:
|
Beta Was this translation helpful? Give feedback.
-
How to setup the project for native AOT build. |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
I would like to see a how-to on creating a basic desktop CRUD application with a Sqlite database (add, update, delete records with a datagrid or list view for the records). |
Beta Was this translation helpful? Give feedback.
-
Non exhaustive list cause I just went through a bunch of problems myself in my current project:
Those I would say were my biggest pain points. I just think that the current approach of the docs is aimed at experienced wpf devs moving to avalonia rather than being completely new to this concept despite the fact the docs ALSO does have pages about this angle. While it is nice to see this, I feel it's not enough for me to go from beginner in avalonia to intermediate where it feels like a huge difficulty spike because of the docs. As for howto suggestion: making wrappers around models that do not implement change notifications. This is something I wanted to do for reasons, but searching online, I see not only many others ran into this need, but I also saw how lacking the explanations for this usecase are everywhere. Even wpf articles, I took a bit to find out the optimal way to do this. I think it's something avalonia could do well in documenting, bonus points if it involves collection which I made my own abstraction to make it work, but it took a while to get there. |
Beta Was this translation helpful? Give feedback.
-
I would love for this to not just cover the visual side, but also handling the routing as well. I know there is a ticket for version 11 for page based navigation routing and would like to have some firm examples to follow if that makes it into the release. My current application that I am developing is using the ReactiveUI routed view host, but if you are not already invested into ReactiveUI then there isn't really any guidance on what to do. One other thing that I would really love to see is some more explicit documentation on lifecycle methods of controls. One problem that I have faced in the past was manipulating the position of a control based off of its parents height. I ended up using |
Beta Was this translation helpful? Give feedback.
-
How to create a single instance application (and bring existing MainWindow to front) |
Beta Was this translation helpful? Give feedback.
-
Main UI topics not covered:
Since Avalonia is a UI framework only there are several things not covered that cross-platform app developers will need. These will keep coming up so it might be best to devote a section to them as well.
I also just updated the XAML framework comparison: https://github.com/robloo/PublicDocs/blob/master/XAMLFrameworkComparison.md You might want to review for areas that should be documented in a guide to fill in gaps/explain differences with .NET MAUI or Uno Platform. |
Beta Was this translation helpful? Give feedback.
-
I'd appreciate a detailed guid for porting from v10 to v11. |
Beta Was this translation helpful? Give feedback.
-
How to rewrite the control template of a control? It is very important for a new comer. |
Beta Was this translation helpful? Give feedback.
-
Reorder some documents to be in better order, for example the "Basics" section should be way up near the top. "Layout" should also be higher, and "Styling" maybe after "Controls". It would be great to be able to download the docs so they can be accessed offline. I know there's a PDF export but it doesn't seem to contain any contents so it's rather hard to find anything in there. Some better explanation of "DependencyProperty". I was trying to follow a WPF tutorial on Routed Events and then had to give up because Avalonia does it differently and I couldn't figure out what to substitute and where. Please note, I'm a total noob at Avalonia and never touched WPF, so maybe my suggestions are dumb. |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
The Slider basically has no documentation, just links to the API page and it's source code. As a new user I found it terribly confusing trying to figure out how to get a sliders value as it is changing because the slider does not logically have a ValueChanged event like most other controls that support input (and most other frameworks or whatever that have a slider control). Instead I had to google and eventually found 10080 which contained a code snippet that I eventually used. So having some solid documentation on the sliders arcane inner workings would be great :) |
Beta Was this translation helpful? Give feedback.
-
As discussed in tg, we should have a documentation page for control lifecycle. |
Beta Was this translation helpful? Give feedback.
-
These two might be part of "How to use platform features," but I ran into two issues building a cross-platform app that I put together quick solutions for, and I thought it might be nice if the Avalonia docs could recommend more tried and true solutions:
|
Beta Was this translation helpful? Give feedback.
-
I would like to see a guide app that you can "just" download and see it live. With integrated code/Xaml viewer etc. Maybe you could combine it with the "Avalonia Control Gallery". Because until today you can't just test the app without going to the Microsoft Store. At the end of the day, it's all about taking beginners by the hand and helping them learn how to do it all. Of course, there must also be in-depth documentation. But for this, the entry hurdle must first be kept small. |
Beta Was this translation helpful? Give feedback.
-
How to mutate visual tree depending on a state. Going beyond |
Beta Was this translation helpful? Give feedback.
-
A more detailed tutorial on themes would be useful, such as
|
Beta Was this translation helpful? Give feedback.
-
For each XAML example in docs also show view markup in C# code version of an example (if you are serious about Avalonia.Markup.Declarative). |
Beta Was this translation helpful? Give feedback.
-
I think it would be extremely useful to provide a detailed tutorial on how to develop an adaptive application for both Desktop and Mobile from a single codebase, including best practices, gotchas, accessing platform-specific APIS, and the publishing process for Mobile. I think having something similar to how Flutter does it would be extremely valuable to the Avalonia community. |
Beta Was this translation helpful? Give feedback.
-
One frequently asked question for desktop apps:
|
Beta Was this translation helpful? Give feedback.
-
I'm not sure if it'd belong to the main docs, but some samples on Style/Event/DataTriggers (from Avalonia.Xaml.Behaviors) would be nice. Specifically, how and when Avalonia's style system can be leveraged to make some things that weren't as trivial on WPF more palatable with Avalonia. |
Beta Was this translation helpful? Give feedback.
-
Reading through all the comments, here's my 2 cents to keep everything a bit more organized:
|
Beta Was this translation helpful? Give feedback.
-
Could there be a page on testing the UI of the app? |
Beta Was this translation helpful? Give feedback.
-
Fwiw @timunie I tried Avalonia early 2023 and I just couldn't figure anything out. I switched to Tauri. I tried again In March 2024 and had a working prototype a month later. I credit two things: the Avalonia docs got amazingly better. And wieslawsoltes/ChatGPT. I don't even use ChatGPT (heresy I know) but it's a smallish forms app with some http calls that pretty strictly follows the hexagonal architecture I expected. I hacked that down to a very simple search bar and datagrid app and it's been full throttle since. |
Beta Was this translation helpful? Give feedback.
-
I need "How to debug Avalonia Browser" and relative content like "Threading/Async in browser project" |
Beta Was this translation helpful? Give feedback.
-
As we prepare for the release of Avalonia v11, we're keen to strengthen our documentation, especially regarding how-to guides. Guides are problem-oriented and take the reader through the steps required to solve a real-world problem. Each guide will come with a completed project to clone and explore at your leisure.
We're looking for suggestions on what content you'd like to see. We've currently got the following items on our to-do list:
Beta Was this translation helpful? Give feedback.
All reactions