├── COPYRIGHT.md ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── img └── preview.gif ├── main.tmux └── scripts ├── helpers.sh └── status.sh /COPYRIGHT.md: -------------------------------------------------------------------------------- 1 | This project and these files are dual-licensed under [Apache 2.0](LICENSE-APACHE) and [MIT](LICENSE-MIT) terms. 2 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any person obtaining a copy 2 | of this software and associated documentation files (the "Software"), to deal 3 | in the Software without restriction, including without limitation the rights 4 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 5 | copies of the Software, and to permit persons to whom the Software is 6 | furnished to do so, subject to the following conditions: 7 | 8 | The above copyright notice and this permission notice shall be included in all 9 | copies or substantial portions of the Software. 10 | 11 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 12 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 13 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 14 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 15 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 16 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 17 | SOFTWARE. 18 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Tmux Transient Status 2 | ======= 3 | 4 | This tmux [tpm](https://github.com/tmux-plugins/tpm) plugin makes your status bar appear only after the `` key is pressed (and for a small amout of time thereafter). 5 | 6 | Preview 7 | ------- 8 | 9 | ![img/preview.gif](img/preview.gif) 10 | 11 | Installation 12 | ------------ 13 | 14 | You can install this plugin through [tpm](https://github.com/tmux-plugins/tpm): 15 | 1. Install [tpm](https://github.com/tmux-plugins/tpm) (duh) 16 | 2. Add this line to your `tmux.conf`: 17 | ```tmux 18 | set -g @plugin 'thesast/tmux-transient-status' 19 | ``` 20 | 3. Install the plugin with `I`, unless you changed `@tpm-install`, in which case you should use the keybind you set. 21 | 22 | Configuration 23 | ------------- 24 | 25 | This plugins offers two options to be set in your `tmux.conf` with these defaults: 26 | ```tmux 27 | set -g @transient-status-delay '0.5' 28 | set -g @transient-status-stall '2.5' 29 | ``` 30 | The first one controls the amount of seconds the status bar will wait after you press `` before appearing (set to `0` to make it instant). 31 | The second one controls the amount of seconds the status bar will linger for after you are done with your command (set to `0` to disable lingering). 32 | 33 | FAQ 34 | --- 35 | 36 | ### Why does `send-prefix` not work sometimes? 37 | 38 | Make sure to source your `tmux.conf` (and run tpm in it!) after you bind a key to `send-prefix`, as the plugin is *not* hot-reloaded. 39 | 40 | ### Why is my status bar not hiding correctly? 41 | 42 | See the previous answer as it also applies to ``. 43 | This plugin only deals with the primary `` not the secondary one or any other extra ones. 44 | 45 | Other plugins 46 | ------------- 47 | 48 | You might also like these plugins: 49 | 50 | - [tmux-powerline](https://github.com/erikw/tmux-powerline) - A tmux plugin giving you a hackable status bar consisting of dynamic & beautiful looking powerline segments, written purely in bash. 51 | This was shown in [preview](#preview). 52 | 53 | - [tmux-nav-master](https://github.com/TheSast/tmux-nav-master) - Easy cross-navigation between tmux and other terminal applications. 54 | 55 | - [tmux-keylocker](https://github.com/TheSast/tmux-locker) - Lock away your tmux keybinds temporarely. 56 | 57 | 58 | Licence 59 | ------- 60 | 61 | [MIT and Apache 2.0](COPYRIGHT.md) 62 | -------------------------------------------------------------------------------- /img/preview.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TheSast/tmux-transient-status/c3fcd5180999a7afc075d2dd37d37d1b1b82f7e8/img/preview.gif -------------------------------------------------------------------------------- /main.tmux: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | TS_HOME="$(command cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" 4 | 5 | source "$TS_HOME/scripts/helpers.sh" 6 | 7 | TS_PREFIX="$(tmux display-message -p "#{prefix}")" 8 | TS_DELAY="$(tmux_option_or_fallback "@transient-status-delay" "0.5")" 9 | TS_STALL="$(tmux_option_or_fallback "@transient-status-stall" "2.5")" 10 | 11 | case "$TS_PREFIX" in 12 | "" | None | none) 13 | return 1 14 | ;; 15 | *) ;; 16 | esac 17 | 18 | # replace all 'send-prefix' key bindings with 'send-key PREFIX' 19 | tmux list-keys | grep -P 'send-prefix(?! -2)' | sed "s/send-prefix/send $TS_PREFIX/g" | sed 's/^/tmux /' | bash 20 | 21 | # replace the prefix functionality with a script that acts like it 22 | tmux set -g prefix None 23 | tmux bind -n "$TS_PREFIX" run -b "$TS_HOME/scripts/status.sh $TS_PREFIX $TS_DELAY $TS_STALL" 24 | -------------------------------------------------------------------------------- /scripts/helpers.sh: -------------------------------------------------------------------------------- 1 | tmux_option() { 2 | local option_value 3 | option_value="$(tmux show-option -gqv "$1")" 4 | echo "$option_value" 5 | } 6 | 7 | tmux_option_or_fallback() { 8 | local option_value 9 | option_value="$(tmux_option "$1")" 10 | if [ -z "$option_value" ]; then 11 | option_value="$2" 12 | fi 13 | echo "$option_value" 14 | } 15 | -------------------------------------------------------------------------------- /scripts/status.sh: -------------------------------------------------------------------------------- 1 | tmux switch-client -T prefix # act as a leader key 2 | 3 | sleep "$2" # delay before status bar appears 4 | 5 | if [ "$(tmux display-message -p '#{client_prefix}')" -eq 1 ]; then 6 | tmux set status on # only show status bar if needed 7 | fi 8 | 9 | while [ "$(tmux display-message -p '#{client_prefix}')" -eq 1 ] || \ 10 | [ "$(tmux display-message -p '#{pane_in_mode}')" -eq 1 ]; do # wait until the leader key is consumed and the pane is not in a special mode 11 | sleep 0.01 # most systems' sleep has the neccessary precision 12 | done 13 | 14 | sleep "$3" # linger for the amount specified by the user 15 | 16 | if ! [ "$(tmux display-message -p '#{client_prefix}')" -eq 1 ]; then 17 | tmux set status off # hide status if the prefix had not been pressed during the stall 18 | fi 19 | --------------------------------------------------------------------------------