GithubHelp home page GithubHelp logo

williamtroup / typey.js Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 107 KB

A lightweight JavaScript library for printing text using a typewriter effect.

Home Page: https://william-troup.com/typey-js

License: MIT License

Shell 0.76% JavaScript 79.29% CSS 4.65% HTML 15.30%
css html typewriter typing

typey.js's Introduction

Typey.js

Tweet npm nuget license discussions Welcome coded by William Troup

A lightweight JavaScript library for printing text using a typewriter effect.

v0.1.0


Heat.js

What features does Typey.js have?

  • Zero-dependencies and extremely lightweight!
  • Full API available via public functions.
  • Fully configurable!
  • Fully configurable per element!
  • Typewriter effects allow you to type and delete.
  • Repeat always, or any number of times.


What browsers are supported?

All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.

What are the most recent changes?

To see a list of all the most recent changes, click here.

How do I get started?

To get started using Typey.js, do the following steps:

1. Prerequisites:

Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:

<!DOCTYPE html>

2. Include Files:

<script src="dist/typey.js"></script>

3. DOM Element Binding:

<div data-typey-options="{ 'speed': 100 }">
    <p>This is some example text that should be typed out.</p>
</div>

To see a list of all the available binding options you can use for "data-typey-options" click here.

To see a list of all the available custom triggers you can use for "data-typey-options" click here.


4. Finishing Up:

That's it! Nice and simple. Please refer to the code if you need more help (fully documented).

How do I go about customizing Typey.js?

To customize, and get more out of Typey.js, please read through the following documentation.

1. Public Functions:

To see a list of all the public functions available, click here.

2. Configuration:

Configuration options allow you to customize how Typey.js will function. You can set them as follows:

<script> 
  $typey.setConfiguration( {
      safeMode: false
  } );
</script>

To see a list of all the available configuration options you can use, click here.

typey.js's People

Contributors

williamtroup avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.