TINKER - Javascript Part II

--- tags: mstu5003, tinker, js --- # TINKER - Javascript Part II :::info Group 2: Ruoxuan（Chloe) Wang, Tian Qing, Kazuki Saito, Weihao Chen. :::  - See demonstration: https://codepen.io/jmk2142/pen/oGxwPQ - Tinker Markdown: https://hackmd.io/zJmA8GKJR5-Oe2Zy4r1wqw?both  ## Devtools You will also want to watch this video on the `console` as we will be using it extensively to Tinker this week. General Video on Console: https://youtu.be/GAqOggzH_GE?list=PLn93-yl6k7zUkSFNI8MQqmIVn017z8vKO One of the most important tools we'll use is the `DEBUGGER`. :::success **Debugger Demonstration and Youtube Video**  CODE: https://codepen.io/jmk2142/pen/RwZErre DEMO: https://cdpn.io/jmk2142/debug/RwZErre YOUTUBE: https://youtu.be/RdF7j4no0Ts ::: I recommend that at some point, you watch these demonstrations and use these tools to explore the Tinker. :::info In order to use `console.dir(object)` and see the object property/values, make sure your console setting is set to DEFAULT. ![](https://i.imgur.com/cmR16Mg.png) ::: ## Tinker GIST: TODOS > Good bye, "Hello World!" `Hello World` is probably the most common introductory program around as it's so simple. ```javascript= alert("Hello World!"); // Or alternatively... console.log("Hello World!"); ``` Unfortunately, it's not very useful. It doesn't really show the range of different programming concepts and to be quite frank, it's boring. Many beginners like us are interested in creating interactive applications and this requires a range of programming concepts. 1. HTML Elements 2. CSS 3. Variables 4. Operators 5. Functions 6. Control Statements 7. Events 8. Data Structures + Data (e.g. Arrays, Objects, Booleans, Numbers, Strings) And you really cant get a sense of how these things work together with a 1 line program like `Hello World!`. ### Enter TODOS Some clever programmer realized this and probably thought: > What's the simplest, _real_ program I can build that will incorporate all the important aspects of a basic interactive program? And the **TODOS** or **TODO LIST** program was born. The beauty of TODOS is that it has everything in a pretty simple package. It can be solved using a variety of different strategies and can be created to be _simpler_ or _more sophsiticated_ depending on ones needs. It tends to now be the defacto standard for demonstrating a full interactive application. Beginners AND advanced students alike build TODO apps as they learn new things. For example, our TODOS Tinker is designed to demonstrate the base JS concepts with a few _stretch_ challenges embedded in it. In my regular practice, when I have to learn a new library or framework, I will probably start by viewing an existing TODO app built with that specific library to see how that library works. Sort of like how you might compare a basic HTML page with a Bootstrap page (of the same content) to be able to compare and contrast the two. If you're interested, you can briefly look at [this page](http://todomvc.com/) which is an archive of the TODO application built in various different frameworks. And this is where I am hoping to take this class, the culmination of all the things we've been working towards - to understanding this first, real, interactive program and hopefully - you can apply some of these concepts in your own works. ## Tinker Tasks In this tinker, were going to: 1. Review prior concepts in this new context: - Variables, functions, events, and arrays 2. Observe, analyze, and study new concepts: - Control statements (E.g. `if`, `for`) - Logical operators (E.g. `===`,`&&`, `||`,`<`,`<=`,`>`,`>=`, etc.) - Objects (and `array` of `objects`) 3. Learn how to use more developer tools to study JS code - Source (i.e. debugger) - Console (i.e. `console.log`, `console.dir`) We will continue to observe, analyze and think about this program in terms of: > What is the STATE? > What is the SEQUENCE? > What is the CAUSALITY? ### Part 0: Conceptual Program Overview Play with the program and observe how it reacts to user interactions. - _Without_ talking about it in _programming terms_ explain the user observable steps/process of the following three interactions and how the program responds. - Adding a todo - Completing a todo - Removing a todo(s) Be specific but imagine you are talking to a _non-programmer_. Think about this in terms of observable actions and reactions. > User puts toast in the toaster. Sets the length of the timer. Pushes the lever to start the toaster. The toast pops out the toaster after the time is completed and goes "DING". - For each of the interactions above write in _pseudocode_ the steps of how the program for that interaction unfold and results. Pseudocode is semi-formal structure to write out the gist of how your program would work. It uses some keywords but is largely language agnostic. There isn't a single correct way to do it but the following are some rules that can help. - RULES: - One statement per line - CAPITALIZE initial _keywords_ - READ, WRITE, IF, ELSE, REPEAT, UNTIL, AND, OR - Indent to show hierarchy and groups of operation - Keep statements language independent ```markdown= # Making toast for a big family READ loaf of bread READ slice of loaf Put slice in toaster WRITE time to toast Start the toaster Cook the toast READ time WRITE time by one second less REPEAT UNTIL time is zero Remove toast REPEAT for all slices in loaf # Serving toast WRITE number of slices total READ number of family members READ toastiness IF toast is burnt AND (total slices >= number of family members) throw away toast decrement slices total ELSE serve toast to family member ``` - Using your pseudocode, identify the function(s) in the actual JS code that relate to your pseudocode. - Compare and contrast your pseudocode with the actual code. - Explain what similarities and differences you noticed about the instructions / steps / processes in the code vs. your psuedocode. - Manipulate different parts of the code as you see fit. Why did you decide to manipulate that part? What happened? (More structured tinkering to follow.) ### Part 1: Variables, Functions, Arrays, and Events - Explain the `data` variable. - What does this data (and the data inside) represent conceptually? >It represents an array of objects. - If I wanted to access the second object, how would I do that in code? >`const value = data[1]` - If I wanted to access the `done` property of the first object, how would I do that? >`data[0].done.` - Look through the rest of the code where this `data` array is used. When the user does things, am I manipulating the visual display and updating the data to reflect those changes? Or am I manipulating the data and updating the visual display to reflect those changes? - Is this what you would have thought of? >Yes, I think we should have thought of what will change and what will not when coding. In this demonstration, it is manipulating the data and updating the visual display because visual display is a fixed pattern while data is constantly changing. - What might be the significance of this program design decision? >It helps save time if there is going to be hundreds of new data added and removed in this program. - What do these lines in my code do? ```javascript= var todosEl = document.querySelector('#todos'); var inputEl = document.querySelector('input'); var completedEl = document.querySelector('#counter'); ``` > They are assigning HTML elements to variables in the JS. - Why declare these (see above) variables at the Global scope instead of in the functions? - Or not at all... (E.g. `document.querySelector('#todos');`) > It is easier to manipulate them in later code in this way. - The `toggleComplete` function has an event parameter. Inside the function I access `event.currentTarget`. What is the difference between `event.currentTarget` and `event.target` which we used previously? - Hint 1: You can add a `console.log(event)` etc. inside that function to test the value of `event.target` and `event.currentTarget`. > When I add the `console.log(event)`, it prints `{"isTrusted": true}`. When I add the `console.log(event.target)`, it prints `i`. When I add the `console.log(event.currentTarget)`, it prints `li`. - Hint 2: When testing, click on a todo to "complete" it. Click on two areas: the `li` as well as the `i` (font icon) element to see the differences. > When a todo is completed, in the `li` , there will be a new class `complete`. Meanwhile, in the `i`, the `fa-circle-0` changes to `fa-check-circle-o`. - Hint 3: You can pass multiple arguments to `console.log()`. I often pass two: first a string label, second the thing I want to log. This will basically make the logs easier to identify if you use `console.log()` a lot. ```javascript= console.log("SOME LABEL: ", dataToLog); ``` >To conclude, `event.target` refers what triggers an event (the checked icon). By contrast, `event.currentTarget` refers to the `li`, which the event listener is listening on. - In the `toggleComplete` function, there is a `event.currentTarget.id`. Is that `id` the same thing as the id property in my todo objects in the `data` array? >When I add `console.log(event.currentTarget.id)`, it prints `task-1497141913701` while the id property in todo objects should be `1497141913701`. So I think they are different. - What does `!something` mean? (The exclamation mark) and how is it used in this code when we `toggleComplete`? > The exclamation mark is a 'not' operator. It is checking whether `todoData.done` is defined and truthy, then returning a reverse value to update `todoData.done`. - Try calling some of the functions directly from the console. Some will work. Some won't. >`toggleComplete()`does not work. In the debug mode, it seems like problems happen in the line `var todoID = parseInt(event.currentTarget.id.replace('task-',''));`. But we do not understand why. - Look at the function declarations in the JS panel. - _Where_ is each function being called? >`updateTodoItems()` is called in `function initializeTodos()` >`updateRemoveBtn()` is called in `updateTodoItems()` - _When_ is each function, actually called? > `removeTodoItem()` is called when the Remove button is clicked. > `onEnterKey(event)` is called when there is a key pressed in the input area. > `addTodoItem()`is called when the Add button is clicked. - What parameter(s) does that function have? >`event` - What is the argument that is passed into the function when it is called? >`if (event.code === "Enter")` - Use the console (in Chrome devtools) to `console.log()` and `console.dir()` the following. What is the difference between `console.log` and `console.dir` and why is `console.dir` kind of more useful for looking at some kinds of data? ```javascript= console.log(data); console.log(todosEl); console.dir(data); console.dir(todosEl); ``` > `console.dir` displays a series of properties of an object, including those with null value, while `console.log()` only shows the content clarified in the code. In this way, `console.dir` is more useful for looking at whole data, especially those undefined. ### Part 2: Objects and Arrays of Objects - Manipulate the different _properties_ of the _objects_ inside the `data` array. - Change all todo objects' `done` property to `true`. - Change some of the task values. - Run your code and explain how this changes what you see and why. - `console.dir()` the `data` array. Goto the console and _OPEN_ the `> Array(3)` text by clicking on it. Go deeper by opening up the nested objects. Analyze what you see. Then add a new todo through the user interface. `console.dir()` the `data` array again and investigate the insides. - What is the difference between `data` before and after adding a new todo? ```markdown= - Array(3) 0: {id: 1497141891479, task: 'Wake up', done: false} 1: {id: 1497141913701, task: 'Eat breakfast', done: false} 2: {id: 1497141937545, task: 'Learn code', done: true} - Array(4) 0: {id: 1497141891479, task: 'Wake up', done: false} 1: {id: 1497141913701, task: 'Eat breakfast', done: false} 2: {id: 1497141937545, task: 'Learn code', done: true} 3: {id: 1670364903879, task: 'Go to school', done: false}``` >[color=blue]The above lines illustrate the difference between before and after adding a new todo. After adding a new todo, this one will also be included in the `data`. - Run the following code: ```javascript= data.push({ done: true, task: "Goto Aikido Lessons", id: getTimeStamp() }); console.dir(data); ``` - What did the code above do? > [color=blue]The above code represents that an additional content (property: done, task, id) is adding to the last content of the `data` array. - Does our page reflect the changes made? Why or why not? Prove it. > [color=blue]The page will not reflect this change because the function which controls showing todo list is different. If `updateToDoItems()` is also called in the console screen, the page will reflect it. - Does order matter in `Objects`? > [color=blue]Each content of `data` is shown because of the result of `for` loop. The `for` loop will execute from the beginning, so order is a significant factor. - What is the difference between `Object` keys (E.g. `done`, `task`, `id`) and `Array` indices (E.g. `0`, `1`, `2`)? - How are they similar? ```javascript= var myAry = [123, "Code", true]; var myObj = { id: 123, task: "Code", done: true } console.log(myAry[1]); console.log(myObj["task"]); console.log(myObj.task); ``` > [color=blue]Although `Array` indices can only use information of the order of the array, `Object` keys can identify specific contents by the name of property (keys). Therefore, `Object` keys are sometimes useful for searching for the data including plenty of items. - Compare the following in the console: ```javascript= var element = document.querySelector('ul'); var author = { first: "Mark", last: "Twain" } var example = { theAnswer: 42, student: true, hobby: "Fishing", sayHello: function(){ alert("Hello"); }, favNums: [1,2,3], favAuthor: author }; console.dir(example); console.dir(element); ``` - What is an `element` really? > [color=blue]An element describes whole information of `ul` , such as `id`, `offset`, and `style`. - How does our `element` relate in terms of similarities and differences to `example`? > [color=blue]Both of them include the whole containing property. However, `example` has properties only definined in the Javascript. - If I wanted to call the function in the `example` object, how would I do that? Prove it. > [color=blue]The second line of the below codes illustrates the way to call the function. The value of `Objects` should represent function. ```javascript= var example = { theAnswer: updateTodoItems(), student: true, hobby: "Fishing", sayHello: function(){ alert("Hello"); }, favNums: [1,2,3], favAuthor: author }; ``` - Try the following code in the console. How does dot notation and bracket notation differ and why would you want to use one or the other? ```javascript= var x = "username"; var user = { username: "happyCat" } console.log(user.username); console.log(user["username"]); console.log(user[x]); console.log(user.x); ``` > [color=blue]The above three codes, `console.log(user.username)`, `console.log(user["username"]`, and `console.log(user[x]` give us the same result (happyCat). On the other hand, the final line (`console.log(user.x)`) cannot find any values.The difference is associated with the "double quation mark". If you use dot notation, "double quation mark" should not be used. - Identify various areas where the `.` object notation is used and explain the thing on the left side of the `.` and the thing on the right side of the `.` - E.g. `document.querySelector()` `document` is... `querySelector` is... - HINT: There are MANY choices here. > [color=blue]The dot notation should be used when you want to specify the inner property of variables. - In two areas of my code, I use what is called a `filter` function. It's a function that arrays can use like `list.pop()`, `list.push()`. - How does a filter function work? > [color=blue]The filter function will work when you would like to pick up specific contents in the array. - What is the significance of the function argument that is passed INTO the filter parameters? > [color=blue]This fuction will allow us to store the original array, and just copy the filtered element. It is beneficial especially for the situation that the way of filtering includes something wrong. - With regard to the function that is passed into the filter as an argument, that function must `return` a boolean or evaluate to a boolean. What is the purpose of this? > [color=blue]This aspect contributes us to discriminate whether specific variables and contents are filtered or not. - What does the _filter function_ return? E.g. `var x = list.filter(...); // What was returned to x?` - CAUTION: NOT the function argument that goes into the filter. - HINT: If you don't know, can you use console to "test" an idea out? > [color=blue]the returned result illustrates filtered variables or objects. - Does filtering an array _change_ the original array? > [color=blue]There is no alternation to the original array even if filter function is utilized. ### Part 3 Control Structures - I use the `if` statement in several places in this code. Explain why a conditional is necessary in: - `updateTodoItems` - `updateRemoveButton` - `onEnterKey` - `validateTask` - `addTodoItem` - `getTodoData` - HINT: You might want to `console.log` the boolean condition where you see the `if` statements to understand what condition we are evaluating. ```javascript= if (booleanCondition) { ... } console.log(booleanCondition); ``` - Comment on how the boolean condition works as there are many different examples. - In this code, there are two kinds of `for` loops. The more traditional that looks like: ```javascript= for (var i=0; i < list.length; i++) { // CODE } ``` and a `for of` loop that looks like: ```javascript= for (item of list) { // CODE } ``` - How does a `for of` loop work? - > [color=blue] `for of` loop can make you loop over data structures that are iterable such as arrays, strings, maps, sets and others. - What does the `item` represent? (It can be named anything: `x`, `item`, `thing` etc.) - > [color=blue] it can be named as anything because it is a previously declared variable or an object property. - Why are `for of` loops convenient compared to the traditional `for`? - > [color=blue] `for of`loops are convenient because they allow you to iterate over any iterable object. This means that you can use them to loop over arrays, strings, maps, sets, and more. They also allow you to easily access the `index` of an item in an array or string, even though you're not using a `for loop`. - For what purpose(s) do I employ a `for` or `for of` loop in this program? - > [color=blue] A `for` loop is used to iterate over an array, while a `for of` loop is used to iterate over an object. - On Facebook or Pinterest, or Twitter, how does a loop through data relate to the display of content? - > [color=blue] In the case of Facebook, Twitter, and Pinterest, they are using loops to go through each item in an array and display it on the page. For example, if you have a list of friends on Facebook, they are using a loop to display each friend's name and profile picture. If you have a list of tweets on Twitter, they are using a loop to display each tweet. ### Part 3 Specific Routines - Take a look at the `updateTodoItems`. Comment it out and replace it with this alternate, but functionally identical version. How does this function work and how do they relate / differ? ```javscript= function updateTodoItems() { todosEl.innerHTML = ""; if (!data.length) { var liElement = document.createElement('li'); liElement.innerText = "Nothing todo..."; todosEl.appendChild(liElement); } else { for (todo of data) { var liElement = document.createElement('li'); var iElement = document.createElement('i'); liElement.id = todo.id; liElement.onclick = toggleComplete; if (todo.done) { liElement.className = "complete"; iElement.className = "fa fa-check-circle-o"; } else { iElement.className = "fa fa-circle-o"; } liElement.appendChild(iElement); liElement.innerText = todo.task; todosEl.appendChild(liElement); } } updateRemoveBtn(); } ``` - Take a look at the helper function `getTimeStamp`. This function will return a number, in milliseconds, the current time stamp since January 1, 1970. - I call this when I create new todo items, what are some ideas as to why I might be using a timestamp for todo `ids`? - > [color=blue] A timestamp is a unique identifier, so it's a good way to make sure that each todo item has a unique id. - Take a look at the incomplete functions `markAllComplete` and `updateItemsLeft`. - Can you complete these and add the functionality to this app? ### Part 4 Debugging, Tools Using the Chrome debugger (source) tool create breakpoints and watch the program execute line by line, part by part. Experience how this tool can give you insight into your program's _STATE_, _SEQUENCE_, _CAUSALITY_. #### Chrome Debugger - Set breakpoints at the following locations of your program - `function initializeTodos` - `function onEnterKey` - `function addTodoItem` - `function toggleComplete` - Use the `Step over the next function call` feature to watch how the program pauses during the _SEQUENCE_ of its routines. - Use the `Step into the next function call` feature to watch how the program pauses during the _SEQUENCE_ of its routines. - What is the difference between `Step over` and `Step into` and how does this help you understand programs? >`Step over` basically takes us jump to the funtion call. It will not show up each step within the function. While `Step into` takes us to check each line of the function step by step in a detailed way. - Use `Step into` until you've reached the line `var inputEl = document.querySelector('input');`. Should be highlighted in blue. - Highlight the variable `todosEl` on the line before it and `right click` on it. Select _Evaluate in console_. - What does the console print? > The console prints undefined. - Highlight the variable `inputEl` on this highlighted blue line. - Why does the console say `inputEl` is undefined? >InputEl we think is standing for the place to cache the data. We assume it may be caused because we haven't executed on that line. - When you step through your code, does the blue line represent code that is about to be executed or code that has already executed? How do you know? >We believe the blue line represent code that is about to be executed. It is because the change will only show when the debugger pass that step. - What do you predict would be the console value of the variable `completedEl` on the next line if you _Evaluate to console_ at this point? >We assume the Evaluate to console at this point will still remind undefined. - Watch how debugger annotates your source code with the updated _state_ of different variables as your program progresses. - How does the debugger behave when you enter a loop in your program? >We think there will be an equation contains properties when we pause at each step. And we believe those on an orange background-color box are annotations. - How does the debugger behave when you reach the a `filter` function call? > It prints todo: {id: 1497141891479, task: 'Wake up', done: false} - What does filter do and how does it work? > The filter will check twice the to do tasks. If the task isn't done, it will print false, vice versa. ### Part X: Putting all together **Explain the program line by line with sufficient details, part by part.** :::success - Line by line - Part by part - Be sure to copy blocks of code into this markdown using code formatting/fences as references to your explanations. - For repetitive code, you can explain how a line works then summarize how it would work for the rest. ::: **Make it yours (group's)** :::success - Try to extend this program to do something cool, as a group, your own original idea(s). - What is something that a Todo list or todo list user might benefit from? :::

Syntax	Example	Reference
# Header	Header	基本排版
- Unordered List	Unordered List
1. Ordered List	Ordered List
- [ ] Todo List	Todo List
> Blockquote	Blockquote
Bold font	Bold font
Italics font	Italics font
~~Strikethrough~~	~~Strikethrough~~
19^th^	19^th
H~2~O	H₂O
++Inserted text++	Inserted text
==Marked text==	Marked text
[link text](https:// "title")	Link
![image alt](https:// "title")	Image
`Code`	`Code`	在筆記中貼入程式碼
```javascript var i = 0; ```	`var i = 0;`
:smile:		Emoji list
{%youtube youtube_id %}	Externals
$L^aT_eX$	L^aT_eX
:::info This is a alert area. :::	This is a alert area.