Avalonia.FuncUI v1.0 release

[sleepyfran]

Opening this issue to track the work needed before we release the non-pre-release version of v0.6

Before release

• Wait for Avalonia v11 to be released (duh!)
• Adapt to "The Great Interface Removal" introduced in The Great Interface Removal Part I AvaloniaUI/Avalonia#9553 (Addressed in Update to build with Avalonia 11 Preview 5 #246)
• Remove mention to old docs site in README and point all of them to the docs site under Avalonia's domain
• Create a Migration Guide in the docs
  • Interface removals (Update to build with Avalonia 11 Preview 5 #246)
  • Changes for Elmish v4 (Elmish v4 Changes #248)
  • Package name changes (JaggerJo.Avalonia.FuncUI --> Avalonia.FuncUI #242)
• Migrate templates to new version (includes adding dependency of the newly separated Avalonia.Themes.Fluent)
• Deprecate Avalonia.FuncUI.DSL package from Nuget. See here. I believe this can only be done by you @JaggerJo?

Since 4564a6d the DSL project lives inside of the main FuncUI package and upgrading from a previous version that has the a package reference to the DSL makes all this funky errors where half of the imports seem unused and all the controls stop working:

The fix is, of course, to remove the package reference to the DSL but I think we should make this clearer to the user.

After release

• Create documentation for new inline components
• Party? 🎉

[JaggerJo]

Like the Party 🎉 part of it 😁

[JaggerJo]

I can deprecate the DSL package shortly before we plan to release the new version 👍

[JaggerJo]

I'm not happy at all with the documentation situation right now. 🙃

[sleepyfran]

I'm not happy at all with the documentation situation right now. 🙃

Yeah, actually I just realized that we have the GitBook under the Avalonia's domain up and working, I'll add another task here to sunset the current one we have (https://avaloniacommunity.github.io/Avalonia.FuncUI.Docs/) and add the one under Avalonia's domain to the README. What else do you think we should do to improve it? I'm all up for making the docs better, it's true that we're lacking a bit here.

[JaggerJo]

Yes exactly, that's a good first step! (copying our docs over) 👍

I think we have a lot of good stuff in the docs, but it could use some polishing.

Getting started:
I don't think templates should be recommended that much.
I personally prefer to install some packages and pasting a few lines of code.
Might be just me tho.

Why? Needing templates implies complexity and for FuncUI all you really need is this (and the view could be reduced to a lot less code):

namespace Examples.CounterApp

open Avalonia
open Avalonia.Controls
open Avalonia.Controls.ApplicationLifetimes
open Avalonia.FuncUI
open Avalonia.FuncUI.DSL
open Avalonia.Layout
open Avalonia.Themes.Fluent
open Avalonia.FuncUI.Hosts

module Views =
    let counter =
        Component
            (fun ctx ->
                let state = ctx.useState 0

                DockPanel.create [
                    DockPanel.children [
                        Button.create [
                            Button.dock Dock.Bottom
                            Button.onClick (fun _ -> state.Current - 1 |> state.Set)
                            Button.content "-"
                            Button.horizontalAlignment HorizontalAlignment.Stretch
                        ]
                        Button.create [
                            Button.dock Dock.Bottom
                            Button.onClick (fun _ -> state.Current + 1 |> state.Set)
                            Button.content "+"
                            Button.horizontalAlignment HorizontalAlignment.Stretch
                        ]
                        TextBox.create [
                            TextBox.dock Dock.Bottom
                            TextBox.onTextChanged (
                                (fun text ->
                                    let isNumber, number = System.Int32.TryParse text
                                    if isNumber then number |> state.Set)
                            )
                            TextBox.text (string state.Current)
                            TextBox.horizontalAlignment HorizontalAlignment.Stretch
                        ]
                        TextBlock.create [
                            TextBlock.dock Dock.Top
                            TextBlock.fontSize 48.0
                            TextBlock.verticalAlignment VerticalAlignment.Center
                            TextBlock.horizontalAlignment HorizontalAlignment.Center
                            TextBlock.text (string state.Current)
                        ]
                    ]
                ])

type MainWindow() =
    inherit HostWindow()
    do
        base.Title <- "Counter Example"
        base.Height <- 400.0
        base.Width <- 400.0
        base.Content <- Main.view

type App() =
    inherit Application()

    override this.Initialize() =
        this.Styles.Add (FluentTheme(baseUri = null, Mode = FluentThemeMode.Dark))

    override this.OnFrameworkInitializationCompleted() =
        match this.ApplicationLifetime with
        | :? IClassicDesktopStyleApplicationLifetime as desktopLifetime ->
            let mainWindow = MainWindow()
            desktopLifetime.MainWindow <- mainWindow
        | _ -> ()

module Program =

    [<EntryPoint>]
    let main(args: string[]) =
        AppBuilder
            .Configure<App>()
            .UsePlatformDetect()
            .UseSkia()
            .StartWithClassicDesktopLifetime(args)

[Numpsy]

Hi,

As I mentioned in #232, it looks like version 11 of Avalonia.Web only supports .NET 7.0, so I guess that the FuncUI WebAssembly sample will need to be the same - and that would also mean that the CI builds would need changing to use the .NET 7 SDK rather than 6 - so, is that possible/acceptable? (I'm not sure if the github build pipelines have the new SDK available by default yet though)

[Numpsy]

fyi, the Avalonia change at AvaloniaUI/Avalonia#9553 has removed a load of interfaces that FuncUI uses, apparently in favour of just using the base classes instead, which is an ever so slightly breaking change over here.

I had a quick go at changing the lib to just use the base clases instead of interfaces and the control catalogue seems to still run, but I didn't check anything beyond that

[sleepyfran]

fyi, the Avalonia change at AvaloniaUI/Avalonia#9553 has removed a load of interfaces that FuncUI uses, apparently in favour of just using the base classes instead, which is an ever so slightly breaking change over here.

I had a quick go at changing the lib to just use the base clases instead of interfaces and the control catalogue seems to still run, but I didn't check anything beyond that

Oh, boy. Thanks for the heads up! I guess a search and replace of I.* should do the trick 😆 Adding that to the checklist

[Numpsy]

Small nit about the nuget packages - the package description fields shown on nuget.org are just 'Package Description' - I think it'd look nicer if there were something useful there?

[Numpsy]

On the subject of nuget packages - anyone have any opinions on adding SourceLink to the build?

[JaggerJo]

On the subject of nuget packages - anyone have any opinions on adding SourceLink to the build?

Great idea!

[Numpsy]

It looks like another breaking change has been made in Avalonia - the change at AvaloniaUI/Avalonia#10112 has moved ItemsRepeater into a separate nuget package, which breaks the bindings in the core FuncUI library.

So - what would the preferred approach to handling that change be?