Git Product home page Git Product logo

hyperterm-overlay's Introduction

HyperTerm Overlay

A complete and customizable solution for a permanent / dropdown / hotkey / overlay window in your Hyper.app, accessible via hotkeys and/or toolbar icon (tray).

Important: Designed for Hyper.app >= 0.7.0

home2

Install

Edit your ~/.hyper.js (Cmd+,) and insert the hyperterm-overlay in your plugins array:

plugins: [
  'hyperterm-overlay'
],

Configuration

Add overlay in your ~/.hyper.js config. The configuration below shows all possibilities with their respective default values.

module.exports = {
  config: {
    // other configs...
    overlay: {
      alwaysOnTop: true,
      animate: true,
      hasShadow: false,
      hideDock: false,
      hideOnBlur: false,
      hotkeys: ['Option+Space'],
      position: 'top',
      primaryDisplay: false,
      resizable: true,
      startAlone: false,
      startup: false,
      size: 0.4,
      tray: true,
      unique: false
    }
  },
  //...
};

alwaysOnTop

  • Value: true or false
  • Default: true
  • Makes Hyperterm Overlay window stay always on top.

animate

  • Value: true or false
  • Default: true
  • Enable animation when show and hide the window.

hasShadow

  • Value: true or false
  • Default: false
  • Controls the default macOS window shadows.

hideOnBlur

  • Value: true or false
  • Default: false
  • Hides the HyperTerm Overlay when it loses focus.

hideDock

  • Value: true or false
  • Default: false
  • Removes the HyperTerm dock icon. It works only when the unique option is activated.

hotkeys

  • Value: array of hotkey strings
  • Default: ['Option+Space']
  • Specify one or more hotkeys to show and hide the HyperTerm Overlay (see: Accelerator)

position

  • Value: 'top', 'bottom', 'left' or 'right'
  • Default: 'top'
  • Choose where HyperTerm Overlay will be positioned: top, bottom, left or right.

primaryDisplay

  • Value: true or false
  • Default: false
  • Show HyperTerm Overlay only on primary display.

resizable

  • Value: true or false
  • Default: true
  • Allow the HyperTerm Overlay be resizable.

resize

size

  • Value: float or number
  • Default: 0.4
  • The size of HyperTerm Overlay when it is showing. The possible values are a number or a float. If is a number, it represents the size um pixels. Else, if is a float, it means the percentage of the screen.

startAlone

  • Value: true or false
  • Default: false
  • Makes HyperTerm Overlay the unique window displayed when started.
  • Other windows started will be default Hyper.app windows.

startup

  • Value: true or false
  • Default: true
  • Open HyperTerm Overlay on Hyper.app startup.

tray

  • Value: true or false
  • Default: true
  • Add icon to the system notification area, for access HyperTerm Overlay.

tray

unique

  • Value: true or false
  • Default: false
  • Makes HyperTerm Overlay the unique window of Hyper.app. Any other window will be removed.

Licence

MIT

hyperterm-overlay's People

Contributors

benchr267 avatar ppot avatar rickgbw avatar sahewat avatar yamalight avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

hyperterm-overlay's Issues

Animation Not Working in Ubuntu

I'm running this in Ubuntu 16.10, when opening or closing the window just pops up like any other window rather than sliding up and down.

Fix left width

Hey! I love this plugin! Amazing work!

I noticed that at the very left side, there is just a few pixels of empty space:

screen shot 2017-08-19 at 6 17 36 pm

Is this something that's fixable? I noticed a few other "visor" plugins have this issue as well.

Thanks!

Sometimes the global shortcut stops.

I can't add many details about it, but sometimes the global shortcut stops and the overlay does not work, so I need close and open Hyperterm to enable it again. A tiny detail is that when this behavior happens, the tray icon disappear.

Hyperterm Version: 0.7.1

Makes a non-interactive box instead of an overlay.

The screenshot explains it - that box is meant to be the overlay but instead I just get that and as you can see the main window still hangs around.
overlay-bug

Ubuntu 16.04 running Unity.
I get this on both my home and work computers.

Win - focus is not switching back to previous application

Hi, in Windows focus is not switching back to previous application after hiding hyper with hyperterm-overlay. No window is focused.

Tried with animation true/false, with vanilla hyper+hyperterm-overlay.
Tested on Windows 7 and Windows 10.
On Linux it works fine.

output to console is squashed if hyperterm's position is set to right (and presumably also left)

Steps to reproduce:

  1. set overlay config to
    overlay: {
    size: 1.0,
    position: 'right'
    }
  2. execute a task that will output text to the console
  3. hide hyperterm whilst the task runs
  4. display hyperterm window

Expected outcome: text should have been output to the console according to the width of the window it is displayed on

Actual outcome: text is confined to a narrow column on the left of the window

Any text that is output whilst the console is not hidden continues to be displayed correctly - it is only an issue for the period of time that the console is hidden

Not sure if this will make any difference but I am running with dual displays and usually display hyperterm overlay on the right hand monitor

Default hotkey doesn't work in Ubuntu

