{"id":17137190,"url":"https://github.com/squeek502/lua-taskbarflash","last_synced_at":"2026-05-09T17:40:15.596Z","repository":{"id":77411206,"uuid":"114869837","full_name":"squeek502/lua-taskbarflash","owner":"squeek502","description":"Lua module for Windows that can flash the taskbar icon and/or window of the current console","archived":false,"fork":false,"pushed_at":"2018-04-25T01:51:36.000Z","size":8,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-29T12:32:41.847Z","etag":null,"topics":["lua","taskbar","windows"],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/squeek502.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}},"created_at":"2017-12-20T09:42:11.000Z","updated_at":"2019-11-14T02:34:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"5c3dc387-ad6f-4ef9-a150-95180c786123","html_url":"https://github.com/squeek502/lua-taskbarflash","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/squeek502%2Flua-taskbarflash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squeek502%2Flua-taskbarflash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squeek502%2Flua-taskbarflash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squeek502%2Flua-taskbarflash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/squeek502","download_url":"https://codeload.github.com/squeek502/lua-taskbarflash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245224581,"owners_count":20580367,"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":["lua","taskbar","windows"],"created_at":"2024-10-14T20:06:26.980Z","updated_at":"2026-05-09T17:40:10.572Z","avatar_url":"https://github.com/squeek502.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lua-taskbarflash\n\n[![Build status](https://ci.appveyor.com/api/projects/status/yr6w1wvj16iehd9m?svg=true)](https://ci.appveyor.com/project/squeek502/taskbarflash)\n\nLua module for Windows that can flash the taskbar icon and/or window of the current console.\n\n```lua\nlocal taskbarflash = require('taskbarflash')\n\n-- continuously flash the taskbar icon until the window is focused\ntaskbarflash()\n```\n\n## Building\nTo build taskbarflash, you'll need to install [`cmake`](https://cmake.org), some version of [Visual Studio](https://www.visualstudio.com/), and have a Lua `.lib` file that [can be found by `cmake`](https://cmake.org/cmake/help/v3.0/module/FindLua.html) (preferably built with the same compiler you're using to build this module).\n\n### Using `cmake-gui`\n- Run `cmake-gui`\n- Browse to the taskbarflash directory and also set the build directory (typically just add `/build` to the source directory path)\n- Click *Configure*\n- Select the Generator and hit *Finish*\n- Hit Generate and then Open Project to open the project in Visual Studio\n- Build the project in Visual Studio as normal\n\n### Using `cmake`\nOpen a command line in the `taskbarflash` directory and do the following:\n```sh\nmkdir build\ncd build\ncmake ..\ncmake --build . --config Release\n```\nIf needed, you can specify a [generator](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html) by doing `cmake -G \"Visual Studio 14 2015 Win64\" ..` instead of `cmake ..`\n\n## API Reference\n\n`require('taskbarflash')` returns a callable table containing functions that allow for more precise control.\n\n### `taskbarflash([nflashes = 0, flashrate = 0])`\nFlashes the Lua process' taskbar icon (but not window) `nflashes` times every `flashrate` milliseconds, or until the window is focused. \n\n- When `nflashes` is `0`, it will flash indefinitely until the window is focused.\n- When `flashrate` is `0`, it will use the default cursor blink rate of the system.\n\n**Aliases:** `taskbarflash.tray`, `taskbarflash.taskbar`\n\n### `taskbarflash.window([nflashes = 0, flashrate = 0])`\nFlashes the Lua process' window (but not taskbar icon) `nflashes` times every `flashrate` milliseconds, or until the window is focused.\n\n- When `nflashes` is `0`, it will flash indefinitely until the window is focused.\n- When `flashrate` is `0`, it will use the default cursor blink rate of the system.\n\n**Aliases:** `taskbarflash.caption`\n\n### `taskbarflash.all([nflashes = 0, flashrate = 0])`\nFlashes the Lua process' window **and** taskbar icon `nflashes` times every `flashrate` milliseconds, or until the window is focused.\n\n- When `nflashes` is `0`, it will flash indefinitely until the window is focused.\n- When `flashrate` is `0`, it will use the default cursor blink rate of the system.\n\n### Example usage\n\n```lua\nlocal taskbarflash = require('taskbarflash')\n\ntaskbarflash() -- flash the taskbar icon indefinitely until the window is focused\ntaskbarflash(1) -- flash the taskbar icon once and then stop\ntaskbarflash(5, 100) -- flash the taskbar icon 5 times, once every 100 milliseconds\ntaskbarflash.tray() -- same as taskbarflash()\ntaskbarflash.taskbar() -- same as taskbarflash()\n\ntaskbarflash.window() -- flash the window indefinitely until it is focused\ntaskbarflash.window(5, 100) -- flash the window 5 times, once every 100 milliseconds\ntaskbarflash.caption() -- same as taskbarflash.window()\n\ntaskbarflash.all() -- flash both the window and the taskbar icon indefinitely until the window is focused\ntaskbarflash.all(5, 100) -- flash both the window and the taskbar icon 5 times, once every 100 milliseconds\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqueek502%2Flua-taskbarflash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqueek502%2Flua-taskbarflash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqueek502%2Flua-taskbarflash/lists"}