typed.js 2.0.12 → 2.0.14

package/index.d.ts

@@ -1,134 +1,253 @@
-/**
- * Declaration for typed.js
- * Typed.js version: v2.0.12
- */
-
-declare module 'typed.js' {
-  interface TypedOptions {
-    /**
-     * strings to be typed
-     */
-    strings?: string[];
-    /**
-     * ID or instance of HTML element of element containing string children
-     */
-    stringsElement?: string | Element;
-    /**
-     * type speed in milliseconds
-     */
-    typeSpeed?: number;
-    /**
-     * time before typing starts in milliseconds
-     */
-    startDelay?: number;
-    /**
-     * backspacing speed in milliseconds
-     */
-    backSpeed?: number;
-    /**
-     * only backspace what doesn't match the previous string
-     */
-    smartBackspace?: boolean;
-    /**
-     * shuffle the strings
-     */
-    shuffle?: boolean;
-    /**
-     * time before backspacing in milliseconds
-     */
-    backDelay?: number;
-    /**
-     * Fade out instead of backspace
-     */
-    fadeOut?: boolean;
-    /**
-     * css class for fade animation
-     */
-    fadeOutClass?: string;
-    /**
-     * Fade out delay in milliseconds
-     */
-    fadeOutDelay?: number;
-    /**
-     * loop strings
-     */
-    loop?: boolean;
-    /**
-     * amount of loops
-     */
-    loopCount?: number;
-    /**
-     * show cursor
-     */
-    showCursor?: boolean;
-    /**
-     * character for cursor
-     */
-    cursorChar?: string;
-    /**
-     * insert CSS for cursor and fadeOut into HTML
-     */
-    autoInsertCss?: boolean;
-    /**
-     * attribute for typing Ex: input placeholder, value, or just HTML text
-     */
-    attr?: string;
-    /**
-     * bind to focus and blur if el is text input
-     */
-    bindInputFocusEvents?: boolean;
-    /**
-     * 'html' or 'null' for plaintext
-     */
-    contentType?: string;
-    /**
-     * All typing is complete
-     */
-    onComplete?(self: Typed): void;
-    /**
-     * Before each string is typed
-     */
-    preStringTyped?(arrayPos: number, self: Typed): void;
-    /**
-     * After each string is typed
-     */
-    onStringTyped?(arrayPos: number, self: Typed): void;
-    /**
-     * During looping, after last string is typed
-     */
-    onLastStringBackspaced?(self: Typed): void;
-    /**
-     * Typing has been stopped
-     */
-    onTypingPaused?(arrayPos: number, self: Typed): void;
-    /**
-     * Typing has been started after being stopped
-     */
-    onTypingResumed?(arrayPos: number, self: Typed): void;
-    /**
-     * After reset
-     */
-    onReset?(self: Typed): void;
-    /**
-     * After stop
-     */
-    onStop?(arrayPos: number, self: Typed): void;
-    /**
-     * After start
-     */
-    onStart?(arrayPos: number, self: Typed): void;
-    /**
-     * After destroy
-     */
-    onDestroy?(self: Typed): void;
-  }
-
-  export default class Typed {
-    constructor(elementId: string | Element, options: TypedOptions);
-    toggle(): void;
-    stop(): void;
-    start(): void;
-    destroy(): void;
-    reset(restart?: boolean): void;
-  }
-}
+/**
+ * Welcome to Typed.js!
+ * @param {string} elementId HTML element ID _OR_ HTML element
+ * @param {object} options options object
+ * @returns {object} a new Typed object
+ */
+
+declare module 'typed.js' {
+  export interface TypedOptions {
+    /**
+     * strings to be typed
+     */
+    strings?: string[];
+    /**
+     * ID or instance of HTML element of element containing string children
+     */
+    stringsElement?: string | Element;
+    /**
+     * type speed in milliseconds
+     */
+    typeSpeed?: number;
+    /**
+     * time before typing starts in milliseconds
+     */
+    startDelay?: number;
+    /**
+     * backspacing speed in milliseconds
+     */
+    backSpeed?: number;
+    /**
+     * only backspace what doesn't match the previous string
+     */
+    smartBackspace?: boolean;
+    /**
+     * shuffle the strings
+     */
+    shuffle?: boolean;
+    /**
+     * time before backspacing in milliseconds
+     */
+    backDelay?: number;
+    /**
+     * Fade out instead of backspace
+     */
+    fadeOut?: boolean;
+    /**
+     * css class for fade animation
+     */
+    fadeOutClass?: string;
+    /**
+     * Fade out delay in milliseconds
+     */
+    fadeOutDelay?: number;
+    /**
+     * loop strings
+     */
+    loop?: boolean;
+    /**
+     * amount of loops
+     */
+    loopCount?: number;
+    /**
+     * show cursor
+     */
+    showCursor?: boolean;
+    /**
+     * character for cursor
+     */
+    cursorChar?: string;
+    /**
+     * insert CSS for cursor and fadeOut into HTML
+     */
+    autoInsertCss?: boolean;
+    /**
+     * attribute for typing Ex: input placeholder, value, or just HTML text
+     */
+    attr?: string;
+    /**
+     * bind to focus and blur if el is text input
+     */
+    bindInputFocusEvents?: boolean;
+    /**
+     * 'html' or 'null' for plaintext
+     */
+    contentType?: string;
+    /**
+     * All typing is complete
+     */
+    onComplete?(self: Typed): void;
+    /**
+     * Before each string is typed
+     */
+    preStringTyped?(arrayPos: number, self: Typed): void;
+    /**
+     * After each string is typed
+     */
+    onStringTyped?(arrayPos: number, self: Typed): void;
+    /**
+     * During looping, after last string is typed
+     */
+    onLastStringBackspaced?(self: Typed): void;
+    /**
+     * Typing has been stopped
+     */
+    onTypingPaused?(arrayPos: number, self: Typed): void;
+    /**
+     * Typing has been started after being stopped
+     */
+    onTypingResumed?(arrayPos: number, self: Typed): void;
+    /**
+     * After reset
+     */
+    onReset?(self: Typed): void;
+    /**
+     * After stop
+     */
+    onStop?(arrayPos: number, self: Typed): void;
+    /**
+     * After start
+     */
+    onStart?(arrayPos: number, self: Typed): void;
+    /**
+     * After destroy
+     */
+    onDestroy?(self: Typed): void;
+  }
+
+  export default class Typed {
+    constructor(elementId: any, options: TypedOptions);
+    /**
+     * Toggle start() and stop() of the Typed instance
+     * @public
+     */
+    public toggle(): void;
+    /**
+     * Stop typing / backspacing and enable cursor blinking
+     * @public
+     */
+    public stop(): void;
+    /**
+     * Start typing / backspacing after being stopped
+     * @public
+     */
+    public start(): void;
+    /**
+     * Destroy this instance of Typed
+     * @public
+     */
+    public destroy(): void;
+    /**
+     * Reset Typed and optionally restarts
+     * @param {boolean} restart
+     * @public
+     */
+    public reset(restart?: boolean): void;
+    cursor: HTMLSpanElement;
+    strPos: number;
+    arrayPos: number;
+    curLoop: number;
+    /**
+     * Begins the typing animation
+     * @private
+     */
+    private begin;
+    typingComplete: boolean;
+    timeout: any;
+    /**
+     * Called for each character typed
+     * @param {string} curString the current string in the strings array
+     * @param {number} curStrPos the current position in the curString
+     * @private
+     */
+    private typewrite;
+    temporaryPause: boolean;
+    /**
+     * Continue to the next string & begin typing
+     * @param {string} curString the current string in the strings array
+     * @param {number} curStrPos the current position in the curString
+     * @private
+     */
+    private keepTyping;
+    /**
+     * We're done typing the current string
+     * @param {string} curString the current string in the strings array
+     * @param {number} curStrPos the current position in the curString
+     * @private
+     */
+    private doneTyping;
+    /**
+     * Backspaces 1 character at a time
+     * @param {string} curString the current string in the strings array
+     * @param {number} curStrPos the current position in the curString
+     * @private
+     */
+    private backspace;
+    stopNum: number;
+    /**
+     * Full animation is complete
+     * @private
+     */
+    private complete;
+    /**
+     * Has the typing been stopped
+     * @param {string} curString the current string in the strings array
+     * @param {number} curStrPos the current position in the curString
+     * @param {boolean} isTyping
+     * @private
+     */
+    private setPauseStatus;
+    /**
+     * Toggle the blinking cursor
+     * @param {boolean} isBlinking
+     * @private
+     */
+    private toggleBlinking;
+    cursorBlinking: any;
+    /**
+     * Speed in MS to type
+     * @param {number} speed
+     * @private
+     */
+    private humanizer;
+    /**
+     * Shuffle the sequence of the strings array
+     * @private
+     */
+    private shuffleStringsIfNeeded;
+    sequence: any;
+    /**
+     * Adds a CSS class to fade out current string
+     * @private
+     */
+    private initFadeOut;
+    /**
+     * Replaces current text in the HTML element
+     * depending on element type
+     * @param {string} str
+     * @private
+     */
+    private replaceText;
+    /**
+     * If using input elements, bind focus in order to
+     * start and stop the animation
+     * @private
+     */
+    private bindFocusEvents;
+    /**
+     * On init, insert the cursor element
+     * @private
+     */
+    private insertCursor;
+  }
+}

