feat: support option in onChange handler

Author: nathanlao11

src/TreeSelect.tsx

@@ -34,6 +34,7 @@ import type {
   DefaultValueType,
   FieldNames,
   LegacyDataNode,
+  DefaultOptionType,
 } from './interface';
 
 export interface TreeSelectProps<ValueType = any, OptionType extends DataNode = DataNode>
@@ -45,7 +46,11 @@ export interface TreeSelectProps<ValueType = any, OptionType extends DataNode =
   // >>> Value
   value?: ValueType;
   defaultValue?: ValueType;
-  onChange?: (value: ValueType, labelList: React.ReactNode[], extra: ChangeEventExtra) => void;
+  onChange?: (
+    value: ValueType,
+    labelList: React.ReactNode[],
+    extra: ChangeEventExtra & { option?: DefaultOptionType },
+  ) => void;
 
   // >>> Search
   searchValue?: string;
@@ -410,7 +415,7 @@ const TreeSelect = React.forwardRef<BaseSelectRef, TreeSelectProps>((props, ref)
   const triggerChange = useRefFunc(
     (
       newRawValues: SafeKey[],
-      extra: { triggerValue?: SafeKey; selected?: boolean },
+      extra: { triggerValue?: SafeKey; selected?: boolean; option?: DefaultOptionType },
       source: SelectSource,
     ) => {
       const labeledValues = convert2LabelValues(newRawValues);
@@ -456,7 +461,8 @@ const TreeSelect = React.forwardRef<BaseSelectRef, TreeSelectProps>((props, ref)
           // [Legacy] Always return as array contains label & value
           preValue: rawLabeledValues,
           triggerValue,
-        } as ChangeEventExtra;
+          option: extra.option,
+        } as ChangeEventExtra & { option?: DefaultOptionType };
 
         // [Legacy] Fill legacy data if user query.
         // This is expansive that we only fill when user query
@@ -505,7 +511,11 @@ const TreeSelect = React.forwardRef<BaseSelectRef, TreeSelectProps>((props, ref)
       // Never be falsy but keep it safe
       if (!mergedMultiple) {
         // Single mode always set value
-        triggerChange([selectedValue], { selected: true, triggerValue: selectedValue }, 'option');
+        triggerChange(
+          [selectedValue],
+          { selected: true, triggerValue: selectedValue, option: node as DefaultOptionType },
+          'option',
+        );
       } else {
         let newRawValues = selected
           ? [...rawValues, selectedValue]
@@ -535,7 +545,11 @@ const TreeSelect = React.forwardRef<BaseSelectRef, TreeSelectProps>((props, ref)
             ...checkedKeys.map(key => keyEntities[key as SafeKey].node[mergedFieldNames.value]),
           ];
         }
-        triggerChange(newRawValues, { selected, triggerValue: selectedValue }, source || 'option');
+        triggerChange(
+          newRawValues,
+          { selected, triggerValue: selectedValue, option: node as DefaultOptionType },
+          source || 'option',
+        );
       }
 
       // Trigger select event

src/interface.ts

@@ -3,6 +3,19 @@ import type { SafeKey, Key, DataNode as TreeDataNode } from 'rc-tree/lib/interfa
 
 export type { SafeKey, Key };
 
+export interface BaseOptionType {
+  disabled?: boolean;
+  className?: string;
+  title?: string;
+  [name: string]: any;
+}
+
+export interface DefaultOptionType extends BaseOptionType {
+  label?: React.ReactNode;
+  value?: string | number | null;
+  children?: Omit<DefaultOptionType, 'children'>[];
+}
+
 export interface DataNode extends Record<string, any>, Omit<TreeDataNode, 'key' | 'children'> {
   key?: Key;
   value?: SafeKey;

tests/Select.props.spec.js

@@ -324,6 +324,7 @@ describe('TreeSelect.props', () => {
             }),
           ],
           checked: true,
+          option: expect.anything(),
           preValue: [],
           triggerNode: expect.anything(),
           triggerValue: 'Value 0',
@@ -342,6 +343,7 @@ describe('TreeSelect.props', () => {
             }),
           ],
           checked: true,
+          option: expect.anything(),
           preValue: [],
           triggerNode: expect.anything(),
           triggerValue: 'Value 0',
@@ -360,6 +362,7 @@ describe('TreeSelect.props', () => {
             }),
           ],
           checked: true,
+          option: expect.anything(),
           preValue: [],
           triggerNode: expect.anything(),
           triggerValue: 'Value 0',