Giter VIP home page Giter VIP logo

typeme.js's Introduction

TypeMe.js

TypeMe.js is a super simple type writer effect using web components. Look at this simple demo to see it in action.

Installation

⬆️ Top

Using a CDN

<script src="https://unpkg.com/typemejs@latest/dist/typeme.min.js" async></script>

Import with yarn or npm

NPM

npm install typemejs --save

Usage

⬆️ Top

Using this library is simple. Anywhere in your code call this HTML tag <type-me></type-me>. Don't forget to look at the simple demo.

Options

This plugin is configured with data attributes.

Attribute data- Default Description
words shorts, on, words Words to be typed separated by a comma
duration 250 Duration in ms between each characters
pause 1000 Pause in ms between words
shuffle - Shuffle words
cursor-speed 250 Cursor speed in ms

This is an example with all options:

<type-me data-words="one, two, three" 
         data-duration="125" 
         data-pause="1000"
         data-cursor-speed="300"
         data-shuffle></type-me>

Styling

This is a custom web element so you can bring your own CSS. You should know that the element has some CSS classes:

  • .typeme for the wrapper
  • .typeme-text for the words
  • .typeme-cursor for the cusor

Licence

⬆️ Top

MIT

typeme.js's People

Contributors

marceauka avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  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.