Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webmatze/hyperborder
adds a gradient border to the Hyper terminal
https://github.com/webmatze/hyperborder
animation extension gradient-border hyper hyperterm
Last synced: about 1 month ago
JSON representation
adds a gradient border to the Hyper terminal
- Host: GitHub
- URL: https://github.com/webmatze/hyperborder
- Owner: webmatze
- Created: 2016-07-17T16:31:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T18:56:38.000Z (about 1 year ago)
- Last Synced: 2024-10-29T20:59:49.177Z (about 1 month ago)
- Topics: animation, extension, gradient-border, hyper, hyperterm
- Language: JavaScript
- Homepage:
- Size: 526 KB
- Stars: 247
- Watchers: 2
- Forks: 29
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-gradient - hyperborder - Adds a gradient border to the Hyper terminal. (JavaScript)
README
# hyperborder - extension for Hyper
adds a gradient border to the `Hyper` terminal
## Installation
add it to plugins in your `~/.hyper.js` configuration
````
module.exports = {
...
plugins: ['hyperborder']
...
}
````
then just restart `Hyper` app or go to the menu 'Plugins / Update All Now'
## Configuration
The following settings can be configured by adding a `hyperBorder` section in your `.hyper.js` `config` section:
| Setting | Type | Description |
|----------------------|----------------------|--------------------------------------------------------|
| `borderWidth` | `string` | CSS string for how thick the borders should be |
| `borderRadiusInner` | `string` | CSS string for round inner corners |
| `borderRadiusOuter` | `string` | CSS string for round outer corners |
| `borderColors` | `string`, `string[]` | The color(s) for the border |
| `adminBorderColors` | `string`, `string[]` | The color(s) for the border for an admin/elevated window. This follows the precedence of `adminBorderColors` > `borderColors` > defaultColors |
| `blurredColors` | `string`, `string[]` | The color(s) of the borders when the window isn't active |
| `blurredAdminColors` | `string`, `string[]` | The color(s) of the borders when the admin/elevated window isn't active. This follows the precedence of `blurredAdminColors` > `blurredColors` > `adminBorderColors` > `borderColors` > defaultColors |
## A note on admin/root colors
The use of Hyper under the admin/root account is mainly intended for Windows' users (where it is common to run an application in
elevated mode), since on Linux/OSX you would typically utilize the `sudo ` command. _Technically_ you can run Hyper as root
on non-Windows machines (there are issues running Hyper as root under a [Wayland](https://wayland.freedesktop.org/) desktop), though
in this case, the root user will actually have their own copy of `.hyper.js` configuration.
### EXAMPLE: Set Border Colors And Width
```javascript
module.exports = {
config: {
...
hyperBorder: {
borderColors: ['#fc1da7', '#fba506'],
borderWidth: '8px'
}
...
}
}
```
### EXAMPLE: Set Border Colors To Random Colors
In addition, you can set any color value to `'random'` (string value):
```javascript
module.exports = {
config: {
...
hyperBorder: {
borderColors: ['random','random'],
borderWidth: '8px'
}
...
}
}
```
Then every newly opened `Hyper` terminal window will have a different colored border.
### EXAMPLE: Animate Border Colors
You like some animations? Then try this:
```javascript
module.exports = {
config: {
...
hyperBorder: {
animate: true,
...
}
...
}
}
```
To change the speed of animation, specify an object with a `duration` property in milliseconds:
```javascript
module.exports = {
config: {
...
hyperBorder: {
animate: {
duration: '1000', // default is 18000
},
...
}
...
}
}
```
### EXAMPLE: Angled Gradients
Because we use CSS3's `linear-gradient`, we're able to specify angles at which to create the radius. Set your own angle like this:
```javascript
module.exports = {
config: {
...
hyperBorder: {
borderAngle: '180deg',
...
}
...
}
}
```
## Download Hyper here
https://hyper.is/