Skip to content

Commit 9426d7d

Browse files
committed
misc improvements + start on component state doc
1 parent 6751f47 commit 9426d7d

20 files changed

+64
-25
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
Components With State
22
=====================
33

4-
Under construction :)
4+
Components often need to change what’s on the screen as a result of an interaction. For
5+
example, typing into the form should update the input field, clicking “next” on an image
6+
carousel should change which image is displayed, clicking “buy” should put a product in
7+
the shopping cart. Components need to “remember” things: the current input value, the
8+
current image, the shopping cart. In IDOM, this kind of component-specific memory is
9+
called state.
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
The Dangers of Mutability
22
=========================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Class Components
22
================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷

docs/source/escape-hatches/index.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,6 @@ Escape Hatches
1010
writing-your-own-server
1111
writing-your-own-client
1212

13-
Under construction :)
13+
.. note::
14+
15+
Under construction 👷

docs/source/escape-hatches/javascript-components.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Dynamically Loaded Components
3131

3232
.. note::
3333

34-
This method is not recommended in production systems - see
35-
:ref:`Distributing Javascript Components` for more info. Instead, it's best used
36-
during exploratory phases of development.
34+
This method is not recommended in production systems - see :ref:`Distributing
35+
Javascript` for more info. Instead, it's best used during exploratory phases of
36+
development.
3737

3838
IDOM makes it easy to draft your code when you're in the early stages of development by
3939
using a CDN_ to dynamically load Javascript packages on the fly. In this example we'll
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Writing Your Own Client
22
=======================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Writing Your Own Server
22
=======================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷

docs/source/getting-started/running-idom.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Here's the list of available configuration types:
172172
Specific Server Settings
173173
------------------------
174174

175-
The ``Config`` :ref:`described above <Configuring Server Settings` is meant to be an
175+
The ``Config`` :ref:`described above <Configuring Server Settings>` is meant to be an
176176
implementation agnostic - all ``Config`` objects support a similar set of options.
177177
However, there are inevitably cases where you need to set up your chosen server using
178178
implementation specific details. For example, you might want to add an extra route to

docs/source/managing-state/index.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ Managing State
1111
when-to-reset-state
1212
writing-tests
1313

14-
Under construction :)
14+
.. note::
15+
16+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Keeping Components Pure
22
=======================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Logical Flow of State
22
=====================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Shared Component State
22
======================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Structuring Your State
22
======================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
When to Reset State
22
===================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Writing Tests
22
=============
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Javascript API
22
==============
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷

docs/source/understanding-idom/representing-html.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
How IDOM Represents HTML
2-
========================
1+
Representing HTML
2+
=================
3+
4+
.. note::
5+
6+
Under construction 👷
37

48
We've already discussed how to contruct HTML with IDOM in a :ref:`previous section <HTML
59
with IDOM>`, but we skimmed over the question of the data structure we use to represent
@@ -67,5 +71,3 @@ is just a fancy way of saying we have a representation of the document object mo
6771
`DOM
6872
<https://en.wikipedia.org/wiki/Document_Object_Model#:~:text=The%20Document%20Object%20Model%20(DOM,document%20with%20a%20logical%20tree.&text=Nodes%20can%20have%20event%20handlers%20attached%20to%20them.>`__
6973
that is not the actual DOM.
70-
71-
Under construction :)

docs/source/understanding-idom/the-rendering-pipeline.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ The Rendering Pipeline
33

44
.. talk about layouts and dispatchers
55
6-
Under construction :)
6+
.. note::
7+
8+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
What Are Components?
22
====================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
Why IDOM Needs Keys
22
===================
33

4-
Under construction :)
4+
.. note::
5+
6+
Under construction 👷

0 commit comments

Comments
 (0)