Add ITreeNode.nodeData property #2132
Conversation
|
Thanks for your interest in palantir/blueprint, @izikorgad! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request. |
|
This PR is an implementation of the concept described as part of #1998 (by @yaronlavi). |
|
Thanks for your interest in palantir/blueprint, @izikorgad! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request. |
|
@izikorgad please fill out the description up top. that's the place to note the issue number (which i already did for you) |
| @@ -13,7 +13,7 @@ import { safeInvoke } from "../../common/utils"; | |||
| import { Collapse } from "../collapse/collapse"; | |||
| import { Icon, IconName } from "../icon/icon"; | |||
|
|
|||
| export interface ITreeNode extends IProps { | |||
| export interface ITreeNode<T = {}> extends IProps { | |||
There was a problem hiding this comment.
can we say T = undefined? more accurate for the default case. if you want to use <T> then you have to define it.
There was a problem hiding this comment.
When changing the generic constrain to <T = undefined>, each call to safeInvoke() won't complied:
Argument of type 'this' is not assignable to parameter of type 'TreeNode'.
I don't see the problem with the <T = {}> constrain, the user can still use the tree without declaring on any type.
There was a problem hiding this comment.
This was my original intent too, but per @adidahiya requested 16 days ago:
"you can set a default for the generic type parameter so that users who don't need it won't have to specify T.
use nodeData: T where the interface is defined as ITreeNode<T = {}>, similar to queryList:
blueprint/packages/select/src/components/query-list/queryList.tsx (Line 15 in ff76c4a)"
since both of you are reviewers and contributors, I suggest you guys touch bases and sync your request.
There was a problem hiding this comment.
i guess {} is fine, since React does the same thing and state doesn't actually default to anything (you gotta initialize it yourself)
|
What does usage of this new feature look like in practice? It would be helpful if you added it to the docs example. I'm pretty sure you still want an |
|
hmm yeah might want |
|
Sorry, but I’m not following... Should it be placed inside the Tree class or TreeNode class? Something like that: |
|
@izikorgad check out the source code for our select components (and usages thereof, like the examples), that's where we "pioneered" this approach: https://github.com/palantir/blueprint/blob/develop/packages/select/src/components/select/select.tsx#L90-L92 |
|
the method is essential for typescript consumers to apply <Select<IFilm> props> // error
const FilmSelect = Select.ofType<IFilm>();
<FilmSelect props> // ok |
|
OK. |
| @@ -59,6 +63,10 @@ export class Tree extends React.Component<ITreeProps, {}> { | |||
|
|
|||
| private nodeRefs: { [nodeId: string]: HTMLElement } = {}; | |||
|
|
|||
| constructor(props?: ITreeProps<T>, context?: any) { | |||
| super(props, context); | |||
| } | |||
There was a problem hiding this comment.
whoa whoa remove this constructor, not necessary!
| return TreeNode as new () => TreeNode<T>; | ||
| } | ||
|
|
||
| constructor(props?: ITreeNodeProps<T>, context?: any) { |
There was a problem hiding this comment.
The code won't compiled without, because of the following function:
public static ofType() {
return TreeNode as new () => TreeNode;
}
It is necessary....
There was a problem hiding this comment.
oh snap! yeah it does fail. but that's just a typings issue.
props? in constructor is actually wrong--it goes against React's types and will fail if strictNullChecks is enabled (it is disabled in blueprint).
i'll resolve that in all instances later 👍
Fixes #1989
This feature add a new generics type prop for ITreeNode called 'nodeData'.
The user can use this property to store custom user data, object reference, etc.
Checklist
Changes proposed in this pull request:
Reviewers should focus on:
Screenshot