https://github.com/tautvilas/termpage
Termpage allows you to create neat functional webpages that behave like a terminal
https://github.com/tautvilas/termpage
terminal webpage
Last synced: over 1 year ago
JSON representation
Termpage allows you to create neat functional webpages that behave like a terminal
- Host: GitHub
- URL: https://github.com/tautvilas/termpage
- Owner: tautvilas
- License: mit
- Created: 2019-08-17T15:09:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-26T11:53:26.000Z (over 6 years ago)
- Last Synced: 2025-03-26T21:11:19.530Z (over 1 year ago)
- Topics: terminal, webpage
- Language: JavaScript
- Homepage:
- Size: 117 KB
- Stars: 245
- Watchers: 9
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Termpage 💻
[](https://www.npmjs.com/package/termpage)
Termpage allows you to create neat webpages that behave like a terminal
# Why Termpage?
I wanted to build an effective web interface for my raspberry pi home server without thinking too much about design or ux.
# Example usage
You can see usage demo in the [examples folder](https://tautvilas.github.io/termpage/example/index.html) or let a [cow tell your fortune](http://home.tautvilas.lt/#fortune)
To use termpage include the lib from CDN or install it from npm.
```html
```
```npm install --save termpage```
The easiest way to get started is to drop this code in your index.html and implement your own terminal logic inside command processing function
```html
termpage@home
Termpage.init(document.getElementById('window'), (command) => {
command = command.toLowerCase().trim();
if (command === 'home') {
return "Welcome to termpage";
} else {
return 'Command not found';
}
}, {
initialCommand: 'home'
});
```
# API documentation
### Termpage.init
`Termpage.init(domElement, commandParser, options)`
```javascript
commandParser = (input) => {
return response;
}
```
`input` is user input command string
`response` can be either string or object `{text: responseText, commands: ['menuCommand1', 'menuCommand']}`
Commands array is used to display command suggestion interface bellow command input. This interface can make life easier for people with mobile devices because they can tap on commands instead of typing them.
List of available options:
```javascript
{
prompt: '$',
initialCommand: 'home',
autoFocus: true
},
```
Responses can be returned as **promises** for async commands.
### Termpage.replace, Termpage.link and Termpage.color
`Termpage.replace` together with `Termpage.link` and `Termpage.color` helpers can be used to format terminal output without losing monospace alignment between lines.
This code would format Cell1 as a html link and Cell2 as span with color
```javascript
Termpage.replace(
`
------------------
| Cell1 | Cell2 |
------------------
`, {Cell1: Termpage.link('http://home.tautvilas.lt'), Cell2: termpage.color('red')})
```
# Styling
These default Termpage styles can be freely customized by overriding them with your own css file
```css
.termpage-window {
background-color: black;
border: 2px solid #888;
padding-top: 5px;
}
.termpage-window * {
font-family: "Courier New", Courier, monospace;
font-size: 16px;
color: #ddd;
}
.termpage-input {
background-color: #222;
color: #ddd;
caret-color: white;
}
.termpage-block, .termpage-input {
line-height: 20px;
}
.termpage-block {
padding-left: 5px;
padding-right: 5px;
}
.termpage-window a {
background-color: #888;
text-decoration: none;
cursor:pointer;
}
.termpage-window a:hover {
background-color: #333;
}
.termpage-menu {
background-color: #888;
}
.termpage-menu li:hover {
background-color: #666;
cursor: pointer;
}
```