OS: Ubuntu 16.04
hyperterm-overlay: 0.4.0
hyperterm: 1.0.0

Option+Space doesn't work but when I change it to CommandOrControl+Shift+Z it works great! I'm not sure what the issue is. It doesn't seem to be a system wide hotkey.

Terminal doesn't show on linux (Ubuntu 15.10)

I installed this plugin on linux and it doesn't seem to work.

  • When I press the sortcut, an Icon appears in the tray but the terminal itself doesn't appear.
  • Pressing the shortcut again starts a second tray icon

Additionally, the tray icon isn't practical to use. Clicking it shows a menu with one item 'open hyperterm overlay', instead of directly showing the overlay like in your gif.

Hyper as dock icon - clicking it does not trigger hyperterm if already running in menubar. [macOS]

It would be nice to have it trigger overlay when I click the dock icon (not menubar). I know that I can press the menu bar or the hotkey, but this functionality could be useful for those with a habit to click the dock icon.

My configuration:

overlay: {
      alwaysOnTop: true,
      animate: true,
      hasShadow: true,
      hideDock: false,
      hideOnBlur: true,
      hotkeys: ['Control+Space'],
      position: 'top',
      primaryDisplay: false,
      resizable: true,
      startAlone: true,
      startup: true,
      size: 0.4,
      tray: true,
      unique: false
    }

Window doesn't stay on top

Even with alwaysOnTop set to true in the config, clicking on other windows will bring them to the front and hyper will be covered instead of staying on top as expected.

This is on Ubuntu (17.04 64 bit) with the Gnome X11 desktop environment.

Here is an example of what happens below:
screenshot from 2017-10-26 11-47-00

Closing last window makes it impossible to open a new window

These are my settings:

    overlay: {
      animate: true,
      alwaysOnTop: true,
      hasShadow: true,
      hideOnBlur: true,
      hideDock: true,
      hotkeys: ['Ctrl+`'],
      resizable: true,
      position: 'top',
      primaryDisplay: true,
      startup: true,
      size: 0.4,
      tray: true,
      unique: true
    }

If I ever accidentally close the last window, hitting the hotkey doesn't create a new hotkey window. Because I have hideDock to true, I can't even closer Hyperterm and reopen it to get it back. I need to force quit from the Activity Monitor.

Doesn't install. No package found.

bundle.js:1 No package.json found in /Users/antonionogueras/.hyper_plugins/node_modules/hyperterm-overlay

Using mac. Everything is set correctly as it is shown on the npm page.

Start HyperTerm overlay only.

It would be awesome to have an option to start Hyperterm Overlay only, without forcing the overlay to be the only window.

A possible way this would work :

  • Starting Hyperterm when there is no other window would start the overlay only
  • Starting Hyperterm when the overlay is already running would start hyperterm the normal way.

This would only be if a particular option is set of course.

Creating weird prompt issue when using hotkey or menubar

When initially opening Hyperβ€”other than the fact that the terminal is blank until opening a new tab (this is addressed in another issue but +1 anyway)β€”the prompt appears fine, but sometimes when opening via global hotkey or via the menu bar icon, the bash prompt or any prompt will duplicate itself:

Initial Launch:

Initial

Initial Launch + New Tab:

New Tab

Reopen via Hotkey or Menu Bar Icon:

Hotkey

Animation speed option

This is great to see! But would love to see an option to configure the speed that the overlay hides/shows

Blank terminal window

I get a blank terminal window when I activate this plugin. Not sure if I'm doing something wrong. Hyper 0.8.1 on OS X 10.11. I use fish shell if that makes any difference.

screen shot 2016-10-07 at 11 41 05 am

overlay: {
  unique: true,
  animate: false,
  // hideDock: true,
  startAlone: true,
  startup: true
},

plugins: ['hyperterm-overlay'],

Well slow response and freeze on MacOS

Hi, I'm hyperterm-overlay user and use it fullscreen. Recently, hypeerterm-overlay don't work well whenever it minimize hyper ,also other MacOS machine, same version. Also, hyper freeze at a moment
for a short time. Do you have peeple of the same situation?

  • Mac OS: 10.14.2
  • hyper: canary(latest)

clarification on startalone option

OS: Ubuntu 16.04
hyperterm-overlay: 0.4.0
hyperterm: 1.3.1

How do you start Hyper with just the overlay window (not also a Hyper window created at the same place). The documentation suggested making "startup": true and startAlone: true but still get a Hyper window.

Make the overlay automaticallly restart when it's closed

Before trying out HyperTerm and the overlay plugin, I was a user of Guake terminal. One neat feature is that when the overlay term is closed (for example when typing Ctrl+D), it automatically restarts so that the overlay is always present.

This isn't the case with HyperTerm-overlay and it would be awesome to be able to close the overlay without having to restart hyperterm. (additionally, triggering a full reload of hyperterm doesn't seem to restart an overlay, is this intentional ?)

I'm using Linux and HyperTerm 0.7.1.

Gnome supports

Reading the documentation, I thought that this plugin supports only mac OS but I see also this issue #23 and I don't know anymore…

