1.0.2 • Published 3 years ago

text-typer-ext-sound v1.0.2

Weekly downloads
5
License
ISC
Repository
github
Last release
3 years ago

⌨️ Text Typer Extension - Typing Sounds ⌨️

Enchance the typing with keyboard sound effects. Extension of TextTyper

Credit

Credit Sound Effects to Here

Links

Usage

Simply put the extension script tag under the core module's. Like so:

<script src='https://unpkg.com/text-typers@latest/build/bundle.js'></script>
<script src='https://unpkg.com/text-typer-ext-sound@latest/dist/cursor_ext_sound.js'></script>

Example

//  Use Normally
tt.soundSettings({
    typeSound: TextTyper.SOUND_CHERRY_BLUE,
    delSound: TextTyper.SOUND_CHERRY_BLACK,
    typeVolume: 0.8,
    delVolume: 0.6
});

const eq = tt.eventQueue();

//  Chain method
eq.soundSettings({
    typeSound: TextTyper.SOUND_CHERRY_BLUE
}).typeText("Hello").start();

Settings

With this extension, it adds a new soundSettings method to both TextTyper object and CursorEventQueue object. So it can be used in chaining methods, or called normally before setting up event chains.

It takes in a SoundSettings Javascript object:

{ typeSound, delSound, typeVolume, delVolume }
PropertyDescription
typeSound (optional)A string constant. Sound Effect when typing characters. Explained in Setting Constants
delSound (optional)A string constant. Sound Effect when deleting characters. Explained in Setting Constants
typeVolume (optional)Number from 0 to 1. Volume of typing sound
delVolume (optional)Number from 0 to 1. Volume of deleting sound

Setting Constants

  • TextTyper.SOUND_CHERRY_BLACK
  • TextTyper.SOUND_CHERRY_BLUE
  • TextTyper.SOUND_CHERRY_BROWN
  • TextTyper.SOUND_CHERRY_CLEAR
  • TextTyper.SOUND_CHERRY_GREEN
  • TextTyper.SOUND_CHERRY_GREY
  • TextTyper.SOUND_CHERRY_RED
  • TextTyper.SOUND_CHERRY_WHITE