{"id":19921245,"url":"https://github.com/lukasandreano/capacitor-quick-actions","last_synced_at":"2025-10-07T03:24:15.804Z","repository":{"id":244225893,"uuid":"814694193","full_name":"LukasAndreano/capacitor-quick-actions","owner":"LukasAndreano","description":"A Capacitor plugin that allows you to use the Quick Actions API on iOS/iPadOS","archived":false,"fork":false,"pushed_at":"2024-06-14T21:12:19.000Z","size":2016,"stargazers_count":9,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-21T10:44:21.895Z","etag":null,"topics":["capacitor","ios","quick-actions","quickactions"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/capacitor-quick-actions","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LukasAndreano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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}},"created_at":"2024-06-13T14:07:17.000Z","updated_at":"2025-03-05T01:27:41.000Z","dependencies_parsed_at":"2024-06-13T14:24:13.343Z","dependency_job_id":"05487ed6-050e-4056-9aef-8ca3c483c51e","html_url":"https://github.com/LukasAndreano/capacitor-quick-actions","commit_stats":null,"previous_names":["lukasandreano/capacitor-quick-actions"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LukasAndreano/capacitor-quick-actions","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-quick-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-quick-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-quick-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-quick-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LukasAndreano","download_url":"https://codeload.github.com/LukasAndreano/capacitor-quick-actions/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-quick-actions/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278714063,"owners_count":26033011,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"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":["capacitor","ios","quick-actions","quickactions"],"created_at":"2024-11-12T22:07:06.705Z","updated_at":"2025-10-07T03:24:15.789Z","avatar_url":"https://github.com/LukasAndreano.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Capacitor Quick Actions\n\nPlugin for using [Quick Actions](https://developer.apple.com/documentation/uikit/menus_and_shortcuts/add_home_screen_quick_actions#3701696) in your Capacitor Apps.  \nNow it supports only on iOS/iPadOS 13+.\n\n![](https://github.com/lukasandreano/capacitor-quick-actions/blob/main/docs/preview.png?raw=true)\n\n## Install\n\n```bash\nnpm install capacitor-quick-actions\nnpx cap sync\n```\n\n## Preparation\nModify your `AppDelegate.swift`:\n1. Add `import CapacitorQuickActions` to the top of the file.\n2. Add `application function` to the bottom of the file:\n```swift\nfunc application(_ application: UIApplication, performActionFor shortcutItem: UIApplicationShortcutItem, completionHandler: @escaping (Bool) -\u003e Void) {\n        let handled = QuickActions.handleQuickAction(shortcutItem)\n        completionHandler(handled)\n}\n```\nExample of the `AppDelegate.swift` file available [here](https://github.com/lukasandreano/capacitor-quick-actions/blob/main/docs/AppDelegate.swift). \n\n## Usage\n```typescript\n// Import the plugin\nimport { QuickActions } from 'capacitor-quick-actions';\n\n// Add buttons to the home screen\nconst addButtonsToHomeScreen = async () =\u003e {\n    await QuickActions.addQuickActions({\n        actions: [\n            { id: \"button1\", title: 'Action1', iconName: 'house', description: 'Description1' },\n            { id: \"button2\", title: 'Action2', iconName: '2' } // Description is optional\n        ]\n    });\n}\n\n// Remove buttons from the home screen\nconst clearButtonsFromHomeScreen = async () =\u003e {\n    await QuickActions.clearQuickActions();\n}\n\n// Add Listener for the selected action\nQuickActions.addListener('quickActionSelected', (data) =\u003e {\n    console.log('Quick Action selected:', data.type); // returns id of the selected action\n});\n```\n\n## Icons\nTo use icons in your quick actions provide the name of the icon from [this app](https://developer.apple.com/sf-symbols/).\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`addQuickActions(...)`](#addquickactions)\n* [`clearQuickActions()`](#clearquickactions)\n* [`addListener('quickActionSelected', ...)`](#addlistenerquickactionselected-)\n* [Interfaces](#interfaces)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### addQuickActions(...)\n\n```typescript\naddQuickActions(options: { actions: QuickAction[]; }) =\u003e Promise\u003cvoid\u003e\n```\n\n| Param         | Type                                     |\n| ------------- | ---------------------------------------- |\n| **`options`** | \u003ccode\u003e{ actions: QuickAction[]; }\u003c/code\u003e |\n\n--------------------\n\n\n### clearQuickActions()\n\n```typescript\nclearQuickActions() =\u003e Promise\u003cvoid\u003e\n```\n\n--------------------\n\n\n### addListener('quickActionSelected', ...)\n\n```typescript\naddListener(eventName: 'quickActionSelected', listenerFunc: (data: { type: string; }) =\u003e void) =\u003e PluginListenerHandle\n```\n\n| Param              | Type                                              |\n| ------------------ | ------------------------------------------------- |\n| **`eventName`**    | \u003ccode\u003e'quickActionSelected'\u003c/code\u003e                |\n| **`listenerFunc`** | \u003ccode\u003e(data: { type: string; }) =\u0026gt; void\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003e\u003ca href=\"#pluginlistenerhandle\"\u003ePluginListenerHandle\u003c/a\u003e\u003c/code\u003e\n\n--------------------\n\n\n### Interfaces\n\n\n#### QuickAction\n\n| Prop              | Type                |\n| ----------------- | ------------------- |\n| **`id`**          | \u003ccode\u003estring\u003c/code\u003e |\n| **`title`**       | \u003ccode\u003estring\u003c/code\u003e |\n| **`iconName`**    | \u003ccode\u003estring\u003c/code\u003e |\n| **`description`** | \u003ccode\u003estring\u003c/code\u003e |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | \u003ccode\u003e() =\u0026gt; Promise\u0026lt;void\u0026gt;\u003c/code\u003e |\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukasandreano%2Fcapacitor-quick-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukasandreano%2Fcapacitor-quick-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukasandreano%2Fcapacitor-quick-actions/lists"}