V1.0.0 Release

.config/dotnet-tools.json

@@ -3,14 +3,18 @@
   "isRoot": true,
   "tools": {
     "fantomas": {
-      "version": "6.3.16",
-      "commands": ["fantomas"],
+      "version": "7.0.2",
+      "commands": [
+        "fantomas"
+      ],
       "rollForward": true
     },
     "fsdocs-tool": {
       "version": "20.0.1",
-      "commands": ["fsdocs"],
+      "commands": [
+        "fsdocs"
+      ],
       "rollForward": true
     }
   }
-}
+}

.devcontainer/Dockerfile

@@ -1,6 +1,6 @@
 FROM mcr.microsoft.com/devcontainers/base:ubuntu-22.04
 
-RUN curl -fsSL https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh | bash /dev/stdin -c 8.0 --install-dir /home/vscode/.dotnet
+RUN curl -fsSL https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.sh | bash /dev/stdin -c 9.0 --install-dir /home/vscode/.dotnet
 
 ENV DOTNET_ROOT=/home/vscode/.dotnet
 ENV PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools

.github/workflows/docs.yml

@@ -5,8 +5,10 @@ on:
   push:
     branches:
       - main
+      - vnext
     paths:
       - docs/**
+      - .github/workflows/docs.yml
 
 # We need some permissions to publish to Github Pages
 permissions:
@@ -22,9 +24,11 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: 8.0.x
+          dotnet-version: 9.0.x
       - name: Restore tools
-        run: dotnet tool restore
+        # Force installation of fsdocs alone while fantomas install is fixed in .net9
+        # https://github.com/fsprojects/fantomas/issues/3139
+        run: dotnet new tool-manifest --force && dotnet tool install fsdocs-tool
       - name: Build code
         run: dotnet build -c Release
       - name: Generate the documentation'

.github/workflows/library.yml

@@ -17,25 +17,13 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Build dotnet 8.0
+    name: Build
     steps:
       - uses: actions/checkout@v4
       - name: Setup dotnet
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: "8.0.x"
+          dotnet-version: "9.0.x"
       - run: dotnet restore
-      - run: dotnet build Navs.sln -f net8.0 --configuration Release --no-restore
-      - run: dotnet test Navs.sln -f net8.0 --no-restore
-  buildnet6:
-    runs-on: ubuntu-latest
-    name: Build dotnet 6.0
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup dotnet
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: "6.0.x"
-      - run: dotnet restore
-      - run: dotnet build Navs.sln -f net6.0 --configuration Release --no-restore
-      - run: dotnet test Navs.sln -f net6.0 --no-restore
+      - run: dotnet build Navs.sln --configuration Release --no-restore
+      - run: dotnet test Navs.sln --no-restore

.github/workflows/samples.yml

@@ -20,12 +20,12 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    name: Build dotnet 8.0
+    name: Build dotnet 9.0
     steps:
       - uses: actions/checkout@v4
       - name: Setup dotnet
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: "8.0.x"
+          dotnet-version: "9.0.x"
       - run: dotnet restore samples/Samples.sln
-      - run: dotnet build samples/Samples.sln -f net8.0 --configuration Release --no-restore
+      - run: dotnet build samples/Samples.sln -f net9.0 --configuration Release --no-restore

.vscode/launch.json

@@ -4,6 +4,31 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "Debug Terminal.Gui Sample",
+      "type": "coreclr",
+      "request": "launch",
+      "preLaunchTask": "build:tgui",
+      "program": "${workspaceFolder}/samples/TGUI/bin/Debug/net9.0/TGUI.dll",
+      "args": [
+        "tgui:///login?username=admin"
+      ],
+      "cwd": "${workspaceFolder}",
+      "stopAtEntry": false,
+      "console": "externalTerminal"
+    },
+    {
+      "name": "Debug Declarative Sample",
+      "type": "coreclr",
+      "request": "launch",
+      "preLaunchTask": "build:declarative",
+      "program": "${workspaceFolder}/samples/NxuiDeclarative/bin/Debug/net9.0/NxuiDeclarative.dll",
+      "args": [],
+      "cwd": "${workspaceFolder}",
+      "stopAtEntry": false,
+      "console": "integratedTerminal"
+    },
+
     {
       "name": "Debug Router Tests",
       "type": "coreclr",
@@ -14,6 +39,7 @@
       "cwd": "${workspaceFolder}",
       "stopAtEntry": false,
       "console": "internalConsole"
-    }
+    },
+
   ]
 }

.vscode/tasks.json

@@ -16,6 +16,38 @@
         "-f",
         "net8.0"
       ]
+    },
+    {
+      "command": "dotnet",
+      "label": "build:tgui",
+      "type": "shell",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$msCompile",
+      "args": [
+        "build",
+        "${workspaceFolder}/samples/TGUI/TGUI.fsproj",
+        "-f",
+        "net9.0"
+      ]
+    },
+    {
+      "command": "dotnet",
+      "label": "build:declarative",
+      "type": "shell",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$msCompile",
+      "args": [
+        "build",
+        "${workspaceFolder}/samples/NxuiDeclarative/NxuiDeclarative.fsproj",
+        "-f",
+        "net9.0"
+      ]
     }
   ]
 }

Navs.slnx

@@ -0,0 +1,11 @@
+<Solution>
+  <Folder Name="/src/">
+    <Project Path="src/Navs.Avalonia/Navs.Avalonia.fsproj" />
+    <Project Path="src/Navs.FuncUI/Navs.FuncUI.fsproj" />
+    <Project Path="src/Navs.Terminal.Gui/Navs.Terminal.Gui.fsproj" />
+    <Project Path="src/Navs/Navs.fsproj" />
+    <Project Path="src/UrlTemplates/UrlTemplates.fsproj" />
+    <Project Path="src/Navs.Tests/Navs.Tests.fsproj" />
+    <Project Path="src/UrlTemplates.Tests/UrlTemplates.Tests.fsproj" />
+  </Folder>
+</Solution>

README.md

@@ -17,7 +17,7 @@ Navs is a router-like abstraction inspired by web routers such as vue-router, an
 
 It is primarily a "core" library which you would usually depend on in your own projects, as it is very generic and while F# can be very intelligent about type inference, it tends to produce quite verbose signatures. For more information visit the Navs section in these docs.
 
-- [Navs](./Navs.fsx)
+- [Navs](https://angelmunoz.github.io/Navs/Navs.html)
 
 A Compelling Example:
 
@@ -32,14 +32,14 @@ let routes = [
     fun context _ -> async {
       do! Async.Sleep(90)
       return
-        match context.UrlMatch.Params.TryGetValue "id" with
-        | true, id -> sprintf "Home %A" id
-        | false, _ -> "Guid No GUID"
+        match context.getParam<Guid> "id" with
+        | ValueSome id -> sprintf "Home %A" id
+        | ValueNone -> "Guid No GUID"
     }
   )
 ]
 
-let router = Router.get<string>(routes)
+let router = Router.build<string>(routes)
 
 router.Content.AddCallback(fun content -> printfn $"%A{content}")
 
@@ -57,7 +57,7 @@ let! result3 = router.navigate("/123e4567-e89b-12d3-a456-426614174000")
 
 This project attempts to hide the generics from call sites and offer a few DSLs to make it easier to use Navs in Avalonia applications. This router was designed to be used with Raw Avalonia Control classes however, it will pair very nicely with the [NXUI](https://github.com/wieslawsoltes/NXUI) project, Feel free to check the C# and F# samples in the [Samples](https://github.com/AngelMunoz/Navs/tree/main/samples) folder in the source code repository.
 
-- [Navs.Avalonia](./Navs.Avalonia/index.md)
+- [Navs.Avalonia](https://angelmunoz.github.io/Navs/Navs-Avalonia.html)
 
 A Compelling Example:
 
@@ -73,7 +73,7 @@ let routes = [
       do! Async.Sleep(90)
       return
         // extract parameters from the URL
-        match context.urlMatch |> UrlMatch.getFromParams<guid> "id" with
+        match context.getParam<guid> "id" with
         | ValueSome id -> TextBlock().text(sprintf "Home %A" id)
         | ValueNone -> TextBlock().text("Guid No GUID")
     }
@@ -82,13 +82,6 @@ let routes = [
   Route.define("books", "/books", (fun _ _ -> TextBlock().text("Books")))
 ]
 
-let getMainContent (router: IRouter<Control>) =
-  ContentControl()
-    .DockTop()
-    // with NXUI you can use the .content method to bind the content
-    // to the observable in a seamless way
-    .content(router.Content |> AVal.toBinding)
-
 let navigate url (router: IRouter<Control>) _ _ =
   task {
     // navigation is asynchronous and returns a result
@@ -120,7 +113,7 @@ let app () =
                 .content("Guid")
                 .OnClickHandler(navigate $"/{Guid.NewGuid()}" router)
             ),
-          getMainContent(router)
+          RouterOutlet().router(router)
         )
     )
 
@@ -132,7 +125,7 @@ NXUI.Run(app, "Navs.Avalonia!", Environment.GetCommandLineArgs()) |> ignore
 
 In a similar Fashion of Navs.Avalonia, this project attempts to provide a smooth API interface for [Avalonia.FuncUI](https://github.com/fsprojects/Avalonia.FuncUI/), you can find a sample in the [Samples](https://github.com/AngelMunoz/Navs/tree/main/samples) folder in the source code repository.
 
-- [Navs.FuncUI](./Navs.FuncUI/index.md)
+- [Navs.FuncUI](https://angelmunoz.github.io/Navs/Navs-FuncUI.html)
 
 A Compelling Example:
 
@@ -150,7 +143,7 @@ let routes = [
     fun context _ -> async {
       return
         TextBlock.create [
-          match context.urlMatch |> UrlMatch.getFromParams<guid> "id" with
+          match context.getParam<guid> "id" with
           | ValueSome id -> TextBlock.text $"Visited: {id}"
           | ValueNone -> TextBlock.text "Guid No GUID"
         ]
@@ -176,7 +169,7 @@ This is a library for parsing URL-like strings into structured objects. It is us
 
 Currently this library is mainly aimed to be used from F# but if there's interest in using it from C# I can add some more friendly APIs.
 
-- [UrlTemplates](./UrlTemplates.fsx)
+- [UrlTemplates](https://angelmunoz.github.io/Navs/UrlTemplates.html)
 
 A Compelling Example: