Skip to content
OpenNook
GitHub

API reference

The full API reference for OpenNook is generated by Swift Package Index from the package’s DocC comments. Once the package is registered and a tagged release is indexed, the reference will live at:

https://swiftpackageindex.com/glendonC/opennook/documentation

Until then, the source is the reference. Start with:

  • Sources/NookApp/NookApp.swift - the NookApp.main entry points.
  • Sources/NookKit/App/AppCoordinator.swift - the lifecycle vocabulary (showNook, hideNook, toggleNook, toggleKeepNookOpen).
  • Sources/NookKit/App/NookConfiguration.swift - every customization hook.
  • Sources/NookKit/App/NookHostConfiguration.swift - multi-module hosting.
  • Sources/NookComponents/ - Shelf, Activities, Volume.