Skip to content

Commit 22c75f1

Browse files
committed
add 0.24.0 changelog entry
1 parent 4bff693 commit 22c75f1

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

docs/source/changelog.rst

+28
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
Changelog
22
=========
33

4+
0.24.0
5+
------
6+
7+
This release contains an update that allows components and elements to have "identity".
8+
That is, their state can be preserved across updates. Before this point, only the state
9+
for the component at the root of an update was preserved. Now though, the state for any
10+
component and element with a ``key`` that is unique amongst its siblings, will be
11+
preserved so long as this is also true for parent elements/components within the scope
12+
of the current update. Thus, only when the key of the element or component changes will
13+
its state do the same.
14+
15+
In a future update, the default key for all elements and components will be its index
16+
with respect to its siblings in the layout. The
17+
:attr:`~idom.config.IDOM_FEATURE_INDEX_AS_DEFAULT_KEY` feature flag has been introduced
18+
to allow users to enable this behavior early.
19+
20+
- add feature flag for default key behavior - `42ee01c <https://github.com/idom-team/idom/commit/42ee01c>`__
21+
- use unique object instead of index as default key - `5727ab4 <https://github.com/idom-team/idom/commit/5727ab4>`__
22+
- make HookCatcher/StaticEventHandlers testing utils - `1abfd76 <https://github.com/idom-team/idom/commit/1abfd76>`__
23+
- add element and component identity - `5548f02 <https://github.com/idom-team/idom/commit/5548f02>`__
24+
- minor doc updates - `e5511d9 <https://github.com/idom-team/idom/commit/e5511d9>`__
25+
- add tests for callback identity preservation with keys - `72e03ec <https://github.com/idom-team/idom/commit/72e03ec>`__
26+
- add 'key' to VDOM spec - `c3236fe <https://github.com/idom-team/idom/commit/c3236fe>`__
27+
- Rename validate_serialized_vdom to validate_vdom - `d04faf9 <https://github.com/idom-team/idom/commit/d04faf9>`__
28+
- EventHandler should not serialize itself - `f7a59f2 <https://github.com/idom-team/idom/commit/f7a59f2>`__
29+
- fix docs typos - `42b2e20 <https://github.com/idom-team/idom/commit/42b2e20>`__
30+
- fixes: #331 - add roadmap to docs - `4226c12 <https://github.com/idom-team/idom/commit/4226c12>`__
31+
432
0.23.1
533
------
634

src/idom/config.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
mutable=False,
6060
validator=lambda x: bool(int(x)),
6161
)
62-
"""A feature flag for using the index of a sibling element as its default key
62+
"""Use the index of elements/components amongst their siblings as the default key.
6363
6464
In a future release this flag's default value will be set to true, and after that, this
6565
flag will be removed entirely and the indices will always be the default key.

0 commit comments

Comments
 (0)