From eed07a7b8c64635ae73bcc909a267c2e59992eef Mon Sep 17 00:00:00 2001 From: Matt Boldt Date: Sat, 11 Mar 2023 14:32:01 -0600 Subject: [PATCH] bump version --- README.md | 2 +- docs/index.html | 406 ++++++++++++++++++++++++++++++++++------------ docs/index.json | 346 ++++++++++----------------------------- package-lock.json | 4 +- package.json | 2 +- 5 files changed, 396 insertions(+), 364 deletions(-) diff --git a/README.md b/README.md index d1d1d1d..9785f5f 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ yarn add typed.js #### CDN ```html - + ``` #### Setup diff --git a/docs/index.html b/docs/index.html index d0aed71..0b56bf7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,59 +1,180 @@ - - - - Home | typed.js - - - - - - - -
- Home - - Reference - Source - -
- - - - -
    -
    -
    - - - -

    Build Status -Code Climate -GitHub release -npm -GitHub license

    -

    -

    Live Demo | View All Demos | View Full Docs | mattboldt.com

    Typed.js is a library that types. Enter in any string, and watch it type at the speed you've set, backspace what it's typed, and begin a new sentence for however many strings you've set.

    -
    -

    Installation

    NPM

    npm install typed.js
-

    Yarn

    yarn add typed.js
-

    CDN

    <script src="https://cdn.jsdelivr.net/npm/typed.js@2.0.12"></script>
+  
+    
+    
+    Home | typed.js
+    
+    
+    
+    
+    
+    
+    
+    
+  
+  
+    
    
+      Home
+
+      Reference
+      Source
+
+      
    
+        
+          
+          
+        
+        
      
+      
      
+      
+    
      
+
+    
+
+    
      
+      
      
+        
      
+          Build Status
+          Code Climate
+          GitHub release
+          npm
+          GitHub license
+        
      
+        
      
+          
+        
      
+        
      
+          Live Demo |
+          View All Demos |
+          View Full Docs
+          | mattboldt.com
+        
      
+        
      
+          Typed.js is a library that types. Enter in any string, and watch it
+          type at the speed you've set, backspace what it's typed, and
+          begin a new sentence for however many strings you've set.
+        
      
+        
      
+        
      Installation
      
+        
      NPM
      
+        
      npm install typed.js
 
      
-
      Setup
      This is really all you need to get going.
      
-
      // Can also be included with a regular script tag
+        
      Yarn
      
+        
      yarn add typed.js
+
      
+        
      CDN
      
+        
      <script src="https://cdn.jsdelivr.net/npm/typed.js@2.0.13"></script>
+
      
+        
      Setup
      
+        
      This is really all you need to get going.
      
