typed.js 2.0.12 → 2.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/LICENSE.txt +1 -1
  2. package/README.md +88 -37
  3. package/dist/typed.cjs +2 -0
  4. package/dist/typed.cjs.map +1 -0
  5. package/dist/typed.module.js +2 -0
  6. package/dist/typed.module.js.map +1 -0
  7. package/dist/typed.umd.js +3 -0
  8. package/dist/typed.umd.js.map +1 -0
  9. package/index.d.ts +253 -134
  10. package/package.json +21 -28
  11. package/.codeclimate.yml +0 -31
  12. package/.csslintrc +0 -2
  13. package/.esdoc.json +0 -4
  14. package/.eslintignore +0 -3
  15. package/.eslintrc.yml +0 -25
  16. package/.github/CONTRIBUTING.md +0 -44
  17. package/.github/ISSUE_TEMPLATE.md +0 -27
  18. package/.github/PULL_REQUEST_TEMPLATE.md +0 -38
  19. package/.prettierrc +0 -4
  20. package/.travis.yml +0 -16
  21. package/.vscode/launch.json +0 -14
  22. package/.vscode/settings.json +0 -11
  23. package/CODE_OF_CONDUCT.md +0 -46
  24. package/app.js +0 -12
  25. package/assets/demos.css +0 -61
  26. package/assets/demos.js +0 -133
  27. package/bower.json +0 -11
  28. package/docs/API.md +0 -231
  29. package/docs/assets/anchor.js +0 -197
  30. package/docs/assets/bass-addons.css +0 -12
  31. package/docs/assets/bass.css +0 -543
  32. package/docs/assets/fonts/EOT/SourceCodePro-Bold.eot +0 -0
  33. package/docs/assets/fonts/EOT/SourceCodePro-Regular.eot +0 -0
  34. package/docs/assets/fonts/LICENSE.txt +0 -93
  35. package/docs/assets/fonts/OTF/SourceCodePro-Bold.otf +0 -0
  36. package/docs/assets/fonts/OTF/SourceCodePro-Regular.otf +0 -0
  37. package/docs/assets/fonts/TTF/SourceCodePro-Bold.ttf +0 -0
  38. package/docs/assets/fonts/TTF/SourceCodePro-Regular.ttf +0 -0
  39. package/docs/assets/fonts/WOFF/OTF/SourceCodePro-Bold.otf.woff +0 -0
  40. package/docs/assets/fonts/WOFF/OTF/SourceCodePro-Regular.otf.woff +0 -0
  41. package/docs/assets/fonts/WOFF/TTF/SourceCodePro-Bold.ttf.woff +0 -0
  42. package/docs/assets/fonts/WOFF/TTF/SourceCodePro-Regular.ttf.woff +0 -0
  43. package/docs/assets/fonts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 +0 -0
  44. package/docs/assets/fonts/WOFF2/OTF/SourceCodePro-Regular.otf.woff2 +0 -0
  45. package/docs/assets/fonts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 +0 -0
  46. package/docs/assets/fonts/WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 +0 -0
  47. package/docs/assets/fonts/source-code-pro.css +0 -23
  48. package/docs/assets/github.css +0 -123
  49. package/docs/assets/site.js +0 -108
  50. package/docs/assets/style.css +0 -136
  51. package/docs/index.html +0 -2187
  52. package/gulpfile.js +0 -95
  53. package/index.html +0 -184
  54. package/lib/typed.js +0 -1052
  55. package/lib/typed.min.js +0 -11
  56. package/lib/typed.min.js.map +0 -1
  57. package/logo-cropped.png +0 -0
  58. package/logo.png +0 -0
  59. package/src/defaults.js +0 -164
  60. package/src/html-parser.js +0 -67
  61. package/src/initializer.js +0 -207
  62. package/src/typed.js +0 -433
  63. package/webpack.config.js +0 -45
