Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.4 KB

README.md

File metadata and controls

61 lines (39 loc) · 1.4 KB

Wordle Clone

🚧 Documentation under construction

Demo

Visit the demo to see the wordle clone in action.

Features

  • A new word every day
  • Responsive design
  • Mobile friendly
  • Virtual Keyboard

API

createKeyboard()

It returns a keyboard instance.

const $keyboard = createKeyboard();

$keyboard.disable()

Disable the virtual keyboard and turn off every keyboard event.

$keyboard.disable();

$keyboard.on(type, callback)

A keyboard event listener.

$keyboard.on('key', key => console.log('Pressed key: ', key));
Parameter Type Description Required
type string Type of the event Yes
callback function A callback called when the event is trigged Yes

$keyboard.keys(keys)

It receives an array of keys and returns the interface to manage them on the virtual keyboard.

const $keys = $keyboard.keys(['h', 'o', 'u', 's', 'e']);
Parameter Type Description Required
keys string[] A list of letters Yes

Author

Made with ❤️ by Ricky Almeida