Do you support Gnome environment ?

Width

Can a width be added? I have a ultra widescreen monitor and I don't need the terminal to be that long.

Opening the overlay also brings normal windows of Hyper to the front

I'm on OSX Sierra. If I have a Hyper terminal open, but underneath another window (like the browser), when I press either the hotkey or the dock button, the normal Hyper window comes to the front of the screen at the same time that the overlay drops down. Pressing the button/hotkey again hides both.
I would think that the intended behavior would be for the overlay hotkeys/buttons to only ever activate/deactivate the overlay terminal, regardless of whether or not other terminals are present.

Too much padding for single tab

There is enough padding on top to have tabs displayed, even when there is only one tab. Screenshots:

Single "tab":
screen shot 2017-01-13 at 21 46 16

Two tabs:
screen shot 2017-01-13 at 21 46 29

Hotkey issue (doesn't work on startup, occasionally forgets an instance is open)

Hi - from a fresh reboot on Windows 10, hitting my hotkey does nothing - until I manually start Hyper for the first time. Is that expected? (Not a biggie, just checking if that is intended or not).

This morning I've come back to my laptop and when I hit the hotkey, an additional Hyper opens at the top of the screen. The original one isn't affected by the hotkey.

Menu not displaying when terminal focused

I have hyperterm overlay installed, and set to hide the dock icon, it works great with the exception of the HyperTerm menu not displaying in my computers menu bar when terminal is in focus.

Typically, without the overlay extension, when I would use HyperTerm it would display a menu in the menu bar with options to reload apps, preferences, help, etc... Now with overlay it does not display when I am working in the terminal. Overlay is the only plugin I have, and here are my configured options -

overlay: {
      animate: true,
      alwaysOnTop: false,
      hasShadow: false,
      hideOnBlur: false,
      hideDock: true,
      hotkeys: ['Option+Space'],
      resizable: true,
      position: 'right',
      primaryDisplay: false,
      startup: true,
      size: .25,
      tray: true,
      unique: true
    }

Thanks so much for the plugin!

More control over size and position

Currently, there are 4 possible positions (top, right, bottom, left) and 1 parameter (size) to control the size of the window.

size is used to control either the width of the window or its height depending on where it's positioned. If the position is top or bottom, it controls the height. If it's left or right, it controls the width. This is done in the function _endBounds


It would be awesome to introduce the positions topLeft, topRight, bottomLeft and bottomRight and the parameters width and height to give much more control over the window's size and position.

Here a few bullet points to explain a bit what I have in mind :

  • With the hyper window is configured to be in one of those new position, the values of width and `height will simply control the width and height of the window. They will both be used.

  • When the hyper windows is configured to be in one of the currently existing positions, either width or height will be ignored depending on which position it is. As an example, when the position top is used, the width configuration value is ignored and the window's width will be set to the maximum.

  • Keeping a retro-compatibility with size can be done. It is just a matter of loading size into either width or height depending on the position and if the value doesn't already exist. Still, with a change like this, size should become deprecated and eventually be deleted.

These few points can be summarized like this :-)

Position height width size
top βœ… πŸ”΄ height = size
topRight βœ… βœ… πŸ”΄
right πŸ”΄ βœ… width = size
bottomRight βœ… βœ… πŸ”΄
bottom βœ… πŸ”΄ height = size
bottomLeft βœ… βœ… πŸ”΄
left πŸ”΄ βœ… width = size
topLeft βœ… βœ… πŸ”΄

A possible evolution would be to enable both width and height for the 4 existing position and consider that the window should be centered with 2 margins. I wouldn't be a big step from what I've just described but I think that it's going a bit too far and it would be possible to add that later.


With this idea, the default configuration would then go from this :

overlay: {
  position: 'top',
  size: 0.4,
},

To either on of the following 3 since they are equivalent :

overlay: {
  position: 'top',
  height: 0.4,
},
overlay: {
  position: 'topLeft',
  height: 0.4,
  width: 1.0,
},
overlay: {
  position: 'topRight',
  height: 0.4,
  width: 1.0,
},

Overlay class for custom CSS

Great job with the plugin β€” I was wondering, is it possible to add a unique class to the overlay window so that we can apply custom CSS? Something to consider.

Unexpected Identifier?

I get the messsage "An error occured in your configuration: Unexpected Identifier" when I copy the config from the ReadMe. Unsure what's going on.

Exiting tab causes remaining (and new) tabs to break.

Closing a tab using the exit command breaks remaining tabs in that input isn't repeated back when typed. Also new tabs don't spawn shells.

Steps to reproduce:

  1. Start hyperterm
  2. Create a new tab
  3. exit
  4. Original tab now longer repeats input back
  5. Newly created tabs don't spawn shells (see picture)

In pic below left tab was before exit, tab on the right was spawned afterwards. Right tab doesn't have a prompt to input commands (only cursor).
screen shot 2017-05-05 at 2 23 27 pm

Hyper.js: v1.3.1
Hyperterm-overlay: v0.4.0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.