{"id":13692826,"url":"https://github.com/roose/nim-wox","last_synced_at":"2026-01-21T08:12:57.441Z","repository":{"id":150304499,"uuid":"58263075","full_name":"roose/nim-wox","owner":"roose","description":"Helper library for writing Wox plugins in Nim","archived":false,"fork":false,"pushed_at":"2020-10-15T19:51:38.000Z","size":106,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-12T18:42:13.092Z","etag":null,"topics":["nim-wox","plugin","plugins","wox"],"latest_commit_sha":null,"homepage":"http://roose.github.io/nim-wox/wox.html","language":"Nim","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/roose.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","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}},"created_at":"2016-05-07T11:29:02.000Z","updated_at":"2020-10-15T19:49:11.000Z","dependencies_parsed_at":"2023-04-13T13:03:42.974Z","dependency_job_id":null,"html_url":"https://github.com/roose/nim-wox","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roose%2Fnim-wox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roose%2Fnim-wox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roose%2Fnim-wox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roose%2Fnim-wox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roose","download_url":"https://codeload.github.com/roose/nim-wox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252095457,"owners_count":21693921,"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":["nim-wox","plugin","plugins","wox"],"created_at":"2024-08-02T17:01:02.438Z","updated_at":"2026-01-21T08:12:57.435Z","avatar_url":"https://github.com/roose.png","language":"Nim","funding_links":[],"categories":["Helpers"],"sub_categories":[],"readme":"# nim-wox\n\n![Test nim-wox](https://github.com/roose/nim-wox/workflows/Test%20nim-wox/badge.svg?branch=master)\n\nHelper library for writing [Wox](http://getwox.com/) plugins in [Nim](http://nim-lang.org/)\n\n![demo](images/demo.png)\n\n## Contents\n\n- [nim-wox](#nim-wox)\n  - [Contents](#contents)\n  - [Installation](#installation)\n  - [Usage](#usage)\n  - [Documentation](#documentation)\n  - [Tests](#tests)\n  - [Changelog](#changelog)\n  - [Licensing](#licensing)\n\n## Installation\n\n`nimble install wox`\n\n## Usage\n\n```Nim\nimport browsers, json\nimport wox\n\nproc query(wp: Wox, params: varargs[string]) =\n  # create a global Wox object\n  # add an item to Wox\n  wp.add(\"Github\", # title\n         \"How people build software\", # subtitle\n         \"Images\\\\gh.png\", # icon\n         \"\", # context data, leave blank if you don't need context menu\n         \"openUrl\", # method\n         \"https://github.com/\", # method params\n         false # don't hide\n  )\n  # send output to Wox\n  echo wp.results()\n\nproc openUrl(wp: Wox, params: varargs[string]) =\n  # open url in default browser\n  openDefaultBrowser(params[0])\n\nwhen isMainModule:\n  var wp = newWox(\"http://roose.github.io/nim-wox/wox.html\")\n  # register `query` and `openUrl` for call from Wox\n  wp.register(\"query\", query)\n  wp.register(\"openUrl\", openUrl)\n  # run called proc\n  wp.run()\n```\nContext menu example:\n\n```Nim\nimport browsers, json\nimport wox\n\nproc query(wp: Wox, params: varargs[string]) =\n  # create a global Wox object\n  # add an item to Wox\n  wp.add(\"postcss\", # title\n         \"Tool for transforming style\", # subtitle\n         \"Images\\\\postcss.png\", # icon\n         \"https://www.npmjs.com/package/postcss\", # context data\n         \"openUrl\", # method\n         \"https://github.com/postcss/postcss\", # method params\n         false # don't hide\n  )\n  # send output to Wox\n  echo wp.results()\n\nproc contextmenu(wp: Wox, params: varargs[string]) =\n  # proc for context menu action\n  wp.add(\"Open npm page\", # title\n         \"\", # subtitle, leave blank\n         \"Images\\\\npm.png\", # icon\n         \"\", # context data, leave blank\n         \"openUrl\", # method\n         params[0], # method params, given context data from query method\n         false # don't hide\n  )\n  # send output to Wox\n  echo wp.results()\n\nproc openUrl(wp: Wox, params: varargs[string]) =\n  # open url in default browser\n  openDefaultBrowser(params[0])\n\nwhen isMainModule:\n  # url for help magic action\n  var wp = newWox(\"http://roose.github.io/nim-wox/wox.html\")\n  # register `query` and `openUrl` for call from Wox\n  wp.register(\"query\", query)\n  wp.register(\"openUrl\", openUrl)\n  # register `contextmenu` for call from Wox context menu by pressing Shift+Enter\n  wp.register(\"contextmenu\", contextmenu)\n  # run called proc\n  wp.run()\n```\n**Attention:** `newWox` is generating `info.png` and `delete.png` in the `Images` folder(if they don't exist).\n**Attention #2:** Wox now wrong show icons in context menu, [issue](https://github.com/Wox-launcher/Wox/issues/3223)\n\n## Documentation\n\n[Documentation](http://roose.github.io/nim-wox/wox.html)\n\n## Tests\n\n`nimble tests`\n\n## [Changelog](changelog.md)\n\n## Licensing\n\nThe code and documentation are released under the MIT Licence. See the bundled [LICENSE](https://github.com/roose/nim-wox/blob/master/LICENSE) file for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froose%2Fnim-wox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froose%2Fnim-wox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froose%2Fnim-wox/lists"}