+        
      // Can also be included with a regular script tag
 import Typed from 'typed.js';
 
 var options = {
@@ -63,57 +184,120 @@ 
      Setup
      This is really all you need to get going.
      
 
 var typed = new Typed('.element', options);      
 
      
-
      Use with ReactJS
      Hook-based function component: https://jsfiddle.net/mattboldt/60h9an7y/
      
-
      Class component: https://jsfiddle.net/mattboldt/ovat9jmp/
      
-
      Use with Vue.js
      Check out the Vue.js component: https://github.com/Orlandster/vue-typed-js
      
-
      Use it as WebComponent
      Check out the WebComponent: https://github.com/Orlandster/wc-typed-js
      
-
      Wonderful sites that have used (or are using) Typed.js
      https://github.com/features/package-registry
      
-
      https://slack.com/
      
-
      https://envato.com/
      
-
      https://gorails.com/
      
-
      https://productmap.co/
      
-
      https://www.typed.com/
      
-
      https://apeiron.io
      
-
      https://git.market/
      
-
      https://commando.io/
      
-
      http://testdouble.com/agency.html
      
-
      https://www.capitalfactory.com/
      
-
      http://www.maxcdn.com/
      
-
      https://www.powerauth.com/
      
-
      
-
      Strings from static HTML (SEO Friendly)
      Rather than using the strings array to insert strings, you can place an HTML div on the page and read from it.
-This allows bots and search engines, as well as users with JavaScript disabled, to see your text on the page.
      
-
      <script>
+        
      Use with ReactJS
      
+        
      
+          Hook-based function component:
+          https://jsfiddle.net/mattboldt/60h9an7y/
+        
      
+        
      
+          Class component:
+          https://jsfiddle.net/mattboldt/ovat9jmp/
+        
      
+        
      Use with Vue.js
      
+        
      
+          Check out the Vue.js component:
+          https://github.com/Orlandster/vue-typed-js
+        
      
+        
      Use it as WebComponent
      
+        
      
+          Check out the WebComponent:
+          https://github.com/Orlandster/wc-typed-js
+        
      
+        
      
+          Wonderful sites that have used (or are using) Typed.js
+        
      
+        
      
+          https://github.com/features/package-registry
+        
      
+        
      https://slack.com/
      
+        
      https://envato.com/
      
+        
      https://gorails.com/
      
+        
      https://productmap.co/
      
+        
      https://www.typed.com/
      
+        
      https://apeiron.io
      
+        
      https://git.market/
      
+        
      https://commando.io/
      
+        
      
+          http://testdouble.com/agency.html
+        
      
+        
      
+          https://www.capitalfactory.com/
+        
      
+        
      http://www.maxcdn.com/
      
+        
      
+          https://www.powerauth.com/
+        
      
+        
      
+        
      
+          Strings from static HTML (SEO Friendly)
+        
      
+        
      
+          Rather than using the strings array to insert strings,
+          you can place an HTML div on the page and read from it.
+          This allows bots and search engines, as well as users with JavaScript
+          disabled, to see your text on the page.
+        
      
+        
      <script>
   var typed = new Typed('#typed', {
     stringsElement: '#typed-strings'
   });
 </script>
 
      
-
      <div id="typed-strings">
+        
      <div id="typed-strings">
   <p>Typed.js is a <strong>JavaScript</strong> library.</p>
   <p>It <em>types</em> out sentences.</p>
 </div>
 <span id="typed"></span>
 
      
-
      Type Pausing
      You can pause in the middle of a string for a given amount of time by including an escape character.
      
-
      var typed = new Typed('.element', {
+        
      Type Pausing
      
+        
      
+          You can pause in the middle of a string for a given amount of time by
+          including an escape character.
+        
      
+        
      var typed = new Typed('.element', {
   // Waits 1000ms after typing "First"
   strings: ['First ^1000 sentence.', 'Second sentence.'],
 });
 
      
-
      Smart Backspacing
      In the following example, this would only backspace the words after "This is a"
      
-
      var typed = new Typed('.element', {
+        
      Smart Backspacing
      
+        
      
+          In the following example, this would only backspace the words after
+          "This is a"
+        
      
+        
      var typed = new Typed('.element', {
   strings: ['This is a JavaScript library', 'This is an ES6 module'],
   smartBackspace: true, // Default value
 });
 
      
-
      Bulk Typing
      The following example would emulate how a terminal acts when typing a command and seeing its result.
      
-
      var typed = new Typed('.element', {
+        
      Bulk Typing
      
+        
      
+          The following example would emulate how a terminal acts when typing a
+          command and seeing its result.
+        
      
+        
      var typed = new Typed('.element', {
   strings: ['git push --force ^1000\n `pushed to origin with option force`'],
 });
 
      
-
      CSS
      CSS animations are built upon initialization in JavaScript. But, you can customize them at your will! These classes are:
      
-
      /* Cursor */
+        
      CSS
      
+        
      
+          CSS animations are built upon initialization in JavaScript. But, you
+          can customize them at your will! These classes are:
+        
      
+        
      /* Cursor */
 .typed-cursor {
 }
 
@@ -121,7 +305,8 @@ 
      CSS
      CSS animations are built upon initialization in JavaScri
 .typed-fade-out {
 }
 
      
-
      Customization
      var typed = new Typed('.element', {
+        
      Customization
      
+        
      var typed = new Typed('.element', {
   /**
    * @property {array} strings strings to be typed
    * @property {string} stringsElement ID of element containing string children
@@ -278,22 +463,39 @@ 
      Customization
      
 
      
-
      Contributing
      View Contribution Guidelines
      end
      Thanks for checking this out. If you have any questions, I'll be on Twitter.
      
-
      If you're using this, let me know! I'd love to see it.
      
-
      It would also be great if you mentioned me or my website somewhere. www.mattboldt.com
      
-
      
-
      
-
-
-
-
-
-
-
-
-
-
-
+        
      Contributing
      
+        
      
+          View Contribution Guidelines
+        
      
+        
      end
      
+        
      
+          Thanks for checking this out. If you have any questions, I'll be
+          on Twitter.
+        
      
+        
      If you're using this, let me know! I'd love to see it.
      
+        
      
+          It would also be great if you mentioned me or my website somewhere.
+          www.mattboldt.com
+        
      
+
      +
      + + + + + + + + + + + diff --git a/docs/index.json b/docs/index.json index eb8722f..70860fc 100644 --- a/docs/index.json +++ b/docs/index.json @@ -595,9 +595,7 @@ ], "return": { "nullable": null, - "types": [ - "object" - ], + "types": ["object"], "spread": false, "description": "Typed defaults & options" }, @@ -654,9 +652,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -664,9 +660,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -674,9 +668,7 @@ }, { "nullable": null, - "types": [ - "Typed" - ], + "types": ["Typed"], "spread": false, "optional": false, "name": "self", @@ -685,9 +677,7 @@ ], "return": { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "description": "a new string position" } @@ -713,9 +703,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -723,9 +711,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -733,9 +719,7 @@ }, { "nullable": null, - "types": [ - "Typed" - ], + "types": ["Typed"], "spread": false, "optional": false, "name": "self", @@ -744,9 +728,7 @@ ], "return": { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "description": "a new string position" } @@ -766,9 +748,7 @@ "lineNumber": 67, "undocument": true, "type": { - "types": [ - "src/html-parser.js~HTMLParser" - ] + "types": ["src/html-parser.js~HTMLParser"] } }, { @@ -812,9 +792,7 @@ "params": [ { "nullable": null, - "types": [ - "Typed" - ], + "types": ["Typed"], "spread": false, "optional": false, "name": "self", @@ -822,9 +800,7 @@ }, { "nullable": null, - "types": [ - "object" - ], + "types": ["object"], "spread": false, "optional": false, "name": "options", @@ -832,9 +808,7 @@ }, { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "elementId", @@ -859,15 +833,11 @@ "params": [ { "name": "self", - "types": [ - "*" - ] + "types": ["*"] } ], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -886,9 +856,7 @@ "params": [ { "name": "self", - "types": [ - "*" - ] + "types": ["*"] } ], "return": null @@ -908,9 +876,7 @@ "lineNumber": 210, "undocument": true, "type": { - "types": [ - "src/initializer.js~Initializer" - ] + "types": ["src/initializer.js~Initializer"] } }, { @@ -946,9 +912,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "elementId", @@ -956,9 +920,7 @@ }, { "nullable": null, - "types": [ - "object" - ], + "types": ["object"], "spread": false, "optional": false, "name": "options", @@ -967,9 +929,7 @@ ], "return": { "nullable": null, - "types": [ - "object" - ], + "types": ["object"], "spread": false, "description": "a new Typed object" }, @@ -1064,9 +1024,7 @@ "params": [ { "nullable": null, - "types": [ - "boolean" - ], + "types": ["boolean"], "spread": false, "optional": false, "name": "restart", @@ -1087,9 +1045,7 @@ "lineNumber": 74, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1104,9 +1060,7 @@ "lineNumber": 76, "undocument": true, "type": { - "types": [ - "number" - ] + "types": ["number"] } }, { @@ -1121,9 +1075,7 @@ "lineNumber": 77, "undocument": true, "type": { - "types": [ - "number" - ] + "types": ["number"] } }, { @@ -1138,9 +1090,7 @@ "lineNumber": 78, "undocument": true, "type": { - "types": [ - "number" - ] + "types": ["number"] } }, { @@ -1170,9 +1120,7 @@ "lineNumber": 92, "undocument": true, "type": { - "types": [ - "boolean" - ] + "types": ["boolean"] } }, { @@ -1190,9 +1138,7 @@ "params": [ { "name": "timestamp", - "types": [ - "*" - ] + "types": ["*"] } ], "return": null @@ -1209,9 +1155,7 @@ "lineNumber": 105, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1229,9 +1173,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -1239,9 +1181,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -1266,21 +1206,15 @@ "params": [ { "name": "curString", - "types": [ - "*" - ] + "types": ["*"] }, { "name": "curStrPos", - "types": [ - "*" - ] + "types": ["*"] }, { "name": "timestamp", - "types": [ - "*" - ] + "types": ["*"] } ], "return": null @@ -1297,9 +1231,7 @@ "lineNumber": 152, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1314,9 +1246,7 @@ "lineNumber": 179, "undocument": true, "type": { - "types": [ - "boolean" - ] + "types": ["boolean"] } }, { @@ -1331,9 +1261,7 @@ "lineNumber": 208, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1351,9 +1279,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -1361,9 +1287,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -1387,9 +1311,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -1397,9 +1319,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -1423,9 +1343,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -1433,9 +1351,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -1443,9 +1359,7 @@ } ], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1460,9 +1374,7 @@ "lineNumber": 301, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1495,9 +1407,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -1505,9 +1415,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -1515,9 +1423,7 @@ }, { "nullable": null, - "types": [ - "boolean" - ], + "types": ["boolean"], "spread": false, "optional": false, "name": "isTyping", @@ -1541,9 +1447,7 @@ "params": [ { "nullable": null, - "types": [ - "boolean" - ], + "types": ["boolean"], "spread": false, "optional": false, "name": "isBlinking", @@ -1564,9 +1468,7 @@ "lineNumber": 368, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1584,9 +1486,7 @@ "params": [ { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "speed", @@ -1594,9 +1494,7 @@ } ], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1626,9 +1524,7 @@ "lineNumber": 391, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1645,9 +1541,7 @@ "lineNumber": 398, "params": [], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1665,9 +1559,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "str", @@ -1739,9 +1631,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "elementId", @@ -1749,9 +1639,7 @@ }, { "nullable": null, - "types": [ - "object" - ], + "types": ["object"], "spread": false, "optional": false, "name": "options", @@ -1760,9 +1648,7 @@ ], "return": { "nullable": null, - "types": [ - "object" - ], + "types": ["object"], "spread": false, "description": "a new Typed object" }, @@ -1857,9 +1743,7 @@ "params": [ { "nullable": null, - "types": [ - "boolean" - ], + "types": ["boolean"], "spread": false, "optional": false, "name": "restart", @@ -1880,9 +1764,7 @@ "lineNumber": 73, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -1897,9 +1779,7 @@ "lineNumber": 75, "undocument": true, "type": { - "types": [ - "number" - ] + "types": ["number"] } }, { @@ -1914,9 +1794,7 @@ "lineNumber": 76, "undocument": true, "type": { - "types": [ - "number" - ] + "types": ["number"] } }, { @@ -1931,9 +1809,7 @@ "lineNumber": 77, "undocument": true, "type": { - "types": [ - "number" - ] + "types": ["number"] } }, { @@ -1963,9 +1839,7 @@ "lineNumber": 91, "undocument": true, "type": { - "types": [ - "boolean" - ] + "types": ["boolean"] } }, { @@ -1980,9 +1854,7 @@ "lineNumber": 95, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2000,9 +1872,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -2010,9 +1880,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -2033,9 +1901,7 @@ "lineNumber": 142, "undocument": true, "type": { - "types": [ - "boolean" - ] + "types": ["boolean"] } }, { @@ -2053,9 +1919,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -2063,9 +1927,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -2089,9 +1951,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -2099,9 +1959,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -2125,9 +1983,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -2135,9 +1991,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -2145,9 +1999,7 @@ } ], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2162,9 +2014,7 @@ "lineNumber": 267, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2197,9 +2047,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "curString", @@ -2207,9 +2055,7 @@ }, { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "curStrPos", @@ -2217,9 +2063,7 @@ }, { "nullable": null, - "types": [ - "boolean" - ], + "types": ["boolean"], "spread": false, "optional": false, "name": "isTyping", @@ -2243,9 +2087,7 @@ "params": [ { "nullable": null, - "types": [ - "boolean" - ], + "types": ["boolean"], "spread": false, "optional": false, "name": "isBlinking", @@ -2266,9 +2108,7 @@ "lineNumber": 334, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2286,9 +2126,7 @@ "params": [ { "nullable": null, - "types": [ - "number" - ], + "types": ["number"], "spread": false, "optional": false, "name": "speed", @@ -2296,9 +2134,7 @@ } ], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2328,9 +2164,7 @@ "lineNumber": 357, "undocument": true, "type": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2347,9 +2181,7 @@ "lineNumber": 364, "params": [], "return": { - "types": [ - "*" - ] + "types": ["*"] } }, { @@ -2367,9 +2199,7 @@ "params": [ { "nullable": null, - "types": [ - "string" - ], + "types": ["string"], "spread": false, "optional": false, "name": "str", @@ -2410,7 +2240,7 @@ }, { "kind": "index", - "content": "[![Build Status](https://travis-ci.org/mattboldt/typed.js.svg?branch=typed-2.0)](https://travis-ci.org/mattboldt/typed.js)\n[![Code Climate](https://codeclimate.com/github/mattboldt/typed.js/badges/gpa.svg)](https://codeclimate.com/github/mattboldt/typed.js)\n[![GitHub release](https://img.shields.io/github/release/mattboldt/typed.js.svg)]()\n[![npm](https://img.shields.io/npm/dt/typed.js.svg)](https://img.shields.io/npm/dt/typed.js.svg)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/mattboldt/typed.js/master/LICENSE.txt)\n\n\n\n### [Live Demo](http://www.mattboldt.com/demos/typed-js/) | [View All Demos](http://mattboldt.github.io/typed.js/) | [View Full Docs](http://mattboldt.github.io/typed.js/docs) | [mattboldt.com](http://www.mattboldt.com)\n\nTyped.js is a library that types. Enter in any string, and watch it type at the speed you've set, backspace what it's typed, and begin a new sentence for however many strings you've set.\n\n---\n\n## Installation\n\n#### NPM\n\n```\nnpm install typed.js\n```\n\n#### Yarn\n\n```\nyarn add typed.js\n```\n\n#### CDN\n\n```html\n\n```\n\n#### Setup\n\nThis is really all you need to get going.\n\n```javascript\n// Can also be included with a regular script tag\nimport Typed from 'typed.js';\n\nvar options = {\n strings: ['First sentence.', '& a second sentence.'],\n typeSpeed: 40,\n};\n\nvar typed = new Typed('.element', options);\n```\n\n### Use with ReactJS\n\nHook-based function component: https://jsfiddle.net/mattboldt/60h9an7y/\n\nClass component: https://jsfiddle.net/mattboldt/ovat9jmp/\n\n### Use with Vue.js\n\nCheck out the Vue.js component: https://github.com/Orlandster/vue-typed-js\n\n### Use it as WebComponent\n\nCheck out the WebComponent: https://github.com/Orlandster/wc-typed-js\n\n## Wonderful sites that have used (or are using) Typed.js\n\nhttps://github.com/features/package-registry\n\nhttps://slack.com/\n\nhttps://envato.com/\n\nhttps://gorails.com/\n\nhttps://productmap.co/\n\nhttps://www.typed.com/\n\nhttps://apeiron.io\n\nhttps://git.market/\n\nhttps://commando.io/\n\nhttp://testdouble.com/agency.html\n\nhttps://www.capitalfactory.com/\n\nhttp://www.maxcdn.com/\n\nhttps://www.powerauth.com/\n\n---\n\n### Strings from static HTML (SEO Friendly)\n\nRather than using the `strings` array to insert strings, you can place an HTML `div` on the page and read from it.\nThis allows bots and search engines, as well as users with JavaScript disabled, to see your text on the page.\n\n```javascript\n\n```\n\n```html\n
      \n

      Typed.js is a JavaScript library.

      \n

      It types out sentences.

      \n
      \n\n```\n\n### Type Pausing\n\nYou can pause in the middle of a string for a given amount of time by including an escape character.\n\n```javascript\nvar typed = new Typed('.element', {\n // Waits 1000ms after typing \"First\"\n strings: ['First ^1000 sentence.', 'Second sentence.'],\n});\n```\n\n### Smart Backspacing\n\nIn the following example, this would only backspace the words after \"This is a\"\n\n```javascript\nvar typed = new Typed('.element', {\n strings: ['This is a JavaScript library', 'This is an ES6 module'],\n smartBackspace: true, // Default value\n});\n```\n\n### Bulk Typing\n\nThe following example would emulate how a terminal acts when typing a command and seeing its result.\n\n```javascript\nvar typed = new Typed('.element', {\n strings: ['git push --force ^1000\\n `pushed to origin with option force`'],\n});\n```\n\n### CSS\n\nCSS animations are built upon initialization in JavaScript. But, you can customize them at your will! These classes are:\n\n```css\n/* Cursor */\n.typed-cursor {\n}\n\n/* If fade out option is set */\n.typed-fade-out {\n}\n```\n\n## Customization\n\n```javascript\nvar typed = new Typed('.element', {\n /**\n * @property {array} strings strings to be typed\n * @property {string} stringsElement ID of element containing string children\n */\n strings: [\n 'These are the default values...',\n 'You know what you should do?',\n 'Use your own!',\n 'Have a great day!',\n ],\n stringsElement: null,\n\n /**\n * @property {number} typeSpeed type speed in milliseconds\n */\n typeSpeed: 0,\n\n /**\n * @property {number} startDelay time before typing starts in milliseconds\n */\n startDelay: 0,\n\n /**\n * @property {number} backSpeed backspacing speed in milliseconds\n */\n backSpeed: 0,\n\n /**\n * @property {boolean} smartBackspace only backspace what doesn't match the previous string\n */\n smartBackspace: true,\n\n /**\n * @property {boolean} shuffle shuffle the strings\n */\n shuffle: false,\n\n /**\n * @property {number} backDelay time before backspacing in milliseconds\n */\n backDelay: 700,\n\n /**\n * @property {boolean} fadeOut Fade out instead of backspace\n * @property {string} fadeOutClass css class for fade animation\n * @property {boolean} fadeOutDelay Fade out delay in milliseconds\n */\n fadeOut: false,\n fadeOutClass: 'typed-fade-out',\n fadeOutDelay: 500,\n\n /**\n * @property {boolean} loop loop strings\n * @property {number} loopCount amount of loops\n */\n loop: false,\n loopCount: Infinity,\n\n /**\n * @property {boolean} showCursor show cursor\n * @property {string} cursorChar character for cursor\n * @property {boolean} autoInsertCss insert CSS for cursor and fadeOut into HTML \n */\n showCursor: true,\n cursorChar: '|',\n autoInsertCss: true,\n\n /**\n * @property {string} attr attribute for typing\n * Ex: input placeholder, value, or just HTML text\n */\n attr: null,\n\n /**\n * @property {boolean} bindInputFocusEvents bind to focus and blur if el is text input\n */\n bindInputFocusEvents: false,\n\n /**\n * @property {string} contentType 'html' or 'null' for plaintext\n */\n contentType: 'html',\n\n /**\n * Before it begins typing\n * @param {Typed} self\n */\n onBegin: (self) => {},\n\n /**\n * All typing is complete\n * @param {Typed} self\n */\n onComplete: (self) => {},\n\n /**\n * Before each string is typed\n * @param {number} arrayPos\n * @param {Typed} self\n */\n preStringTyped: (arrayPos, self) => {},\n\n /**\n * After each string is typed\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onStringTyped: (arrayPos, self) => {},\n\n /**\n * During looping, after last string is typed\n * @param {Typed} self\n */\n onLastStringBackspaced: (self) => {},\n\n /**\n * Typing has been stopped\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onTypingPaused: (arrayPos, self) => {},\n\n /**\n * Typing has been started after being stopped\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onTypingResumed: (arrayPos, self) => {},\n\n /**\n * After reset\n * @param {Typed} self\n */\n onReset: (self) => {},\n\n /**\n * After stop\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onStop: (arrayPos, self) => {},\n\n /**\n * After start\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onStart: (arrayPos, self) => {},\n\n /**\n * After destroy\n * @param {Typed} self\n */\n onDestroy: (self) => {},\n});\n```\n\n## Contributing\n\n### [View Contribution Guidelines](./.github/CONTRIBUTING.md)\n\n## end\n\nThanks for checking this out. If you have any questions, I'll be on [Twitter](https://twitter.com/atmattb).\n\nIf you're using this, let me know! I'd love to see it.\n\nIt would also be great if you mentioned me or my website somewhere. [www.mattboldt.com](http://www.mattboldt.com)\n", + "content": "[![Build Status](https://travis-ci.org/mattboldt/typed.js.svg?branch=typed-2.0)](https://travis-ci.org/mattboldt/typed.js)\n[![Code Climate](https://codeclimate.com/github/mattboldt/typed.js/badges/gpa.svg)](https://codeclimate.com/github/mattboldt/typed.js)\n[![GitHub release](https://img.shields.io/github/release/mattboldt/typed.js.svg)]()\n[![npm](https://img.shields.io/npm/dt/typed.js.svg)](https://img.shields.io/npm/dt/typed.js.svg)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/mattboldt/typed.js/master/LICENSE.txt)\n\n\n\n### [Live Demo](http://www.mattboldt.com/demos/typed-js/) | [View All Demos](http://mattboldt.github.io/typed.js/) | [View Full Docs](http://mattboldt.github.io/typed.js/docs) | [mattboldt.com](http://www.mattboldt.com)\n\nTyped.js is a library that types. Enter in any string, and watch it type at the speed you've set, backspace what it's typed, and begin a new sentence for however many strings you've set.\n\n---\n\n## Installation\n\n#### NPM\n\n```\nnpm install typed.js\n```\n\n#### Yarn\n\n```\nyarn add typed.js\n```\n\n#### CDN\n\n```html\n\n```\n\n#### Setup\n\nThis is really all you need to get going.\n\n```javascript\n// Can also be included with a regular script tag\nimport Typed from 'typed.js';\n\nvar options = {\n strings: ['First sentence.', '& a second sentence.'],\n typeSpeed: 40,\n};\n\nvar typed = new Typed('.element', options);\n```\n\n### Use with ReactJS\n\nHook-based function component: https://jsfiddle.net/mattboldt/60h9an7y/\n\nClass component: https://jsfiddle.net/mattboldt/ovat9jmp/\n\n### Use with Vue.js\n\nCheck out the Vue.js component: https://github.com/Orlandster/vue-typed-js\n\n### Use it as WebComponent\n\nCheck out the WebComponent: https://github.com/Orlandster/wc-typed-js\n\n## Wonderful sites that have used (or are using) Typed.js\n\nhttps://github.com/features/package-registry\n\nhttps://slack.com/\n\nhttps://envato.com/\n\nhttps://gorails.com/\n\nhttps://productmap.co/\n\nhttps://www.typed.com/\n\nhttps://apeiron.io\n\nhttps://git.market/\n\nhttps://commando.io/\n\nhttp://testdouble.com/agency.html\n\nhttps://www.capitalfactory.com/\n\nhttp://www.maxcdn.com/\n\nhttps://www.powerauth.com/\n\n---\n\n### Strings from static HTML (SEO Friendly)\n\nRather than using the `strings` array to insert strings, you can place an HTML `div` on the page and read from it.\nThis allows bots and search engines, as well as users with JavaScript disabled, to see your text on the page.\n\n```javascript\n\n```\n\n```html\n
      \n

      Typed.js is a JavaScript library.

      \n

      It types out sentences.

      \n
      \n\n```\n\n### Type Pausing\n\nYou can pause in the middle of a string for a given amount of time by including an escape character.\n\n```javascript\nvar typed = new Typed('.element', {\n // Waits 1000ms after typing \"First\"\n strings: ['First ^1000 sentence.', 'Second sentence.'],\n});\n```\n\n### Smart Backspacing\n\nIn the following example, this would only backspace the words after \"This is a\"\n\n```javascript\nvar typed = new Typed('.element', {\n strings: ['This is a JavaScript library', 'This is an ES6 module'],\n smartBackspace: true, // Default value\n});\n```\n\n### Bulk Typing\n\nThe following example would emulate how a terminal acts when typing a command and seeing its result.\n\n```javascript\nvar typed = new Typed('.element', {\n strings: ['git push --force ^1000\\n `pushed to origin with option force`'],\n});\n```\n\n### CSS\n\nCSS animations are built upon initialization in JavaScript. But, you can customize them at your will! These classes are:\n\n```css\n/* Cursor */\n.typed-cursor {\n}\n\n/* If fade out option is set */\n.typed-fade-out {\n}\n```\n\n## Customization\n\n```javascript\nvar typed = new Typed('.element', {\n /**\n * @property {array} strings strings to be typed\n * @property {string} stringsElement ID of element containing string children\n */\n strings: [\n 'These are the default values...',\n 'You know what you should do?',\n 'Use your own!',\n 'Have a great day!',\n ],\n stringsElement: null,\n\n /**\n * @property {number} typeSpeed type speed in milliseconds\n */\n typeSpeed: 0,\n\n /**\n * @property {number} startDelay time before typing starts in milliseconds\n */\n startDelay: 0,\n\n /**\n * @property {number} backSpeed backspacing speed in milliseconds\n */\n backSpeed: 0,\n\n /**\n * @property {boolean} smartBackspace only backspace what doesn't match the previous string\n */\n smartBackspace: true,\n\n /**\n * @property {boolean} shuffle shuffle the strings\n */\n shuffle: false,\n\n /**\n * @property {number} backDelay time before backspacing in milliseconds\n */\n backDelay: 700,\n\n /**\n * @property {boolean} fadeOut Fade out instead of backspace\n * @property {string} fadeOutClass css class for fade animation\n * @property {boolean} fadeOutDelay Fade out delay in milliseconds\n */\n fadeOut: false,\n fadeOutClass: 'typed-fade-out',\n fadeOutDelay: 500,\n\n /**\n * @property {boolean} loop loop strings\n * @property {number} loopCount amount of loops\n */\n loop: false,\n loopCount: Infinity,\n\n /**\n * @property {boolean} showCursor show cursor\n * @property {string} cursorChar character for cursor\n * @property {boolean} autoInsertCss insert CSS for cursor and fadeOut into HTML \n */\n showCursor: true,\n cursorChar: '|',\n autoInsertCss: true,\n\n /**\n * @property {string} attr attribute for typing\n * Ex: input placeholder, value, or just HTML text\n */\n attr: null,\n\n /**\n * @property {boolean} bindInputFocusEvents bind to focus and blur if el is text input\n */\n bindInputFocusEvents: false,\n\n /**\n * @property {string} contentType 'html' or 'null' for plaintext\n */\n contentType: 'html',\n\n /**\n * Before it begins typing\n * @param {Typed} self\n */\n onBegin: (self) => {},\n\n /**\n * All typing is complete\n * @param {Typed} self\n */\n onComplete: (self) => {},\n\n /**\n * Before each string is typed\n * @param {number} arrayPos\n * @param {Typed} self\n */\n preStringTyped: (arrayPos, self) => {},\n\n /**\n * After each string is typed\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onStringTyped: (arrayPos, self) => {},\n\n /**\n * During looping, after last string is typed\n * @param {Typed} self\n */\n onLastStringBackspaced: (self) => {},\n\n /**\n * Typing has been stopped\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onTypingPaused: (arrayPos, self) => {},\n\n /**\n * Typing has been started after being stopped\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onTypingResumed: (arrayPos, self) => {},\n\n /**\n * After reset\n * @param {Typed} self\n */\n onReset: (self) => {},\n\n /**\n * After stop\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onStop: (arrayPos, self) => {},\n\n /**\n * After start\n * @param {number} arrayPos\n * @param {Typed} self\n */\n onStart: (arrayPos, self) => {},\n\n /**\n * After destroy\n * @param {Typed} self\n */\n onDestroy: (self) => {},\n});\n```\n\n## Contributing\n\n### [View Contribution Guidelines](./.github/CONTRIBUTING.md)\n\n## end\n\nThanks for checking this out. If you have any questions, I'll be on [Twitter](https://twitter.com/atmattb).\n\nIf you're using this, let me know! I'd love to see it.\n\nIt would also be great if you mentioned me or my website somewhere. [www.mattboldt.com](http://www.mattboldt.com)\n", "longname": "/Users/mattboldt/Documents/dev/Repos/typedjs/README.md", "name": "./README.md", "static": true, @@ -2418,10 +2248,10 @@ }, { "kind": "packageJSON", - "content": "{\n \"name\": \"typed.js\",\n \"version\": \"2.0.12\",\n \"homepage\": \"https://github.com/mattboldt/typed.js\",\n \"repository\": \"https://github.com/mattboldt/typed.js\",\n \"license\": \"MIT\",\n \"author\": \"Matt Boldt\",\n \"description\": \"A JavaScript Typing Animation Library\",\n \"type\": \"module\",\n \"source\": \"src/typed.js\",\n \"types\": \"./index.d.ts\",\n \"files\": [\n \"dist\",\n \"index.d.ts\"\n ],\n \"exports\": {\n \"require\": \"./dist/typed.cjs\",\n \"import\": \"./dist/typed.module.js\"\n },\n \"main\": \"./dist/typed.cjs\",\n \"module\": \"./dist/typed.module.js\",\n \"unpkg\": \"./dist/typed.umd.js\",\n \"keywords\": [\n \"typed\",\n \"animation\"\n ],\n \"devDependencies\": {\n \"esdoc\": \"^1.1.0\",\n \"esdoc-ecmascript-proposal-plugin\": \"^1.0.0\",\n \"esdoc-standard-plugin\": \"^1.0.0\",\n \"microbundle\": \"^0.15.1\"\n },\n \"scripts\": {\n \"build\": \"microbundle --name=Typed\",\n \"dev\": \"microbundle --name=Typed watch\"\n }\n}\n", + "content": "{\n \"name\": \"typed.js\",\n \"version\": \"2.0.13\",\n \"homepage\": \"https://github.com/mattboldt/typed.js\",\n \"repository\": \"https://github.com/mattboldt/typed.js\",\n \"license\": \"MIT\",\n \"author\": \"Matt Boldt\",\n \"description\": \"A JavaScript Typing Animation Library\",\n \"type\": \"module\",\n \"source\": \"src/typed.js\",\n \"types\": \"./index.d.ts\",\n \"files\": [\n \"dist\",\n \"index.d.ts\"\n ],\n \"exports\": {\n \"require\": \"./dist/typed.cjs\",\n \"import\": \"./dist/typed.module.js\"\n },\n \"main\": \"./dist/typed.cjs\",\n \"module\": \"./dist/typed.module.js\",\n \"unpkg\": \"./dist/typed.umd.js\",\n \"keywords\": [\n \"typed\",\n \"animation\"\n ],\n \"devDependencies\": {\n \"esdoc\": \"^1.1.0\",\n \"esdoc-ecmascript-proposal-plugin\": \"^1.0.0\",\n \"esdoc-standard-plugin\": \"^1.0.0\",\n \"microbundle\": \"^0.15.1\"\n },\n \"scripts\": {\n \"build\": \"microbundle --name=Typed\",\n \"dev\": \"microbundle --name=Typed watch\"\n }\n}\n", "longname": "/Users/mattboldt/Documents/dev/Repos/typedjs/package.json", "name": "package.json", "static": true, "access": "public" } -] \ No newline at end of file +] diff --git a/package-lock.json b/package-lock.json index f094ffc..e612920 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "typed.js", - "version": "2.0.12", + "version": "2.0.13", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "typed.js", - "version": "2.0.12", + "version": "2.0.13", "license": "MIT", "devDependencies": { "esdoc": "^1.1.0", diff --git a/package.json b/package.json index b04ded0..3a18bd9 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "typed.js", - "version": "2.0.12", + "version": "2.0.13", "homepage": "https://github.com/mattboldt/typed.js", "repository": "https://github.com/mattboldt/typed.js", "license": "MIT",