package/package.json

@@ -1,41 +1,34 @@
 {
   "name": "typed.js",
-  "version": "2.0.12",
+  "version": "2.0.14",
   "homepage": "https://github.com/mattboldt/typed.js",
   "repository": "https://github.com/mattboldt/typed.js",
   "license": "MIT",
-  "author": "Matt Boldt <me@mattboldt.com>",
+  "author": "Matt Boldt",
   "description": "A JavaScript Typing Animation Library",
-  "main": "lib/typed.js",
+  "type": "module",
+  "source": "src/typed.js",
+  "types": "./index.d.ts",
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "exports": {
+    "require": "./dist/typed.cjs",
+    "import": "./dist/typed.module.js"
+  },
+  "main": "./dist/typed.cjs",
+  "module": "./dist/typed.module.js",
+  "unpkg": "./dist/typed.umd.js",
   "keywords": [
     "typed",
     "animation"
   ],
   "devDependencies": {
-    "babel": "^5.8.23",
-    "babel-core": "^5.8.24",
-    "babel-eslint": "^4.1.1",
-    "babel-loader": "^5.3.2",
-    "documentation": "^8.0.0",
-    "eslint": "^3.19.0",
-    "eslint-config-standard": "^10.2.1",
-    "eslint-plugin-import": "^2.6.0",
-    "eslint-plugin-node": "^5.1.0",
-    "eslint-plugin-promise": "^3.5.0",
-    "eslint-plugin-standard": "^3.0.1",
-    "express": "^4.15.3",
-    "gulp": "^3.9.0",
-    "gulp-documentation": "^3.2.0",
-    "gulp-eslint": "^4.0.0",
-    "gulp-express": "^0.3.5",
-    "gulp-livereload": "^3.8.1",
-    "gulp-rename": "^1.2.2",
-    "gulp-sourcemaps": "^1.5.2",
-    "gulp-uglify": "^1.4.1",
-    "webpack": "^1.12.1",
-    "webpack-stream": "^2.1.0",
-    "lodash": "^4.17.5",
-    "mime": "^1.4.1",
-    "debug": "^2.6.9"
+    "microbundle": "^0.15.1"
+  },
+  "scripts": {
+    "build": "microbundle --name=Typed",
+    "dev": "microbundle --name=Typed watch"
   }
 }

