Skip to content

Fix recomputeTree example in README.md #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 6, 2021
Merged

Fix recomputeTree example in README.md #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9531568
Fix `recomputeTree` example in README.md
ptoussai Jan 5, 2021
e21b54e
Remove all mentions of subtreeWalker
ptoussai Jan 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ The rules object has the following shape:
- `open: boolean` - this rule changes the openness state for the owner node only (subtree nodes are not affected).
- `subtreeCallback(node: object, ownerNode: object): void` - this callback runs against each node in the subtree of the owner node (including the owner node as well). It receives the subtree node and the owner node. Changing any property of the subtree node will affect the node state and how it will be displayed (e.g. if you change the node openness state it will be displayed according to the changed state).

The order of rules matters. If you specify the child node rules before the parent node rules, and that rules affect the same property, the parent node `subtreeWalker` will override that property. So if you want to override parent's rules, place children rules after the parent's.
The order of rules matters. If you specify the child node rules before the parent node rules, and that rules affect the same property, the parent node `subtreeCallback` will override that property. So if you want to override parent's rules, place children rules after the parent's.

The type of the node objects received by `subtreeCallback` is `FixedSizeNodePublicState`. See the [types description](#types) below.

Expand Down Expand Up @@ -278,8 +278,8 @@ const tree = {
tree.recomputeTree({
'root-1': {
open: false,
subtreeWalker(node, ownerNode) {
// Since subtreeWalker affects the ownerNode as well, we can check if the
subtreeCallback(node, ownerNode) {
// Since subtreeCallback affects the ownerNode as well, we can check if the
// nodes are the same, and run the action only if they aren't
if (node !== ownerNode) {
// All nodes of the tree will be closed
Expand Down Expand Up @@ -659,4 +659,4 @@ const Node = ({data: {isLeaf, name}, isOpen, style, setOpen}) => (

### 5. Migrate all your IDs to string

Using node IDs as keys should improve React rendering performance. However, it means that you won't be able to use `Symbol` as IDs anymore. You should move all your IDs to be strings instead of symbols.
Using node IDs as keys should improve React rendering performance. However, it means that you won't be able to use `Symbol` as IDs anymore. You should move all your IDs to be strings instead of symbols.