-
Notifications
You must be signed in to change notification settings - Fork 32
/
dynamic.tex
575 lines (486 loc) · 19.3 KB
/
dynamic.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
\chapter{Dynamic Pages}\label{s:dynamic}
In the beginning,
people created HTML pages by typing them in (just as we have been doing).
They quickly realized that a lot of pages share a lot of content:
navigation menus, contact info, and so on.
The nearly universal response was to create a \grefdex{g:template}{template}{template (HTML)}\index{HTML template}
and embed commands to include other snippets of HTML (like headers)
and loop over data structures to create lists and tables.
This is called \gref{g:server-page-gen}{server-side page generation}:
the HTML is generated on the \gref{g:server}{server},
and it was popular because that's where the data was,
and that was the only place complex code could be run.
(This tutorial uses a templating tool called \hreffoot{https://jekyllrb.com/}{Jekyll}.
It's clumsy and limited, but it's the default on \hreffoot{http://github.com/}{GitHub}.)
Server-side generation can be done statically or dynamically,
i.e.,
pages can be compiled once, stored on disk, and served thereafter,
or each page can be recompiled whenever it's needed,
which makes it easy to include dynamic elements like today's top news story
(\figref{f:dynamic-alternatives}).
\figpdf{figures/dynamic-alternatives.pdf}{Page Generation Alternatives}{f:dynamic-alternatives}
As browsers and JavaScript became more powerful,
the balance shifted toward \gref{g:client-page-gen}{client-side page generation}.
In this model,
the browser fetches data from one or more servers
and feeds that data to a JavaScript library that generates HTML in the browser for display.
This allows the \gref{g:client}{client} to decide how best to render data,
which is increasingly important as phones and tablets take over
from desktop and laptop computers.
It also moves the computational burden off the server
and onto the client device,
which lowers the cost of providing data.
Many (many) JavaScript frameworks for client-side page generation have been created,
and more are probably being developed right now.
We have chosen \hreffoot{https://reactjs.org/}{React}\index{React} because it is freely available,
widely used,
well documented,
simpler than many alternatives,
and has a cool logo.
Its central design principles are:
\begin{enumerate}
\item
Page creators use functions to describe the HTML they want.
\item
They then let React decide which functions to run when data changes.
\end{enumerate}
We will show how to use it in pure JavaScript,
then introduce a tool called JSX that simplifies things.
\section{Hello, World}\label{s:dynamic-hello}
Let's begin by saying hello:
\begin{minted}{jsx}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello React</title>
<script src="https://fb.me/react-15.0.1.js"></script>
<script src="https://fb.me/react-dom-15.0.1.js"></script>
</head>
<body>
<div id="app">
<!-- this is filled in -->
</div>
<script>
ReactDOM.render(
React.DOM.h1(null, "Hello React"),
document.getElementById("app")
)
</script>
</body>
</html>
\end{minted}
The \texttt{head} of the page loads two React libraries from the web;
we will use locally-installed libraries later.
The \texttt{body} contains a \texttt{div} with an ID to make it findable.
When our script runs,
React will put the HTML it generates into this \texttt{div}.
The script itself creates an \texttt{h1} with the text ``Hello, React'' using \texttt{React.DOM.h1},
then finds the document element whose ID is \texttt{"app"}
and uses \texttt{ReactDOM.render} to insert the former into the latter.
This alters the representation of the page in memory,
not the source of the page on disk;
if we want to inspect the resulting HTML,
we have to do so in the browser.
Finally,
we put the script at the bottom of the page
so that the browser will have turned the HTML into a DOM tree in memory
before the script runs.
We will come back and fix this later.
\begin{aside}{Inspection Tools}
If you are using the Firefox browser,\index{developer tools}
you can open the developer tools pane by going to the main menu
and selecting \texttt{Tools{\ldots}\ Web\ Developer{\ldots}\ Toggle\ Tools}.
A tabbed display will open in the bottom of your page;
choose \texttt{Inspector} to view the content of your page and page's CSS.
As you move your mouse around the page itself,
corresponding structural elements will be highlighted.
It's actually pretty cool{\ldots}
\end{aside}
The first parameter to \texttt{React.DOM.h1} is \texttt{null} in the example above,
but it can more generally be an object that specifies
the attributes we want the newly-created node to have.
There are a few quirks in this---for example,
we have to use \texttt{fontStyle} rather than \texttt{font-style}
so that the attribute object's keys look like legal JavaScript variables---but
the mechanism is seductively easy to use:
\begin{minted}{jsx}
<body>
<div id="app"></div>
<script>
const attributes = {
'style': {
'background': 'pink',
'fontStyle': 'italic'
}
}
ReactDOM.render(
React.DOM.h1(attributes, "Hello Stylish"),
document.getElementById("app")
)
</script>
</body>
\end{minted}
\section{JSX}\label{s:dynamic-jsx}
Writing nested functions is a clumsy way to write HTML,
so most React programmers use a tool called \hreffoot{https://reactjs.org/docs/introducing-jsx.html}{JSX}\index{JSX}
that translates HTML into JavaScript function calls.
And yes,
those JavaScript function calls then produce HTML---it's a funny world.
Here's an example:
\begin{minted}{jsx}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello JSX</title>
<script src="https://fb.me/react-15.0.1.js"></script>
<script src="https://fb.me/react-dom-15.0.1.js"></script>
<script src="https://unpkg.com/babel-standalone@6/babel.js"></script>
</head>
<body>
<div id="app"></div>
<script type="text/babel">
ReactDOM.render(
<h1>Hello JSX</h1>,
document.getElementById('app')
)
</script>
</body>
</html>
\end{minted}
Along with the two React libraries,
this page includes a tool called \hreffoot{https://babeljs.io/}{Babel}\index{Babel}
to translate a mix of HTML and JavaScript into pure JavaScript.
To trigger translation,
we add the attribute \texttt{type="text/babel"} to the \texttt{script} tag.
Why bother?
Because as the example above shows,
it allows us to write \texttt{\htmltag{h1}Hello\ JSX\htmltag{/h1}} instead of calling a function.
More generally,
JSX lets us put JavaScript inside our HTML (inside our JavaScript (inside our HTML)),
so we can (for example) use \texttt{map} to turn a list of strings into an HTML list:
\begin{minted}{jsx}
<body>
<h1>JSX List</h1>
<div id="app"></div>
<script type="text/babel">
const allNames = ['McNulty', 'Jennings', 'Snyder',
'Meltzer', 'Bilas', 'Lichterman']
ReactDOM.render(
<ul>{allNames.map((name) => <li>{name}</li> )}</ul>,
document.getElementById('app')
)
</script>
</body>
\end{minted}
We have to use \texttt{map} rather than a loop because whatever code we run has to return something
that can be inserted into the DOM,
and \texttt{for} loops don't return anything.
(We could use a loop to build up a string through repeated concatenation,
but \texttt{map} is cleaner.)
And note: we must return exactly one node,
because this is one function call.
We will look in the exercises at why the curly braces immediately inside the \texttt{\htmltag{ul}} element are necessary.
Note also that when we run this,
the browser console will warn us that each list element ought to have a unique \texttt{key} property,
because React wants each element of the page to be selectable.
We will add this later.
\section{Creating Components}\label{s:dynamic-components}
One of the most powerful features of React is that it lets us create
new \grefdex{g:component}{components}{React!component}\index{component (in React)}
that look like custom HTML tags,
but are associated with functions that we write.
React requires the names of these components to start with a capital letter
to differentiate them from regular tags.
We can,
for example,
define a function \texttt{ListOfNames} to generate our list of names,
then put that element directly in \texttt{ReactDOM.Render}
just as we would put an \texttt{h1} or \texttt{p}:
\begin{minted}{jsx}
<body>
<h1>Create Component</h1>
<div id="app"></div>
<script type="text/babel">
const allNames = ['McNulty', 'Jennings', 'Snyder',
'Meltzer', 'Bilas', 'Lichterman']
const ListOfNames = () => {
return (<ul>{allNames.map((name) => <li>{name}</li> )}</ul>)
}
ReactDOM.render(
<ListOfNames />,
document.getElementById('app')
)
</script>
</body>
\end{minted}
What we really want to do,
though,
is pass parameters to these components:
after all,
JSX is turning them into functions,
and functions are far more useful when we can give them data.
In React,
all the attributes we put inside the component's tag
are passed to our function in
a single \texttt{props} object:\index{React!parameter}\index{React!\texttt{props} object}\index{parameter!React}
\begin{minted}{jsx}
<body>
<h1>Pass Parameters</h1>
<div id="app"></div>
<script type="text/babel">
const allNames = ['McNulty', 'Jennings', 'Snyder',
'Meltzer', 'Bilas', 'Lichterman']
const ListElement = (props) =>
(<li id={props.name}><em>{props.name}</em></li>)
ReactDOM.render(
<ul>{allNames.map((name) => <ListElement name={name} /> )}</ul>,
document.getElementById('app')
)
</script>
</body>
\end{minted}
If you look carefully,
you'll see that the \texttt{name} attribute passed to the use of \texttt{ListElement}
becomes the value of \texttt{prop.names} inside the function that implements \texttt{ListElement}.
Before we \texttt{map} each component of our array within \texttt{ReactDOM.render}
as in the examples above, the \texttt{ListElement} function gives us exactly one logical place to set attributes.
Here we've used \texttt{ListElement} to italicize each element in our array and give them ids,
but these functions can also be used for any transformation or calculation on each element to be rendered.
\section{Developing with Parcel}\label{s:dynamic-parcel}
Putting all of the source for an application in one HTML file is a bad practice,
but we've already seen the race conditions that can arise when we load JavaScript in a page's header.
And what about \texttt{require} statements?
The browser will try to load the required files when those statements run,
but who is going to serve them?
The solution is to use a \gref{g:bundler}{bundler} (\figref{f:dynamic-parcel})
to combine everything into one big file,
and to run a \gref{g:local-server}{local server} to preview our application during development.
However,
this solution brings with it another problem:
which bundler to choose?
As with front-end frameworks,
there are many to choose from,
and new ones are being added almost weekly.
\hreffoot{https://webpack.js.org/}{Webpack}\index{Webpack} is probably the most widely used,
but it is rather complex,
so we will use \hreffoot{https://parceljs.org/}{Parcel},\index{Parcel}
which is younger and therefore not yet bloated
(but give it time).
\begin{aside}{Initiate a Project with Node Package Manager}
If you've been coding along,
so far we've created single HTML and JavaScript files,
and we've used the Node command to run JavaScript files in the terminal,
but we have not yet used the Node Package Manager \texttt{npm}.
Before we install Parcel,
we can turn the directory
which we've been creating our HTML and JavaScript files into a project
by typing:
\begin{minted}{shell}
$ npm init -y
\end{minted}
\end{aside}
To install Parcel, run:
\begin{minted}{shell}
$ npm install parcel-bundler
\end{minted}
\noindent
Once Parcel is installed,
we can tell it to run one of our test pages like this:
\begin{minted}{shell}
$ node_modules/.bin/parcel serve -p 4000 src/dynamic/pass-params.html
\end{minted}
\begin{minted}{text}
Server running at http://localhost:4000
+ Built in 128ms.
\end{minted}
\begin{aside}{Quitting Parcel}
To leave Parcel use the keyboard interrupt Control-C.
\end{aside}
This works because when NPM installs a library in a project's \texttt{node\_modules} directory,
that library may put a runnable script in \texttt{node\_modules/.bin}
(note that it's \texttt{.bin} with a leading \texttt{.}, not \texttt{bin}).
When we ask Parcel to serve an application, it:
\begin{itemize}
\item
looks in the named file to find JavaScript,
\item
looks recursively at what that file loads,
\item
copies some files into a directory called \texttt{./dist} (which stands for ``distribution''), and
\item
serves the application out of there.
\end{itemize}
Parcel also caches things in \texttt{./.cache} so that it doesn't need to do redundant work;
both directories are normally added to \texttt{.gitignore}.
To learn more about Parcel,
see \hreffoot{https://medium.com/codingthesmartway-com-blog/getting-started-with-parcel-197eb85a2c8c}{this short tutorial}.
\figpdf{figures/dynamic-parcel.pdf}{What Goes Where with Parcel}{f:dynamic-parcel}
It's very common to put tasks like ``run my application''
into NPM's \texttt{package.json} file,\index{package.json@\texttt{package.json}}
just as older programmers would put frequently-used commands into a project's Makefile.
Look for the section in \texttt{package.json} whose key is \texttt{"scripts"} and add this:
\begin{minted}{js}
"scripts": {
"dev": "parcel serve -p 4000",
...
},
\end{minted}
We can now use \texttt{npm\ run\ dev\ -\/-\ src/dynamic/pass-params.html},
since everything after \texttt{-\/-} is passed to the script being run.
This doesn't just save us typing;
it also gives other developers a record of how to use the project.
Unfortunately,
there is no standard way to add comments to a JSON file{\ldots}
\begin{aside}{Whoops}
Note:
if we accidentally specify the name of a directory like \texttt{src/dynamic}
instead of the name of an HTML file,
Parcel prints an error on the console saying ``no entries found''.
This happens because it is trying to read the directory itself as a file.
\end{aside}
\section{Multiple Files}\label{s:dynamic-multiple}
Now that we can bundle things up,
let's move our JSX into \texttt{app.js} and load that in the \texttt{head} of the page:
\begin{minted}{jsx}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello Separate</title>
<script src="https://fb.me/react-15.0.1.js"></script>
<script src="https://fb.me/react-dom-15.0.1.js"></script>
<script src="https://unpkg.com/babel-standalone@6/babel.js"></script>
<script src="app.js" type="text/babel"></script>
</head>
<body>
<h1>Hello Separate</h1>
<div id="app"></div>
</body>
</html>
\end{minted}
\noindent
For now,
the JavaScript in \texttt{app.js} is:
\begin{minted}{js}
ReactDOM.render(
<p>Rendered by React</p>,
document.getElementById("app")
)
\end{minted}
When we load this page we get the \texttt{h1} title but \emph{not} the paragraph.
The browser console displays the message:
\begin{minted}{text}
Error: _registerComponent(...): Target container is not a DOM element.
\end{minted}
This is the same race condition that has bitten us before.
After sighing in frustration and making another cup of tea,
we decide that
to keep things simple
we will load the script in the body of the page:
\begin{minted}{js}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello Bottom</title>
</head>
<body>
<h1>Hello Bottom</h1>
<div id="app"></div>
<script src="./app.js" type="text/babel"></script>
</body>
</html>
\end{minted}
\begin{aside}{Installing React and ReactDOM}
Now that we have made a project folder using \texttt{npm init}
and have created a \texttt{project.json} file,
we can install our first modules:
\begin{minted}{shell}
$ npm install react
$ npm install react-dom
\end{minted}
In general,
uses of the function \texttt{require} indicate that
we need to install that library to access the module's functions.
\end{aside}
More importantly,
we will rewrite \texttt{app.js} so that it loads the libraries it needs,
because there's no guarantee that libraries loaded in \texttt{head} will be available when \texttt{app.js} runs:
\begin{minted}{js}
const React = require('react')
const ReactDOM = require('react-dom')
ReactDOM.render(
<p>Rendered by React</p>,
document.getElementById('app')
)
\end{minted}
We don't have to shut down the server and restart it every time we make changes like this,
because Parcel watches for changes in files and relaunches itself as needed.
Each time it does so,
it looks at the libraries \texttt{app.js} loads and rebundles what it needs:
right now,
for example,
\texttt{dist/app.ef6b320b.js} is 19930 lines long.
A more modern option than loading in the bottom is
to add the \texttt{async} attribute\index{asynchronous loading}\index{running JavaScript!asynchronously}
to the script in the head of the page,
which tells the browser not to do anything with the JavaScript until the page has finished building:
\begin{minted}{jsx}
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Hello Parcel</title>
<script src="./app.js" type="text/babel" async></script>
</head>
<body>
<div id="app"></div>
</body>
</html>
\end{minted}
\section{Exercises}\label{s:dynamic-exercises}
\exercise{Those Damn Curly Braces}
Our list-building example includes this line of code:
\begin{minted}{jsx}
<ul>{allNames.map((name) => <li>{name}</li> )}</ul>,
\end{minted}
Why are the curly braces immediately inside the \texttt{\htmltag{ul}} element necessary?
What happens if you take them out?
\exercise{Real Data}
\begin{enumerate}
\item
Create a file called \texttt{programmers.js} that defines
a list of JSON objects called \texttt{programmers}
with \texttt{firstName} and \texttt{lastName} fields for our programmers.
(You can search the Internet to find their names.)
\item
Load that file in your page like any other JavaScript file.
\item
Delete the list \texttt{allNames} from the application
and modify it to use data from the list \texttt{programmers} instead.
\end{enumerate}
Loading constant data like this is a common practice during testing.
\exercise{Ordering}
What happens if you change the order in which the JavaScript files
are loaded in your web page?
For example,
what happens if you load \texttt{app.js} \emph{before} you load \texttt{ListElement.js}?
\exercise{Multiple Targets}
What happens if your HTML page contains two \texttt{div} elements with \texttt{id="app"}?
\exercise{Creating a Component for Names}
Create a new React component that renders a name,
and modify the example to use it instead of always displaying names in \texttt{\htmltag{li}} elements.
\exercise{Striping}
Suppose we want to render every second list element in italics.
(This would be a horrible design,
but once we start creating tables,
we might want to highlight alternate rows in different background colors
to make it easier to read.)
Modify the application so that
even-numbered list elements are \texttt{\htmltag{li}\{name\}\htmltag{/li}}
and odd-numbered list elements are \texttt{\htmltag{li}\htmltag{em}\{name\}\htmltag{/em}\htmltag{/li}}.
(Hint: use the fact that a \texttt{map} callback can have two parameters instead of one.)
\section*{Key Points}
\input{keypoints/dynamic}