package/.codeclimate.yml

@@ -1,31 +0,0 @@
----
-engines:
-  csslint:
-    enabled: false
-  duplication:
-    enabled: true
-    config:
-      languages:
-        - ruby
-        - javascript
-        - python
-        - php
-  eslint:
-    enabled: true
-  fixme:
-    enabled: false
-ratings:
-  paths:
-    - "**.css"
-    - "**.inc"
-    - "**.js"
-    - "**.jsx"
-    - "**.module"
-    - "**.php"
-    - "**.py"
-    - "**.rb"
-exclude_paths:
-  - dist/
-  - lib/
-  - docs/
-  - assets/

package/.csslintrc

@@ -1,2 +0,0 @@
---exclude-exts=.min.css
---ignore=adjoining-classes,box-model,ids,order-alphabetical,unqualified-attributes

package/.esdoc.json

@@ -1,4 +0,0 @@
-{
-  "source": "./src",
-  "destination": "./docs"
-}

package/.eslintignore

@@ -1,3 +0,0 @@
-**/*{.,-}min.js
-./demos/**.js
-gulpfile.js

package/.eslintrc.yml

@@ -1,25 +0,0 @@
----
-extends: standard
-rules:
-  semi: 0
-  no-extra-semi: 0
-  space-before-function-paren: [error, never]
-
-plugins:
-  - standard
-
-parserOptions:
-  sourceType: module
-  ecmaFeatures:
-    modules: true
-
-env:
-  amd: true
-  browser: true
-  es6: true
-  jquery: true
-  node: true
-
-overrides:
-  - files: ["./demos*.js"]
-    excludedFiles: "./demos/*.js"

package/.github/CONTRIBUTING.md

@@ -1,44 +0,0 @@
-# Contributing
-
-🎉🎉🎉 Thank you for contributing! 🎉🎉🎉
-
-I greatly appreciate anyone taking the time to help make Typed.js better.
-
-## Development
-
-First, clone the repo onto your local machine.
-```
-git clone git@github.com:mattboldt/typed.js.git
-cd typed.js
-```
-
-Then, make sure you have all the development dependencies installed.
-```
-yarn install
-```
-(note: you will need Node.js, `yarn`, and `gulp` installed globally on your system)
-
-To get things going:
-```
-gulp serve
-open http://localhost:3000
-```
-There you will see a list of pre-made demos showing each feature of Typed.js in action.
-
-**Comb through these demos carefully and insure all features are working as expected with your additions**
-
-## Pull Request Etiquette
-
-If this is purely a README update, you can skip everything below.
-
-You need to include a demo of your changes (new features, a bug fix, etc) in a fork of this JSFiddle: https://jsfiddle.net/mattboldt/1xs3LLmL/
-
-To include your branch's version of Typed.js, simply add this JavaScript url as a dependency in JSFiddle, and remove the default:
-
-```
-https://rawgit.com/<YOUR GITHUB USERNAME>/typed.js/<YOUR BRANCH NAME>/lib/typed.min.js
-```
-
-Include a link to the fiddle in the details of your pull request.
-
-Thank you, and happy typing!

package/.github/ISSUE_TEMPLATE.md

@@ -1,27 +0,0 @@
-<!--
-IMPORTANT: If applicable, please use the following format to create a new issue.
-If your issue is not created using the format below, it will be closed.
--->
-
-### Description
-
-[Description of the issue]
-
-### Demo
-[If possible, include a demo of your issue in a fork of this JSFiddle: https://jsfiddle.net/mattboldt/1xs3LLmL/]
-
-### Steps to Reproduce
-
-1. [First Step]
-2. [Second Step]
-3. [and so on...]
-
-**Expected behavior:** [What you expect to happen]
-
-**Actual behavior:** [What actually happens]
-
-**Reproduces how often:** [What percentage of the time does it reproduce?]
-
-### Additional Information
-
-Any additional information, configuration or data that might be necessary to reproduce the issue.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,38 +0,0 @@
-### Requirements
-
-<!--
-Filling out this template is required.
--->
-
- - [ ] Have you viewed your changes locally on the demos page, located on https://github.com/mattboldt/typed.js/blob/master/index.html?
-
- - [ ] If necessary, have you added a new demo to the index.html list of demos? If it's an improvement or small addition, have you added it to an existing demo on the demos page?
-
- - [ ] If applicable, have you created a fork of the following JSFiddle with your branch's code and your new feature showcased?
-
-<!--
-
-    To include your branch's version of Typed.js, simply add this JavaScript url as a dependency in JSFiddle, and remove the default:
-
-    https://jsfiddle.net/mattboldt/1xs3LLmL/
-
-    ```
-    https://rawgit.com/<YOUR GITHUB USERNAME>/typed.js/<YOUR BRANCH NAME>/lib/typed.min.js
-    ```
--->
-
-### Description of the Change
-
-<!--
-
-We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion.
-
--->
-
-### Benefits
-
-<!-- What benefits will be realized by the code change? -->
-
-### Issues
-
-<!-- Enter any applicable Issues here -->

package/.prettierrc

@@ -1,4 +0,0 @@
-{
-  singleQuote: true,
-  arrowParens: "always"
-}

package/.travis.yml

@@ -1,16 +0,0 @@
-language: node_js
-notifications:
-  email:
-    on_success: never
-    on_failure: never
-node_js:
-- '6'
-addons:
-  sauce_connect: true
-env:
-  global:
-before_install:
-  - yarn install
-before_script:
-  - yarn global add gulp
-  - gulp

package/.vscode/launch.json

@@ -1,14 +0,0 @@
-{
-  // Use IntelliSense to learn about possible Node.js debug attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Launch Program",
-      "program": "${file}"
-    }
-  ]
-}