{"id":2574,"url":"https://github.com/chriszielinski/Ribbon","last_synced_at":"2025-08-06T13:32:54.631Z","repository":{"id":59203845,"uuid":"201116970","full_name":"chriszielinski/Ribbon","owner":"chriszielinski","description":"🎀 A simple cross-platform toolbar/custom input accessory view library for iOS \u0026 macOS.","archived":false,"fork":false,"pushed_at":"2021-09-10T05:54:49.000Z","size":3926,"stargazers_count":295,"open_issues_count":0,"forks_count":23,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-02T00:02:59.142Z","etag":null,"topics":["carthage","cocoapods","cross-platform","custom-input-accessory-view","dark-mode","ios","macos","nstoolbar","ribbon","swift","toolbar"],"latest_commit_sha":null,"homepage":"","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/chriszielinski.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}},"created_at":"2019-08-07T19:43:10.000Z","updated_at":"2024-09-23T01:02:43.000Z","dependencies_parsed_at":"2022-09-13T04:24:49.857Z","dependency_job_id":null,"html_url":"https://github.com/chriszielinski/Ribbon","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriszielinski%2FRibbon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriszielinski%2FRibbon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriszielinski%2FRibbon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chriszielinski%2FRibbon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chriszielinski","download_url":"https://codeload.github.com/chriszielinski/Ribbon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228905506,"owners_count":17989778,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["carthage","cocoapods","cross-platform","custom-input-accessory-view","dark-mode","ios","macos","nstoolbar","ribbon","swift","toolbar"],"created_at":"2024-01-05T20:16:17.289Z","updated_at":"2024-12-09T14:31:03.733Z","avatar_url":"https://github.com/chriszielinski.png","language":"Swift","funding_links":[],"categories":["UI","Libs","UI and SwiftUI","Keyboard [🔝](#readme)"],"sub_categories":["Keyboard"],"readme":"Ribbon 🎀\n========\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"Supported Platforms\" src =\"https://img.shields.io/badge/platform-iOS%20%7C%20macOS-informational\"/\u003e\n    \u003ca href=\"https://github.com/Carthage/Carthage\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n        \u003cimg alt=\"Carthage compatible\" src =\"https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://cocoapods.org/pods/Ribbon\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n        \u003cimg alt=\"Pod Version\" src =\"https://img.shields.io/cocoapods/v/Ribbon.svg?style=flat\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://travis-ci.org/chriszielinski/Ribbon\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n\t\t\u003cimg src=\"https://travis-ci.org/chriszielinski/Ribbon.svg?branch=master\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://sonarcloud.io/dashboard?id=chriszielinski_Ribbon\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n\t\t\u003cimg src=\"https://sonarcloud.io/api/project_badges/measure?project=chriszielinski_Ribbon\u0026metric=alert_status\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://sonarcloud.io/component_measures?id=chriszielinski_Ribbon\u0026metric=Coverage\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n\t  \u003cimg src=\"https://sonarcloud.io/api/project_badges/measure?project=chriszielinski_Ribbon\u0026metric=coverage\"\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://codebeat.co/projects/github-com-chriszielinski-ribbon-master\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n\t   \u003cimg alt=\"codebeat badge\" src=\"https://codebeat.co/badges/8fa0b6cf-73e1-425a-a196-8b62197cfa40\"/\u003e\n   \u003c/a\u003e\n\t\u003ca href=\"https://developer.apple.com/swift\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n\t\t\u003cimg alt=\"Swift Version\" src =\"https://img.shields.io/badge/language-Swift%205-blue.svg\"/\u003e\n\t\u003c/a\u003e\n\t\u003ca href=\"https://github.com/chriszielinski/Ribbon/blob/master/LICENSE\" style=\"text-decoration:none\" target=\"_blank\"\u003e\n\t\t\u003cimg alt=\"GitHub license\" src =\"https://img.shields.io/badge/license-MIT-blue.svg\"/\u003e\n\t\u003c/a\u003e\n    \u003cimg alt=\"PRs Welcome\" src=\"https://img.shields.io/badge/PRs-welcome-blue.svg\" /\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/chriszielinski/Ribbon/master/.readme-assets/header.jpg\" alt=\"Header\"\u003e\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003cb\u003eA simple cross-platform toolbar/custom input accessory view library for iOS \u0026 macOS.\n    \u003cbr\u003e\n    Written in Swift.\u003c/b\u003e\n    \u003cbr\u003e\n\u003c/p\u003e\n\n---\n\n### Looking for...\n\n- A type-safe, XPC-available [SourceKitten](https://github.com/jpsim/SourceKitten) (SourceKit) interface with some sugar? Check out [Sylvester](https://github.com/chriszielinski/Sylvester) 😼.\n- A Floating Action Button for macOS? Check out [Fab.](https://github.com/chriszielinski/Fab) 🛍️.\n- An Expanding Bubble Text Field for macOS? Check out [BubbleTextField](https://github.com/chriszielinski/BubbleTextField) 💬.\n- An integrated spotlight-based onboarding and help library for macOS? Check out [Enlighten](https://github.com/chriszielinski/Enlighten) 💡.\n\n---\n\nFeatures\n========\n\n\u003e 🎡 **Try:** Includes an iOS \u0026 macOS demo.\n\n- Provide items either programmatically or from a JSON configuration file.\n- Dark mode.\n- \\+ more!\n\n#### iOS\n\n- Supports push buttons—a segmented item's subitems become push buttons. \n- iOS 13: [action] items use the new [context menu interaction](https://developer.apple.com/design/human-interface-guidelines/ios/controls/context-menus/):\n\n   \u003e **Note:** Due to an internal assertion, the keyboard can no longer remain visible during the interaction.\n\n   \u003cimg src=\"https://raw.githubusercontent.com/chriszielinski/Ribbon/master/.readme-assets/ios13.gif\" height=\"450\" alt=\"iOS 13 Context Menu Interaction\"\u003e\n\n#### macOS\n\n- Supports push, [action], \u0026 segmented control toolbar items.\n- Provides `NSMenuItem`s for each item.\n\n\n[action]:\n   https://developer.apple.com/design/human-interface-guidelines/macos/buttons/pull-down-buttons#action-buttons\n\n\nRequirements\n============\n\n- iOS 10.0+ (12.0+ for dark mode)\n- macOS 10.12+ (10.13+ for full functionality)\n\n\nInstallation\n============\n`Ribbon` is available for installation using Carthage or CocoaPods.\n\n[Carthage](https://github.com/Carthage/Carthage)\n------------------------------------------------\n\n```ruby\ngithub \"chriszielinski/Ribbon\"\n```\n\n[CocoaPods](http://cocoapods.org/)\n----------------------------------\n\n```ruby\npod \"Ribbon\"\n```\n\n\nUsage\n=====\n\nThere are two ways of integrating `Ribbon` into your project:\n\n\nConfiguration File\n------------------\n\n\u003e 🔥 The recommended approach.\n\nThe configuration file makes for a quick \u0026 easy integration. The default configuration filename is `ribbon-configuration.json` and should be copied into the target's bundle resources (in the _Copy Bundle Resources_ build phase).\n\nThe JSON below defines a single action item and toolbar configuration—which is only relevant for the macOS platform.\n\n\u003e 🧐 **See:** [_Demos/Shared/ribbon-configuration.json_](https://github.com/chriszielinski/Ribbon/blob/master/Demos/Shared/ribbon-configuration.json) for a more comprehensive example.\n\n```json\n{\n    \"items\": [\n        {\n            \"action\": \"actionItemHandler\",\n            \"controlKind\": \"action\",\n            \"identifier\": \"action-item-identifier\",\n            \"imageName\": \"NSActionTemplate\",\n            \"keyEquivalent\": \"a\",\n            \"keyEquivalentModifier\": [\"command\", \"shift\"],\n            \"title\": \"Action Item\",\n            \"toolTip\": \"The action button's tool-tip.\",\n            \"subitems\": [\n                {\n                    \"action\": \"firstActionSubitemHandler\",\n                    \"identifier\": \"first-action-subitem\",\n                    \"imageName\": \"hand.thumbsup\",\n                    \"keyEquivalent\": \"1\",\n                    \"keyEquivalentModifier\": [\"command\"],\n                    \"title\": \"First Action Subitem\",\n                    \"toolTip\": \"The first action's tool-tip.\"\n                },\n                {\n                    \"action\": \"secondActionSubitemHandler\",\n                    \"identifier\": \"second-action-subitem\",\n                    \"imageName\": \"hand.thumbsdown\",\n                    \"keyEquivalent\": \"2\",\n                    \"keyEquivalentModifier\": [\"command\"],\n                    \"title\": \"Second Action Subitem\",\n                    \"toolTip\": \"The second action's tool-tip.\"\n                }\n            ]\n        }\n    ],\n    \"toolbar\": {\n        \"displayMode\": \"iconOnly\",\n        \"sizeMode\": \"regular\",\n        \"identifier\": \"toolbar-identifier\",\n        \"defaultItems\" : [\"NSToolbarFlexibleSpaceItem\", \"action-item-identifier\"]\n    }\n}\n```\n\nIntegration into your view controller is as simple as:\n\n\u003e 📌 **Note:** The code below is an abstraction and **will not** compile.\n\n```swift\nimport Ribbon\n\nclass YourViewController ... {\n\n    ...\n    \n    var ribbon: Ribbon!\n\n    override func viewDidLoad() {\n        ribbon = try! Ribbon.loadFromMainBundle(target: self)\n\n        #if canImport(UIKit)\n        textView.inputAccessoryView = ribbon\n        #endif\n    }\n    \n    #if canImport(AppKit)\n    override func viewWillAppear() {\n        view.window?.toolbar = ribbon.toolbar\n\n        super.viewWillAppear()\n    }\n    #endif\n    \n    @objc\n    func actionItemHandler() { }\n\n    @objc\n    func firstActionSubitemHandler() { }\n\n    @objc\n    func secondActionSubitemHandler() { }\n\n}\n```\n\n\nProgrammatically\n----------------\n\n\u003e 📌 **Note:** The code below is an abstraction and **will not** compile.\n\n```swift\nimport Ribbon\n\nclass YourViewController ... {\n\n    ...\n    \n    var ribbon: Ribbon!\n\n    override func viewDidLoad() {\n        let firstActionSubitem = RibbonItem(subItemTitle: \"First Action Subitem\")\n        firstActionSubitem.action = #selector(firstActionSubitemHandler)\n        let secondActionSubitem = RibbonItem(subItemTitle: \"Second Action Subitem\")\n        secondActionSubitem.action = #selector(secondActionSubitemHandler)\n\n        let actionItem = RibbonItem(controlKind: .action,\n                                    title: \"Action Item\",\n                                    subitems: [firstActionSubitem, secondActionSubitem])\n        actionItem.action = #selector(actionItemHandler)\n        ribbon = Ribbon(items: [actionItem], target: self)\n\n        #if canImport(UIKit)\n        textView.inputAccessoryView = ribbon\n        #endif\n    }\n    \n    #if canImport(AppKit)\n    override func viewWillAppear() {\n        view.window?.toolbar = ribbon.toolbar\n\n        super.viewWillAppear()\n    }\n    #endif\n    \n    @objc\n    func actionItemHandler() { }\n\n    @objc\n    func firstActionSubitemHandler() { }\n\n    @objc\n    func secondActionSubitemHandler() { }\n\n}\n```\n\n\n// ToDo:\n========\n\n- [ ] Add documentation.\n- [ ] Implement `UIKeyCommand`.\n\n\nCommunity\n=========\n\n- Found a bug? Open an [issue](https://github.com/chriszielinski/ribbon/issues).\n- Feature idea? ~~Open an [issue](https://github.com/chriszielinski/ribbon/issues).~~ Do it yourself \u0026 PR when done 😅 (or you can open an issue 🙄).\n- Want to contribute? Submit a [pull request](https://github.com/chriszielinski/ribbon/pulls).\n\n\nAcknowledgements\n================\n\n* Based on Rudd Fawcett's [`RFKeyboardToolbar`](https://github.com/ruddfawcett/RFKeyboardToolbar).\n\n\nContributors\n============\n\n- [Chris Zielinski](https://github.com/chriszielinski) — Original author.\n\n\nFrameworks \u0026 Libraries\n======================\n\n`Ribbon` depends on the wonderful contributions of the Swift community, namely:\n\n* **[realm/SwiftLint](https://github.com/realm/SwiftLint)** — A tool to enforce Swift style and conventions.\n\n\nLicense\n=======\n\n`Ribbon` is available under the MIT license, see the [LICENSE](https://github.com/chriszielinski/ribbon/blob/master/LICENSE) file for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriszielinski%2FRibbon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchriszielinski%2FRibbon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchriszielinski%2FRibbon/lists"}