@@ -1,11 +0,0 @@
1
- {
2
- "eslint.enable": true,
3
- "eslint.options": { "configFile": "./.eslintrc.yml" },
4
- "search.exclude": {
5
- "**/.git": true,
6
- "**/node_modules": true,
7
- "**/bower_components": true,
8
- "**/tmp": true,
9
- "**/lib": true
10
- }
11
- }
@@ -1,46 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
-
7
- ## Our Standards
8
-
9
- Examples of behavior that contributes to creating a positive environment include:
10
-
11
- * Using welcoming and inclusive language
12
- * Being respectful of differing viewpoints and experiences
13
- * Gracefully accepting constructive criticism
14
- * Focusing on what is best for the community
15
- * Showing empathy towards other community members
16
-
17
- Examples of unacceptable behavior by participants include:
18
-
19
- * The use of sexualized language or imagery and unwelcome sexual attention or advances
20
- * Trolling, insulting/derogatory comments, and personal or political attacks
21
- * Public or private harassment
22
- * Publishing others' private information, such as a physical or electronic address, without explicit permission
23
- * Other conduct which could reasonably be considered inappropriate in a professional setting
24
-
25
- ## Our Responsibilities
26
-
27
- Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
-
29
- Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
-
31
- ## Scope
32
-
33
- This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
-
35
- ## Enforcement
36
-
37
- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at me@mattboldt.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
-
39
- Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
-
41
- ## Attribution
42
-
43
- This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44
-
45
- [homepage]: http://contributor-covenant.org
46
- [version]: http://contributor-covenant.org/version/1/4/
package/app.js DELETED
@@ -1,12 +0,0 @@
1
- const express = require('express')
2
- const app = express()
3
-
4
- app.get('/', (req, res) => {
5
- res.sendFile(`${__dirname}/index.html`)
6
- })
7
-
8
- app.listen(3000, () => {
9
- console.log('Example app listening on port 3000!')
10
- })
11
-
12
- app.use(express.static(`${__dirname}/`))
package/assets/demos.css DELETED
@@ -1,61 +0,0 @@
1
- @import url(https://fonts.googleapis.com/css?family=Ubuntu:400,500);
2
-
3
- *{
4
- padding:0;
5
- margin:0;
6
- }
7
-
8
- body{
9
- font-family: "Ubuntu", sans-serif;
10
- font-size: 100%;
11
- background:#f8f8f8;
12
- }
13
-
14
- a{
15
- text-decoration: none;
16
- color:#666;
17
- }
18
- a:hover{
19
- color:#999;
20
- }
21
-
22
- button {
23
- padding: 10px;
24
- border-radius: 3px;
25
- background: #E0E0E0;
26
- border: #CCC 1px solid;
27
- }
28
-
29
- p{
30
- line-height: 2em;
31
- margin:0 0 20px;
32
- text-align: center;
33
- }
34
-
35
- hr{
36
- border: 0;
37
- border-bottom: #CCC 2px solid;
38
- margin: 30px auto;
39
- }
40
-
41
- .title{
42
- font-size: 4em;
43
- }
44
-
45
- .wrap{
46
- max-width: 600px;
47
- margin:50px auto;
48
- }
49
-
50
- .type-wrap{
51
- margin:10px auto;
52
- padding:20px;
53
- background:#f0f0f0;
54
- border-radius:5px;
55
- border:#CCC 1px solid;
56
- }
57
-
58
- .links{
59
- margin:20px 0;
60
- font-size: 0.75em;
61
- }
package/assets/demos.js DELETED
@@ -1,133 +0,0 @@
1
- document.addEventListener('DOMContentLoaded', function() {
2
- var typed = new Typed('#typed', {
3
- stringsElement: '#typed-strings',
4
- typeSpeed: 20,
5
- backSpeed: 20,
6
- startDelay: 1000,
7
- loop: false,
8
- loopCount: Infinity,
9
- onBegin: function(self) {
10
- prettyLog('onBegin ' + self);
11
- },
12
- onComplete: function(self) {
13
- prettyLog('onComplete ' + self);
14
- },
15
- preStringTyped: function(pos, self) {
16
- prettyLog('preStringTyped ' + pos + ' ' + self);
17
- },
18
- onStringTyped: function(pos, self) {
19
- prettyLog('onStringTyped ' + pos + ' ' + self);
20
- },
21
- onLastStringBackspaced: function(self) {
22
- prettyLog('onLastStringBackspaced ' + self);
23
- },
24
- onTypingPaused: function(pos, self) {
25
- prettyLog('onTypingPaused ' + pos + ' ' + self);
26
- },
27
- onTypingResumed: function(pos, self) {
28
- prettyLog('onTypingResumed ' + pos + ' ' + self);
29
- },
30
- onReset: function(self) {
31
- prettyLog('onReset ' + self);
32
- },
33
- onStop: function(pos, self) {
34
- prettyLog('onStop ' + pos + ' ' + self);
35
- },
36
- onStart: function(pos, self) {
37
- prettyLog('onStart ' + pos + ' ' + self);
38
- },
39
- onDestroy: function(self) {
40
- prettyLog('onDestroy ' + self);
41
- }
42
- });
43
-
44
- document.querySelector('.toggle').addEventListener('click', function() {
45
- typed.toggle();
46
- });
47
- document.querySelector('.stop').addEventListener('click', function() {
48
- typed.stop();
49
- });
50
- document.querySelector('.start').addEventListener('click', function() {
51
- typed.start();
52
- });
53
- document.querySelector('.reset').addEventListener('click', function() {
54
- typed.reset();
55
- });
56
- document.querySelector('.destroy').addEventListener('click', function() {
57
- typed.destroy();
58
- });
59
- document.querySelector('.loop').addEventListener('click', function() {
60
- toggleLoop(typed);
61
- });
62
-
63
- var typed2 = new Typed('#typed2', {
64
- strings: [
65
- 'Some <i>strings</i> with',
66
- 'Some <strong>HTML</strong>',
67
- 'Chars &times; &copy;'
68
- ],
69
- typeSpeed: 0,
70
- backSpeed: 0,
71
- fadeOut: true,
72
- loop: true
73
- });
74
- document.querySelector('.loop2').addEventListener('click', function() {
75
- toggleLoop(typed2);
76
- });
77
-
78
- new Typed('#typed3', {
79
- strings: [
80
- 'My strings are: <i>strings</i> with',
81
- 'My strings are: <strong>HTML</strong>',
82
- 'My strings are: Chars &times; &copy;'
83
- ],
84
- typeSpeed: 0,
85
- backSpeed: 0,
86
- smartBackspace: true,
87
- loop: true
88
- });
89
-
90
- new Typed('#typed4', {
91
- strings: ['Some strings without', 'Some HTML', 'Chars'],
92
- typeSpeed: 0,
93
- backSpeed: 0,
94
- attr: 'placeholder',
95
- bindInputFocusEvents: true,
96
- loop: true
97
- });
98
-
99
- new Typed('#typed5', {
100
- strings: [
101
- '1 Some <i>strings</i> with',
102
- '2 Some <strong>HTML</strong>',
103
- '3 Chars &times; &copy;'
104
- ],
105
- typeSpeed: 0,
106
- backSpeed: 0,
107
- shuffle: true,
108
- cursorChar: '_',
109
- smartBackspace: false,
110
- loop: true
111
- });
112
-
113
- new Typed('#typed6', {
114
- strings: [
115
- 'npm install^1000\n`installing components...` ^1000\n`Fetching from source...`'
116
- ],
117
- typeSpeed: 40,
118
- backSpeed: 0,
119
- loop: true
120
- });
121
- });
122
-
123
- function prettyLog(str) {
124
- console.log('%c ' + str, 'color: green; font-weight: bold;');
125
- }
126
-
127
- function toggleLoop(typed) {
128
- if (typed.loop) {
129
- typed.loop = false;
130
- } else {
131
- typed.loop = true;
132
- }
133
- }
package/bower.json DELETED
@@ -1,11 +0,0 @@
1
- {
2
- "name": "typed.js",
3
- "version": "2.0.12",
4
- "homepage": "https://github.com/mattboldt/typed.js",
5
- "authors": ["Matt Boldt <me@mattboldt.com>"],
6
- "description": "A JavaScript Typing Animation Library",
7
- "main": "lib/typed.js",
8
- "keywords": ["typed", "animation"],
9
- "ignore": [],
10
- "license": "MIT"
11
- }
package/docs/API.md DELETED
@@ -1,231 +0,0 @@
1
- <!-- Generated by documentation.js. Update this documentation by updating the source code. -->
2
-
3
- ## defaults
4
-
5
- Defaults & options
6
-
7
- Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Typed defaults & options
8
-
9
- ### strings
10
-
11
- **Properties**
12
-
13
- - `strings` **[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** strings to be typed
14
- - `stringsElement` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ID of element containing string children
15
-
16
- ### typeSpeed
17
-
18
- **Properties**
19
-
20
- - `typeSpeed` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** type speed in milliseconds
21
-
22
- ### startDelay
23
-
24
- **Properties**
25
-
26
- - `startDelay` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** time before typing starts in milliseconds
27
-
28
- ### backSpeed
29
-
30
- **Properties**
31
-
32
- - `backSpeed` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** backspacing speed in milliseconds
33
-
34
- ### smartBackspace
35
-
36
- **Properties**
37
-
38
- - `smartBackspace` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** only backspace what doesn't match the previous string
39
-
40
- ### shuffle
41
-
42
- **Properties**
43
-
44
- - `shuffle` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** shuffle the strings
45
-
46
- ### backDelay
47
-
48
- **Properties**
49
-
50
- - `backDelay` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** time before backspacing in milliseconds
51
-
52
- ### fadeOut
53
-
54
- **Properties**
55
-
56
- - `fadeOut` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Fade out instead of backspace
57
- - `fadeOutClass` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** css class for fade animation
58
- - `fadeOutDelay` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Fade out delay in milliseconds
59
-
60
- ### loop
61
-
62
- **Properties**
63
-
64
- - `loop` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** loop strings
65
- - `loopCount` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** amount of loops
66
-
67
- ### showCursor
68
-
69
- **Properties**
70
-
71
- - `showCursor` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** show cursor
72
- - `cursorChar` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** character for cursor
73
- - `autoInsertCss` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** insert CSS for cursor and fadeOut into HTML <head>
74
-
75
- ### attr
76
-
77
- **Properties**
78
-
79
- - `attr` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** attribute for typing
80
- Ex: input placeholder, value, or just HTML text
81
-
82
- ### bindInputFocusEvents
83
-
84
- **Properties**
85
-
86
- - `bindInputFocusEvents` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** bind to focus and blur if el is text input
87
-
88
- ### contentType
89
-
90
- **Properties**
91
-
92
- - `contentType` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** 'html' or 'null' for plaintext
93
-
94
- ### onBegin
95
-
96
- Before it begins typing
97
-
98
- **Parameters**
99
-
100
- - `self` **[Typed](#typed)**
101
-
102
-
103
- ### onComplete
104
-
105
- All typing is complete
106
-
107
- **Parameters**
108
-
109
- - `self` **[Typed](#typed)**
110
-
111
- ### preStringTyped
112
-
113
- Before each string is typed
114
-
115
- **Parameters**
116
-
117
- - `arrayPos` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
118
- - `self` **[Typed](#typed)**
119
-
120
- ### onStringTyped
121
-
122
- After each string is typed
123
-
124
- **Parameters**
125
-
126
- - `arrayPos` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
127
- - `self` **[Typed](#typed)**
128
-
129
- ### onLastStringBackspaced
130
-
131
- During looping, after last string is typed
132
-
133
- **Parameters**
134
-
135
- - `self` **[Typed](#typed)**
136
-
137
- ### onTypingPaused
138
-
139
- Typing has been stopped
140
-
141
- **Parameters**
142
-
143
- - `arrayPos` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
144
- - `self` **[Typed](#typed)**
145
-
146
- ### onTypingResumed
147
-
148
- Typing has been started after being stopped
149
-
150
- **Parameters**
151
-
152
- - `arrayPos` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
153
- - `self` **[Typed](#typed)**
154
-
155
- ### onReset
156
-
157
- After reset
158
-
159
- **Parameters**
160
-
161
- - `self` **[Typed](#typed)**
162
-
163
- ### onStop
164
-
165
- After stop
166
-
167
- **Parameters**
168
-
169
- - `arrayPos` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
170
- - `self` **[Typed](#typed)**
171
-
172
- ### onStart
173
-
174
- After start
175
-
176
- **Parameters**
177
-
178
- - `arrayPos` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
179
- - `self` **[Typed](#typed)**
180
-
181
- ### onDestroy
182
-
183
- After destroy
184
-
185
- **Parameters**
186
-
187
- - `self` **[Typed](#typed)**
188
-
189
- ## HTMLParser
190
-
191
- TODO: These methods can probably be combined somehow
192
- Parse HTML tags & HTML Characters
193
-
194
- ## Initializer
195
-
196
- Initialize the Typed object
197
-
198
- ## Typed
199
-
200
- Welcome to Typed.js!
201
-
202
- **Parameters**
203
-
204
- - `elementId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** HTML element ID _OR_ HTML element
205
- - `options` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** options object
206
-
207
- Returns **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** a new Typed object
208
-
209
- ### toggle
210
-
211
- Toggle start() and stop() of the Typed instance
212
-
213
- ### stop
214
-
215
- Stop typing / backspacing and enable cursor blinking
216
-
217
- ### start
218
-
219
- Start typing / backspacing after being stopped
220
-
221
- ### destroy
222
-
223
- Destroy this instance of Typed
224
-
225
- ### reset
226
-
227
- Reset Typed and optionally restarts
228
-
229
- **Parameters**
230
-
231
- - `restart` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?= nser**