palantir/blueprint

dataNode on TreeNode should not be optional

Open

#5779 opened on Nov 30, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,263 stars) (2,167 forks)batch import
Domain: APIP2Package: coreStatus: to triageType: breaking changeType: enhancementhelp wanted

Description

Environment

  • Package version(s):
  • Browser and OS versions:

Feature request

This line: https://github.com/palantir/blueprint/blob/develop/packages/core/src/components/tree/treeNode.tsx#L83

    /**
     * An optional custom user object to associate with the node.
     * This property can then be used in the `onClick`, `onContextMenu` and `onDoubleClick`
     * event handlers for doing custom logic per node.
     */
    nodeData?: T;

should not be optional. It prevents type checking. If a user wants that to be optional then they can pass in undefined as a union for the generic parameter

Examples

can't do:

const a: ITreeNode<{type: "a"}> = {} as ITreeNode<{type: "a"}>;

if (a.dataNode.type == "a") // can't do this as a.dataNode can be undefined

if user actually wants undefined they can do ITreeNode<{type: "a"} | undefined>

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript genericsReact component props
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Change the `nodeData` property in the `ITreeNode` interface at `packages/core/src/components/tree/treeNode.tsx` line 83 from optional (`?`) to required. Then verify that no internal usage of `ITreeNode` relies on `nodeData` being undefined; if so, make the type generic parameter allow undefined. Also check for any higher order components or tests that may need updating.