{"id":50915102,"url":"https://github.com/jwintz/kelyphos","last_synced_at":"2026-06-16T14:01:55.700Z","repository":{"id":346010593,"uuid":"1185709182","full_name":"jwintz/kelyphos","owner":"jwintz","description":"A cross-platform SwiftUI shell framework for building professional multi-panel applications on macOS and iPadOS.","archived":false,"fork":false,"pushed_at":"2026-04-30T09:45:12.000Z","size":1506,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-02T11:41:47.912Z","etag":null,"topics":["glass","liquid","macos","shell","swift","swiftui"],"latest_commit_sha":null,"homepage":"https://jwintz.github.io/kelyphos/","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwintz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-18T21:40:01.000Z","updated_at":"2026-04-30T09:45:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jwintz/kelyphos","commit_stats":null,"previous_names":["jwintz/kelyphos"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jwintz/kelyphos","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwintz%2Fkelyphos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwintz%2Fkelyphos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwintz%2Fkelyphos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwintz%2Fkelyphos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwintz","download_url":"https://codeload.github.com/jwintz/kelyphos/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwintz%2Fkelyphos/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34408788,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-16T02:00:06.860Z","response_time":126,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["glass","liquid","macos","shell","swift","swiftui"],"created_at":"2026-06-16T14:01:54.887Z","updated_at":"2026-06-16T14:01:55.690Z","avatar_url":"https://github.com/jwintz.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kelyphos\n\nA cross-platform SwiftUI shell framework for building professional multi-panel applications on macOS and iPadOS.\n\n**[Documentation](https://jwintz.github.io/kelyphos)** Provides an IDE-style chrome — navigator sidebar, detail content area, utility panel, and inspector — with a unified API that adapts to each platform's conventions.\n\n## Requirements\n\n- **macOS 26** (Tahoe) / **iPadOS 26** or later\n- **Xcode 26** or later\n- **Swift 6.2**\n\n## Package Structure\n\n| Target             | Type          | Description                                                                        |\n| ------------------ | ------------- | ---------------------------------------------------------------------------------- |\n| `KelyphosKit`      | Library       | Reusable shell framework — panels, navigation, theming, keybindings                |\n| `KelyphosDemo`     | Executable    | HIG component showcase app with 34 interactive demo pages                          |\n| `KelyphosWidget`   | App Extension | Desktop widget (Small / Medium / Large / Extra Large) — built via XcodeGen project |\n| `KelyphosKitTests` | Tests         | Unit tests for KelyphosKit                                                         |\n\n## Quick Start\n\n### Build everything\n\n```bash\nswift build\n```\n\n### Run the demo app\n\n```bash\nswift run KelyphosDemo\n```\n\n### Run tests\n\n```bash\nswift test\n```\n\n\u003e **Note:** When running via `swift run`, the executable has no app bundle identity. Features requiring a bundle identifier (e.g. notifications) will show a warning instead of crashing. Build from Xcode for full functionality.\n\n## Xcode Project (XcodeGen)\n\nWidget extensions cannot be built by SPM alone — they require an Xcode project with proper app extension targets. This project uses [XcodeGen](https://github.com/yonaskolb/XcodeGen) to generate `Kelyphos.xcodeproj` from `project.yml`.\n\nThe generated `.xcodeproj` is gitignored; regenerate it after cloning.\n\n```bash\nswift run --package-path .build/checkouts/XcodeGen xcodegen generate --spec project.yml\nopen Kelyphos.xcodeproj\n```\n\n| Scheme | Description |\n|--------|-------------|\n| `KelyphosDemo` | Host app — builds the demo app with the widget extension embedded |\n| `KelyphosWidget` | Widget extension — builds the widget independently |\n\n---\n\n# Using KelyphosKit\n\n## Minimal App\n\nThree things are needed: a `KelyphosShellState`, a `KelyphosShellConfiguration` with your panel tabs, and the `KelyphosShellView`.\n\n```swift\nimport SwiftUI\nimport KelyphosKit\n\n@main\nstruct MyApp: App {\n    @State private var shellState = KelyphosShellState(persistencePrefix: \"myapp\")\n\n    var body: some Scene {\n        WindowGroup(\"My App\") {\n            KelyphosShellView(\n                state: shellState,\n                configuration: KelyphosShellConfiguration(\n                    navigatorTabs: Array(MyNavigatorTab.allCases),\n                    inspectorTabs: Array(MyInspectorTab.allCases),\n                    utilityTabs: Array(MyUtilityTab.allCases),\n                    detail: { MyDetailView() }\n                )\n            )\n            .onAppear {\n                shellState.title = \"My App\"\n                shellState.subtitle = \"Workspace\"\n            }\n        }\n        .commands {\n            KelyphosCommands(state: shellState)\n        }\n    }\n}\n```\n\n## Defining Panels\n\nEach panel area (navigator, inspector, utility) is populated by an enum conforming to `KelyphosPanel`. This gives you type-safe, tab-switchable panels with SF Symbols icons and built-in keyboard shortcut support.\n\n```swift\nenum MyNavigatorTab: String, KelyphosPanel, CaseIterable {\n    case files, search, bookmarks\n\n    nonisolated var id: String { rawValue }\n\n    nonisolated var title: String {\n        switch self {\n        case .files: \"Files\"\n        case .search: \"Search\"\n        case .bookmarks: \"Bookmarks\"\n        }\n    }\n\n    nonisolated var systemImage: String {\n        switch self {\n        case .files: \"folder\"\n        case .search: \"magnifyingglass\"\n        case .bookmarks: \"bookmark\"\n        }\n    }\n\n    var body: some View {\n        switch self {\n        case .files: FilesNavigatorView()\n        case .search: SearchNavigatorView()\n        case .bookmarks: BookmarksNavigatorView()\n        }\n    }\n}\n```\n\nInspector and utility tabs follow the same pattern:\n\n```swift\nenum MyInspectorTab: String, KelyphosPanel, CaseIterable {\n    case details, properties\n\n    nonisolated var id: String { rawValue }\n    nonisolated var title: String { rawValue.capitalized }\n\n    nonisolated var systemImage: String {\n        switch self {\n        case .details: \"info.circle\"\n        case .properties: \"slider.horizontal.3\"\n        }\n    }\n\n    var body: some View {\n        switch self {\n        case .details: DetailsInspectorView()\n        case .properties: PropertiesInspectorView()\n        }\n    }\n}\n\nenum MyUtilityTab: String, KelyphosPanel, CaseIterable {\n    case output, log\n\n    nonisolated var id: String { rawValue }\n    nonisolated var title: String { rawValue.capitalized }\n\n    nonisolated var systemImage: String {\n        switch self {\n        case .output: \"terminal\"\n        case .log: \"list.bullet.rectangle\"\n        }\n    }\n\n    var body: some View {\n        switch self {\n        case .output: OutputUtilityView()\n        case .log: LogUtilityView()\n        }\n    }\n}\n```\n\n## Shell State\n\n`KelyphosShellState` is the single source of truth for the entire shell. It's an `@Observable` class that drives visibility, appearance, and panel selection across both platforms.\n\n### Title and Subtitle\n\n```swift\nshellState.title = \"Project Name\"\nshellState.subtitle = \"3 files modified\"\n```\n\nOn macOS, these appear in the window toolbar. On iPadOS, the title appears in the navigation bar.\n\n### Panel Visibility\n\n```swift\n// Toggle panels programmatically\nshellState.navigatorVisible.toggle()\nshellState.inspectorVisible.toggle()\nshellState.utilityAreaVisible.toggle()\n\n// Disable panels entirely (removes toggle buttons too)\nshellState.inspectorEnabled = false\nshellState.utilityEnabled = false\n```\n\n### Tab Selection\n\n```swift\n// Select tabs by index (0-based)\nshellState.selectedNavigatorIndex = 1   // Switch to second navigator tab\nshellState.selectedInspectorIndex = 0   // Switch to first inspector tab\n```\n\n### Appearance\n\n```swift\n// Vibrancy material (behind-window blur)\nshellState.vibrancyMaterial = .ultraThin  // .none, .ultraThin, .thin, .regular, .thick, .ultraThick\n\n// Background tint\nshellState.backgroundAlpha = 0.3  // 0.0 (transparent) to 1.0 (opaque)\n\n// System appearance override\nshellState.windowAppearance = \"dark\"  // \"auto\", \"light\", \"dark\"\n```\n\n### Persistence\n\nState is automatically persisted to UserDefaults using the `persistencePrefix` you provide:\n\n```swift\nlet shellState = KelyphosShellState(persistencePrefix: \"myapp.editor\")\n```\n\n## Appearance Presets\n\n```swift\nAppearancePreset.clear.apply(to: shellState)     // Fully transparent + ultraThin material\nAppearancePreset.balanced.apply(to: shellState)   // 50% opacity + thin material\nAppearancePreset.solid.apply(to: shellState)      // Fully opaque, no material\n```\n\n## Color Theme\n\nThe color theme provides semantic colors that adapt to light and dark mode:\n\n```swift\n@Environment(\\.kelyphosShellState) var shellState\n\nvar body: some View {\n    Text(\"Hello\")\n        .foregroundStyle(shellState?.colorTheme.accent ?? .accentColor)\n}\n```\n\nAvailable color slots: `accent`, `accentSecondary`, `foreground`, `foregroundDim`, `background`, `backgroundDim`, `error`, `warning`, `success`, `link`, `border`, `selection`.\n\nCustomize with hex values:\n\n```swift\nshellState.colorTheme.update(variant: \"dark\", from: [\n    \"accent\": \"#8B5CF6\",\n    \"background\": \"#18181B\"\n])\n```\n\n## Keyboard Shortcuts\n\n`KelyphosCommands` provides built-in shortcuts:\n\n| Shortcut | Action |\n|----------|--------|\n| `Cmd+0` | Toggle navigator |\n| `Cmd+1-9` | Select navigator tab |\n| `Cmd+Opt+0` | Toggle inspector |\n| `Cmd+Opt+1-9` | Select inspector tab |\n| `Cmd+Opt+Shift+0` | Toggle utility area |\n| `Cmd+Opt+Shift+1-9` | Select utility tab |\n| `Cmd+Shift+/` | Show keybindings overlay (macOS) |\n| `Cmd+,` | Settings |\n\nRegister custom keybindings for the overlay:\n\n```swift\n@Environment(\\.kelyphosKeybindingRegistry) var registry\n\n.onAppear {\n    registry.register(category: \"Editor\", label: \"Save\", shortcut: \"⌘S\")\n    registry.register(category: \"Editor\", label: \"Find\", shortcut: \"⌘F\")\n}\n```\n\n## Settings View\n\nDrop in a ready-made settings panel:\n\n```swift\nvar body: some Scene {\n    WindowGroup { /* ... */ }\n\n    #if os(macOS)\n    Settings {\n        KelyphosSettingsView(state: shellState)\n    }\n    #endif\n}\n```\n\n## Design Constants\n\n`KelyphosDesign` provides consistent spacing, sizing, and typography:\n\n```swift\nKelyphosDesign.Padding.horizontal      // 12\nKelyphosDesign.Padding.compact         // 8\nKelyphosDesign.Spacing.standard        // 12\nKelyphosDesign.CornerRadius.content    // 14\nKelyphosDesign.Height.tabBar           // 27\nKelyphosDesign.Height.utilityArea      // 260\nKelyphosDesign.FontSize.body           // 11\nKelyphosDesign.IconSize.standard       // 14\nKelyphosDesign.Animation.standard      // 0.25\nKelyphosDesign.Width.sidebarIdeal      // 280\nKelyphosDesign.Width.inspectorIdeal    // 300\n```\n\n## Font Stack\n\nBuilt-in font families with weight support:\n\n```swift\nlet font = KelyphosFontStack.sfMono.font(size: 12, weight: .medium)\n\nKelyphosFontStack.sfPro       // System proportional (9 weights)\nKelyphosFontStack.sfMono      // System monospaced (6 weights)\nKelyphosFontStack.lilex       // Lilex monospaced (6 weights)\nKelyphosFontStack.geistMono   // Geist Mono (8 weights)\nKelyphosFontStack.recursive   // Recursive proportional (7 weights)\n```\n\n## Platform Behavior\n\nKelyphos adapts to each platform while sharing the same API:\n\n| Feature | macOS | iPadOS |\n|---------|-------|--------|\n| Navigator | NavigationSplitView sidebar | NavigationSplitView sidebar with system toggle |\n| Inspector | Native `.inspector()` column | Trailing-edge overlay with vibrancy material |\n| Utility area | Bottom panel with material | Bottom panel with material |\n| Title/subtitle | Window toolbar (inline) | Navigation bar title |\n| Toolbar buttons | `ToolbarSpacer` + `ToolbarItem` | `ToolbarItemGroup(.topBarTrailing)` |\n| Keybindings overlay | `Cmd+Shift+/` (NSEvent) | Not available |\n| Panel font sizing | System default | Capped at `.dynamicTypeSize(.xSmall ... .medium)` |\n| Vibrancy | NSVisualEffectView (behind-window) | SwiftUI `.ultraThinMaterial` |\n\n---\n\n## Demo App\n\nThe showcase presents Apple HIG components organized into 8 sections:\n\n| Section | Items | Examples |\n|---------|-------|---------|\n| Settings | 1 | Panel visibility, keyboard shortcuts |\n| Components | 8 | Buttons, context menus, toolbars, menus |\n| Navigation \u0026 Search | 4 | Path controls, search fields, tab bars, token fields |\n| Presentation | 7 | Alerts, sheets, popovers, scroll views |\n| Selection \u0026 Input | 12 | Font chooser, color wells, pickers, toggles, sliders |\n| Status | 3 | Gauges, progress indicators, rating indicators |\n| Content | 2 | Swift Charts, image views |\n| System Experience | 2 | Notifications, widgets |\n\n### Navigation\n\n- **Tab 1 (Explore)** — Hierarchical list of all sections and items; right-click to bookmark\n- **Tab 2 (Search)** — Full-text search across component titles and sections\n- **Tab 3 (Bookmarks)** — Quick access to bookmarked items\n\n---\n\n## Widget\n\n### Adding the widget to your desktop\n\n1. Build and run **KelyphosDemo** (`Cmd+R`)\n2. Right-click on the macOS desktop -\u003e **Edit Widgets...**\n3. Search for \"Kelyphos\" and drag the desired size:\n   - **Small** — App icon with component count\n   - **Medium** — Sections overview with item counts\n   - **Large** — Full section list with timestamps\n   - **Extra Large** — Featured components grid\n\n### Troubleshooting\n\n| Problem | Solution |\n|---------|----------|\n| Widget doesn't appear in widget gallery | Ensure both targets are signed with the same team and the widget bundle ID is a child of the host app's |\n| Widget shows placeholder only | `killall widgetextensionhost` and re-add |\n| Code changes not reflected | Clean build folder (`Cmd+Shift+K`), rebuild, and re-add |\n\n---\n\n## Architecture\n\n```\nSources/\n  KelyphosKit/          # Reusable shell framework\n    Core/               # ShellState, Panel protocol, Design tokens, environment keys\n    Appearance/         # Vibrancy, themes, color system, presets\n    Shell/              # NavigationSplitView shell, content area, commands, configuration\n    Panels/             # Tab bar, panel containers\n    Font/               # Font stack, font families\n    Keybindings/        # Registry, overlay\n    Settings/           # Appearance settings view\n\n  KelyphosDemo/         # HIG showcase app\n    Model/              # ShowcaseItem, Catalog, State\n    Chrome/             # GlassSection, PageChrome, WelcomePage\n    Navigator/          # Explore, Search, Bookmarks views\n    Inspector/          # Selected item details\n    Pages/              # 34 interactive demo pages\n\n  KelyphosWidget/       # Desktop widget\n```\n\n## License\n\nSee LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwintz%2Fkelyphos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwintz%2Fkelyphos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwintz%2Fkelyphos/lists"}