tinyTypewriter.js/index.html at master · cesarlevel/tinyTypewriter.js · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width" />
    <script src="dist/tinyTypewriter.min.js"></script>
    <link type="text/css" rel="stylesheet" href="styles/style.css">
    <title>tinyTypewriter</title>
  </head>
  <body>
    <div class="wrapper">
      <h1>tiny<span id="typewriter">Typewriter.js</span></h1>
      <p>tinyTypewriter.js is just a small (1kb) piece of vanilla javascript that generates a typewriter effect.</p>
      <h2>How to use</h2>
      <h4>CDN</h4>
      <pre>
&lt;head&gt;
  &lt;script src="https://unpkg.com/browse/tiny-typewriter@latest/dist/tinyTypewriter.min.js"&gt;&lt;/script&gt;
&lt;/head&gt;
...
&lt;h1&gt;tiny&lt;span id="typewritter"&gt;Your fallback text&lt;/span&gt;&lt;/h1&gt;</pre>
      <br>
      <pre>
const typewritter = document.querySelector("#typewriter");
tinyTypewriter(typewritter, {
  items: ['Size', 'Typewriter.js']
});</pre>
      <h4>NPM</h4>
      <pre>
npm install tiny-typewriter</pre>
        <br>
      <pre>
import tinyTypewriter from 'tiny-typewriter';

const typewritter = document.querySelector("#typewriter");
tinyTypewriter(typewritter, {
  items: ['Size', 'Typewriter.js']
});</pre>
      <br>
      <h2>Options</h2>
      <table>
        <thead>
          <tr>
            <th>Option</th>
            <th>Default</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td><code>items</code></td>
            <td><code>[]</code></td>
          </tr>
          <tr>
            <td><code>typeSpeed</code></td>
            <td><code>500</code></td>
          </tr>
          <tr>
            <td><code>deleteSpeed</code></td>
            <td><code>50</code></td>
          </tr>
          <tr>
            <td><code>delayBetweenItems</code></td>
            <td><code>2000</code></td>
          </tr>
          <tr>
            <td><code>loop</code></td>
            <td><code>true</code></td>
          </tr>
          <tr>
            <td><code>startDelay</code></td>
            <td><code>0</code></td>
          </tr>
          <tr>
            <td><code>startsAtIndex</code></td>
            <td><code>0</code></td>
          </tr>
          <tr>
            <td><code>cursor</code></td>
            <td><code>true</code></td>
          </tr>
          <tr>
            <td><code>cursorChar</code></td>
            <td><code>"|"</code></td>
          </tr>
          <tr>
            <td><code>cursorCharBlinkSpeed</code></td>
            <td><code>500</code></td>
          </tr>
          <tr>
            <td><code>cursorCharBlinkTransitionSpeed</code></td>
            <td><code>0.15</code></td>
          </tr>
          <tr>
            <td><code>startOnView</code></td>
            <td><code>true</code></td>
          </tr>
          <tr>
            <td><code>startOnViewOffset</code></td>
            <td><code>0</code></td>
          </tr>
        </tbody>
      </table>
        <pre>
tinyTypewriter(el, {
  items: ['Size', 'Typewritter.js'],
  typeSpeed: 100,
  deleteSpeed: 50,
  delayBetweenItems: 2000,
  loop: true,
  startDelay: 0,
  startsAtIndex: 0,
  cursor: true,
  cursorChar: "|",
  cursorCharBlinkSpeed: 500,
  cursorCharBlinkTransitionSpeed: 0.15,
  startOnView: true,
  startOnViewOffset: 0,
});</pre>
    <br>
    </div>

  <footer>
    <div class="wrapper">
      Cesar Level
    </div>
  </footer>
  </body>
  <script>
    const typewriter = document.querySelector("#typewriter");
    const year = new Date().getFullYear();
    const footerText = `Cesar Level, ${year}`;
    tinyTypewriter(typewriter, {
      items: ['Size', 'Typewriter.js']
    });
    document.querySelector('footer > .wrapper').innerHTML = footerText;
  </script>
</html>