docs(types): adds docs for renderCustomNodeElement

Author: bkrem

src/Tree/index.tsx

@@ -51,6 +51,7 @@ class Tree extends React.Component<TreeProps, TreeState> {
     rootNodeClassName: '',
     branchNodeClassName: '',
     leafNodeClassName: '',
+    renderCustomNodeElement: undefined,
     enableLegacyTransitions: false,
   };
 

src/Tree/types.ts

@@ -34,6 +34,16 @@ export interface TreeProps {
    */
   data: RawNodeDatum[] | RawNodeDatum;
 
+  /**
+   * Custom render function that will be used for every node in the tree.
+   *
+   * The function is passed `CustomNodeElementProps` as its first argument.
+   * `react-d3-tree` expects the function to return a `ReactElement`.
+   *
+   * See the `RenderCustomNodeElementFn` type for more details.
+   *
+   * {@link Tree.defaultProps.renderCustomNodeElement | Default value}
+   */
   renderCustomNodeElement?: RenderCustomNodeElementFn;
 
   /**

src/types/common.ts

@@ -33,12 +33,21 @@ export type PathClassFunction = PathFunction;
 
 export type SyntheticEventHandler = (evt: React.SyntheticEvent) => void;
 
+/**
+ * The properties that are passed to the user-defined `renderCustomNodeElement` render function.
+ */
 export interface CustomNodeElementProps {
+  /**
+   * The full datum of the node that is being rendered.
+   */
   nodeDatum: TreeNodeDatum;
+  /**
+   * Toggles the expanded/collapsed state of the node.
+   *
+   * Provided for customized control flow; e.g. if we want to toggle the node when its
+   * label is clicked instead of the node itself.
+   */
   toggleNode: () => void;
 }
 
-/**
- * Function to render a custom node element. Should return a `ReactElement`.
- */
 export type RenderCustomNodeElementFn = (rd3tProps: CustomNodeElementProps) => JSX.Element;