1.1.2 • Published 3 years ago
standard_10 v1.1.2
This package is built with JavaScript and nothing else. There are zero direct dependencies, as dependencies are unreliable and subject to change without warning. While there are no direct dependencies, it does require node to run via http-server (installed globally).
Standard_10 provides a JavaScript module which will 'type' text across the screen with various properties to set the exact manner in which the characters/words appear. Read further for instance and usage instructions ->
SIMPLE USAGE
mkdir Standard_10 && cd Standard_10 && touch index.mjs && touch index.html- Standard_10
- index.mjs
- index.html
- styles.css (optional)
- Standard_10
npm init- /Standard_10
- / contents /
- package.json
- /Standard_10
- add "type":"module" to package.json
- modify the npm scripts to launch as a server (i.e. http-server or light-server)
"start":"light-server -s ."
npm install standard_10- Ready to type!!! Open your favorite text editor (its ok if its Vim... kind of) and past the code below into it.
INDEX.HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="styles.css">
<title>Standard_10</title>
</head>
<body>
<div class="title" id="root">
Standard_10
</div>
<script type="module" src="index.js"></script>
</body>
</html>INDEX.MJS
import Standard_10 from 'standard-10';
// DOM field initialization (skip if already exists)
let root = document.createElement('div');
root.setAttribute('id', 'root');
document.body.append(root);
let el = document.createElement('div');
el.classList.add('standard_10');
const parentElement = document.getElementById('root');
parentElement.appendChild(el);
const element = document.getElementsByClassName('standard_10');
// add initial styles (if applicable)
// let link = document.createElement('link');
// link.type = 'text/css';
// link.rel = 'stylesheet';
// link.href = './styles.css';
// document.head.append(link);
// target element (pass to instance constructor)
const element = document.getElementsByClassName('standard_10');
// options (pass to instance constructor)
let options = {};
// instance constructor
let s10 = new Standard_10(element[0], options);
// methods
s10.add(/* input goes here */)
s10.parseText();
s10.startAnimation();STYLES.CSS (optional)
body {
padding: 0;
margin: 0;
}
.title {
height: 100vh;
width: 100vw;
display: flex;
flex-flow: column wrap;
justify-content: center;
align-items: center;
background-color: black;
color: white;
}REQUIRED FUNCTIONS
| Type | Signature | Param restrictions |
|---|---|---|
| constructor | const s10 = new Standard_10(target, options) | target (HTML element) -> must be an existing DOM element with a valid id parameter. options (Object) -> see initial vs. advanced options objects below. |
| process data | s10.parseText() | no parameters. this function must be called AFTER all the endemic functions, directly before startAnimation(). |
| start animation | s10.startAnimation() | no parameters. this must be called DIRECTLY AFTER parseText(), activates animation loop. More endemic function may be called after this. |
ENDEMIC FUNCTIONS
| Signature | Param restrictions |
|---|---|
| s10.add(S) | S must be of type string, 0 < S.length < 250, all lowercase (for now, update coming v1.3) |
| s10.addBackspace(N) | N must be of type number, 0 < N < s10.chars.length(), equal to number of characters to delete |
| s10.addPause(N) | N must be of type number, 0 < N < Integer.MAX_VALUE, equal to pause length in milliseconds |
OPTIONS OBJECT
| Parameter | Description |
|---|---|
| cursorChar | Sets cursor character value. Accepts a single value of type string. Defaults to pipe character. |
| cursorBlink | Sets cursor blink speed in milliseconds. Accepts an integer of type number. Defaults to 500 |
| typeSpeed | Accepts 'standard' ('linear', 'randomn' and 'chaotic' coming v2). Modifies the speed at which the characters appear on the screen. |
| deleteSpeed | Accepts 'standard' ('speedUp' and 'choppy' coming v2). Modifies the speed at which the characters appear on the screen. |
| styles | Accepts an object of style parameters for each of the following DOM components: domField, node and cursor. All styles must use the following naming convention: for the keys, replace hyphens in the standard css name with underscores, and the values should be strings that match the standard css attribute. See example below for example options object. ANY CSS PROPERRTY CAN BE USED FOLLOWING THESE CONVENTIONS. |
/** INITIAL OPTIONS
*/
options = {
content: null,
cursorChar: '|',
cursorBlink: 500,
typeSpeed: 'standard',
deleteSpeed: 'standard',
styles: {}
} /** EXAMPLE OPTIONS OBJECT TO PASS TO CONSTRUCTOR
*/
const options = {
options: 'options',
cursorChar: '|',
cursorBlink: 500,
cursorTimeout: 15000,
styles: {
// container element (<div>)
domField: {
width: '75vw',
margin: '0 auto',
position: 'relative',
padding: '.5em .5em',
font_variant: 'small-caps',
},
// text elements (<span>)
node: {
color: Math.random() > .5 ? 'chartreuse' : 'goldenrod',
transition: 'all 1s',
},
// cursor element (<span>)
cursor: {
padding: '10px 5px 0 5px',
margin: 0,
position: 'fixed',
display: 'inline-block',
overflow: 'hidden',
transition: 'all .25s'
}
}
}Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the UnLicense. See LICENSE for more information.