Documentation

Author: carson-katri

README.md

@@ -1,4 +1,4 @@
-# SwiftWebUI Router
+# [SwiftWebUI](https://github.com/carson-katri/SwiftWebUI) Router
 
 A simple Router for SwiftWebUI:
 
@@ -39,3 +39,42 @@ module.exports = {
 };
 ```
 Now the server will always serve your index.html, no matter the route.
+
+# Docs
+
+## `Router`
+A container for `Routes`.
+Uses `location.pathname` to resolve which `Route` to render:
+```swift
+Router {
+    ...
+}
+```
+
+## `Route`
+A map from a path to a View
+Path can contains arguments, such as `/artists/:artistId/song/:songId`:
+```swift
+Route(to: "/artists/:artistId/song/:songId") { args in
+    VStack {
+        Text("Artist: \(args["artistId"])")
+        Text("Song: \(args["songId"])")
+    }
+}
+```
+
+## Navigator
+A way to navigate without using Views:
+```swift
+Navigator.back()
+Navigator.navigateTo(["artists", "5"])
+Navigator.navigateTo("/artists/5")
+```
+
+## RouterLink
+A button that navigates to the specified path
+```swift
+RouterLink(to: "/artists") {
+    Text("Back")
+}
+```

Sources/Router/Navigator.swift

@@ -6,6 +6,7 @@
 //
 import JavaScriptKit
 
+/// A way to navigate without using Views
 public struct Navigator {
     public static func back() {
         _ = JSObjectRef.global.history.object?.back?()

Sources/Router/Route.swift

@@ -7,6 +7,8 @@
 import SwiftWebUI
 import JavaScriptKit
 
+/// A map from a path to a View
+/// Path can contains arguments, such as `/artists/:artistId/song/:songId`
 public struct Route : View {
     let path: [String]
     let content: AnyView

Sources/Router/Router.swift

@@ -8,6 +8,8 @@
 import SwiftWebUI
 import JavaScriptKit
 
+/// A container for `Route`s.
+/// Uses `location.pathname` to resolve which `Route` to render
 public struct Router : View {
     let path: [String]
     let routes: [Route]

Sources/Router/RouterLink.swift

@@ -7,6 +7,7 @@
 
 import SwiftWebUI
 
+/// A button that navigates to the specified path
 public struct RouterLink<Content: View>: View {
     let destination: String
     let content: Content