dlc-css-terminal
v0.0.6
Published
A CSS terminal web component
Downloads
10
Readme
CSS Terminal
CSS Terminal is a web component which lets you simulate a terminal printing commands and results in your browser. All the transitions and animations are done with CSS - very few JavaScript was used, only for the web components creation!
You can also easily style your terminal using the advanced ::part()
CSS pseudo-selectors or you may get your desired terminal just using the CSS variables which are available for that purpose!
Importing this component
Script tag
- Put this script
<script src='https://unpkg.com/dlc-css-terminal@latest/dist/dlc-css-terminal/dlc-css-terminal.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
Node Modules
- Run
npm i dlc-css-terminal --save
- Put a script tag similar to this
<script src='node_modules/dlc-css-terminal/dist/dlc-css-terminal.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
In a stencil-starter app
- Run
npm i dlc-css-terminal --save
- Add an import to the npm packages
import dlc-css-terminal;
- Then you can use the element anywhere in your template, JSX, html etc
Using this web component
Once you have imported the web component within your project, you simply use it in yout HTML! Actually, two web components need to be used in order to achieve the desired results: <dlc-cssterminal>
and <dlc-cssterminal-block>
.
An example:
<dlc-cssterminal shell="~ david$">
<dlc-cssterminal-block command="ls">
Desktop Documents Downloads Pictures Videos
</dlc-cssterminal-block>
<dlc-cssterminal-block command="echo $USER" delay="3">
David López Castellote
</dlc-cssterminal-block>
<dlc-cssterminal-block command="pwd" delay="14">
/home/david
</dlc-cssterminal-block>
<dlc-cssterminal-block command="cat package.json" delay="18" words="14">
<pre>
{
"name": "dlc-css-terminal",
"version": "0.0.1",
"description": "Stencil Component Starter",
"main": "dist/index.js",
"scripts": {
"build": "stencil build --docs",
"start": "stencil build --dev --watch --serve",
"test": "stencil test --spec --e2e",
"test.watch": "stencil test --spec --e2e --watchAll"
},
"devDependencies": {
"@stencil/core": "1.0.0-beta.5"
},
"dependencies": {
"@stencil/sass": "^0.2.3",
"@types/jest": "^24.0.13"
}
}
</pre>
</dlc-cssterminal-block>
<dlc-cssterminal-block shell="~ david$" command=" " delay="35"></dlc-cssterminal-block>
</dlc-cssterminal>
As you can see, both the dlc-cssterminal
and dlc-cssterminal-block
are needed in order to successfully build our terminal. Check out the documentation of their properties in the own documentation of each component:
Styling the terminal
Using the advanced ::part()
pseudo-selectors
If you have no idea of what's this, check it out here. In order to style some of the elements of the terminal, these parts have been defined:
<dlc-cssterminal>
terminal
terminal-header
terminal-header-buttons
terminal-header-button-close
terminal-header-button-minimize
terminal-header-button-maximize
terminal-content
Example:
dlc-cssterminal::part(terminal-content) {
background-color: rgb(47,105,198);
}
dlc-cssterminal::part(terminal-header) {
background-color: #323232;
}
dlc-cssterminal::part(terminal-header-buttons) {
right: 0;
}
<dlc-cssterminal-block>
terminal-content-command
terminal-content-result
Example:
dlc-cssterminal-block::part(terminal-content-shell) {
color: black;
}
dlc-cssterminal-block::part(terminal-content-command) {
color: white;
}
dlc-cssterminal-block::part(terminal-content-result) {
color: greenyellow;
}
CSS variables
The following CSS variables are available in order to style the terminal:
No idea of how to use CSS variables? Learn it out!
--dlc-cssterminal-hem
: Specify the font-size in order to calculate widths and heights (default is 10px)--dlc-cssterminal-content-bgcolor
: The terminal's content background color (default is #323232)--dlc-cssterminal-header-bgcolor
: The terminal's header background color (default is #f6f6f6)--dlc-cssterminal-bordercolor
: The terminal's border color (default is #b8b8b8)--dlc-cssterminal-header-button-close-color
: The terminal's header close button color (default is #fc645f)--dlc-cssterminal-header-button-minimize-color
: The terminal's header close button color (default is #fdbe41)--dlc-cssterminal-header-button-maximize-color
: The terminal's header close button color (default is #35cc4b)--dlc-cssterminal-font-family
: The terminal's font family (default is Consolas,monaco,monospace)--dlc-cssterminal-primary-font-color
: The terminal's primary font color, applied on shell and command texts (default is #fff)--dlc-cssterminal-secondary-font-color
: The terminal's secondary font color, applied on result text (default is #bfbdbd)