Skip to content

feat: typescript parameter type definition in Tree component titleRender api #946

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
+10 −11
Open

feat: typescript parameter type definition in Tree component titleRender api #946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
55683fe
feat: dataNode
May 28, 2025
ae37a48
feat: doc
May 28, 2025
2c46f6e
feat: doc
May 28, 2025
fce4d9d
feat: doc
May 28, 2025
160dfe3
feat: ts
May 30, 2025
1a26c70
feat: ts
May 30, 2025
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
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

Tree component.

[![NPM version][npm-image]][npm-url]
[![npm download][download-image]][download-url]
[![build status][github-actions-image]][github-actions-url]
[![Codecov][codecov-image]][codecov-url]
[![bundle size][bundlephobia-image]][bundlephobia-url]
[![dumi][dumi-image]][dumi-url]
[![NPM version][npm-image]][npm-url] [![npm download][download-image]][download-url] [![build status][github-actions-image]][github-actions-url] [![Codecov][codecov-image]][codecov-url] [![bundle size][bundlephobia-image]][bundlephobia-url] [![dumi][dumi-image]][dumi-url]

[npm-image]: http://img.shields.io/npm/v/rc-tree.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-tree
Expand Down Expand Up @@ -45,6 +40,7 @@ online example: https://tree.react-component.now.sh/
[![rc-tree](https://nodei.co/npm/rc-tree.png)](https://npmjs.org/package/rc-tree)

## Usage

> Note: `import "rc-tree/assets/index.css"`

see examples
Expand Down Expand Up @@ -95,7 +91,7 @@ see examples
| switcherIcon | specific the switcher icon. | ReactNode / (props: TreeNodeAttribute) => ReactNode | - |
| virtual | Disable virtual scroll when `false` | boolean | - |
| allowDrop | Whether to allow drop on node | ({ dragNode, dropNode, dropPosition }) => boolean | - |
| dropIndicatorRender | The indicator to render when dragging | ({ dropPosition, dropLevelOffset, indent: number, prefixCls }) => ReactNode| - |
| dropIndicatorRender | The indicator to render when dragging | ({ dropPosition, dropLevelOffset, indent: number, prefixCls }) => ReactNode | - |
| direction | Display direction of the tree, it may affect dragging behavior | `ltr` \| `rtl` | - |
| expandAction | Tree open logic, optional: false \| `click` \| `doubleClick` | string \| boolean | `click` |

Expand Down
11 changes: 7 additions & 4 deletions src/interface.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,12 @@ export type KeyEntities<DateType extends BasicDataNode = any> = Record<
DataEntity<DateType>
>;

export type DataNode = FieldDataNode<{
key: Key;
title?: React.ReactNode | ((data: DataNode) => React.ReactNode);
}>;
export type DataNode<T = Record<string, unknown>> = FieldDataNode<
{
key: Key;
title?: React.ReactNode | ((data: DataNode<T>) => React.ReactNode);
} & T
>;

export type EventDataNode<TreeDataType> = {
key: Key;
Expand Down Expand Up @@ -151,4 +153,5 @@ export interface FieldNames {
_title?: string[];
key?: string;
children?: string;
[key: string]: string | string[] | undefined;
Copy link
Member

@zombieJ zombieJ Jun 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个也是不知道是什么类型的，万一是 Date 是 number 呢？

}
Loading