Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.27 KB

README.md

File metadata and controls

48 lines (38 loc) · 1.27 KB

olum-writer

OlumWriter is a lightweight and flexible library for adding an amazing writing effect to your web apps, written in vanilla js

npm npm npm

Documentation

CDN

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Olum Writer</title>
  </head>

  <body>
    <div id="writer"></div>

    <script src="https://unpkg.com/olum-writer@latest/dist/olum-writer.min.js"></script>
    <script>
      new OlumWriter({
        container: document.getElementById("writer"),
        sentences: ["content one", "content two", "content three"],
        interval: 3000, // optional (time between each sentence)
        speed: 1000, // optional (speed of writing each sentence)
        reverse: false, // optional (enable/disable backward writing), default is false
      });
    </script>
  </body>
</html>

ES6 Module

import OlumWriter from "olum-writer";

new OlumWriter({
  container: document.getElementById("writer"),
  sentences: ["content one", "content two", "content three"],
});