Add the option to set the characters to use when scrambled

(#1)
sogoagain · Jan 15, 2022 · 6612ee9 · 6612ee9
1 parent c097a50
commit 6612ee9
Show file tree

Hide file tree

Showing 7 changed files with 15,920 additions and 6,281 deletions.
diff --git a/README.md b/README.md
@@ -55,6 +55,15 @@ const handleScramble = (text) => {
 
 // call scramble function with the text to be scrambled and handler.
 scrambler.scramble('- Friedrich Nietzsche -', handleScramble);
+
+// call scramble with the option to set the characters to use when scrambled.
+scrambler.scramble(text, handleScramble, {
+  charactersToUseWhenScrambling: ['a', 'b', 'c'],
+});
+
+// Scrambler provides several characters.
+console.log(Scrambler.CHARACTERS.DEFAULT);
+console.log(Scrambler.CHARACTERS.ALPHABET);
 ```
 
 ### React Example

diff --git a/examples/index.html b/examples/index.html
@@ -1,39 +1,58 @@
 <!DOCTYPE html>
 <html>
-  <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@300&display=swap" rel="stylesheet">
-    <style>
-      body {font-family: 'Roboto Mono', monospace; letter-spacing: 5px;}
-      #container {display: flex; flex-direction: column; justify-content: center; text-align: center;}
-    </style>
-    <title>Scrambling Text Example</title>
-  </head>
-  <body>
-    <div id="container">
-      <h1 id="text"></h1>
-    </div>
-    <script src="./scrambling-text.js"></script>
-    <script>
-      const TEXTS = [
-        '- Friedrich Nietzsche -',
-        'The doer alone learneth.',
-        'There are no facts, only interpretations.',
-      ];
 
-      const scrambler = new window.Scrambler();
-      const handleScramble = (text) => {
-        document.getElementById('text').innerHTML = text;
-      }
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:wght@300&display=swap" rel="stylesheet">
+  <style>
+    body {
+      font-family: 'Roboto Mono', monospace;
+      letter-spacing: 5px;
+    }
+
+    #container {
+      display: flex;
+      flex-direction: column;
+      justify-content: center;
+      text-align: center;
+    }
+  </style>
+  <title>Scrambling Text Example</title>
+</head>
+
+<body>
+  <div id="container">
+    <h1 id="text"></h1>
+  </div>
+  <script src="./scrambling-text.js"></script>
+  <script>
+    const TEXTS = [
+      '- Friedrich Nietzsche -',
+      'The doer alone learneth.',
+      'There are no facts, only interpretations.',
+    ];
 
-      let i = 0;
-      function printText() {
-        scrambler.scramble(TEXTS[i % TEXTS.length], handleScramble); 
-        setTimeout(printText, 5000);
-        i++;
+    const scrambler = new window.Scrambler();
+    const handleScramble = (text) => {
+      document.getElementById('text').innerHTML = text;
+    }
+
+    let i = 0;
+    function printText() {
+      const targetText = TEXTS[i % TEXTS.length];
+      if (i == 2) {
+        scrambler.scramble(targetText, handleScramble, {
+          charactersToUseWhenScrambling: Scrambler.CHARACTERS.ALPHABET,
+        });
+      } else {
+        scrambler.scramble(targetText, handleScramble);
       }
-      printText();
-    </script>
-  </body>
+      setTimeout(printText, 5000);
+      i++;
+    }
+    printText();
+  </script>
+</body>
+
 </html>
diff --git a/examples/scrambling-text.js b/examples/scrambling-text.js