DOCS.md

DOCS

• classes
  • Break.js
  • Colors.js
  • CountDown.js
  • Ico.js
• handlers
  • clickDown.js
  • longBreakHandler.js
  • pomBreakHandler.js
  • sendClick.js
  • shortBreakHandler.js
  • startCounterHandler.js
• init
  • index.js
• listeners
  • longBreak.js
  • pomodoroBreak.js
  • shortBreak.js
  • startCounter.js
• data.js

---

Classes and their tests

---

./src/classes/Break.js

---

./src/classes/Colors.js

---

./src/classes/CountDown.js

---

./src/classes/Ico.js

TOP

---

---

Handlers

Handler function define user interactions. They will:

• read user input from events and from the DOM
• read and modify program data variables
• process user data with logic functions
• update the DOM to show changes to the user
• log any important information for developers

---

./src/handlers/clickDown.js

moveText(btn)

moves 4px down the css element

Param	Type	Description
btn	string	a css selector

---

./src/handlers/longBreakHandler.js

longBreak()

handles a pomodoro break (15 minutes)

---

./src/handlers/pomBreakHandler.js

pomBreak()

handles a pomodoro break (25 minutes)

---

./src/handlers/sendClick.js

setColor(btn)

sets the style for the 3 break-buttons (pomodoro, short and long)

Param	Type	Description
btn	string	a css selector

---

./src/handlers/shortBreakHandler.js

shortBreak()

handles a pomodoro break (5 minutes)

---

./src/handlers/startCounterHandler.js

Functions

start()

start/stop button toggle

loadMp3()

loads an audio file

start()

start/stop button toggle

loadMp3()

loads an audio file

TOP

---

---

init

---

./src/init/index.js

TOP

---

---

Listeners

Event listeners are used to connect handler functions to user interactions with the DOM.

You can use the same handler in many different listeners, or add more than one listeners to the same DOM element.

---

./src/listeners/longBreak.js

---

./src/listeners/pomodoroBreak.js

---

./src/listeners/shortBreak.js

---

./src/listeners/startCounter.js

TOP

---

---

./src/data.js