Skip to content
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

Jump to bottom

Tree: Incorrect props and types in documentation #7599

Closed
diegoromerodev opened this issue Jan 13, 2025 · 0 comments · Fixed by #7603
Closed

Tree: Incorrect props and types in documentation #7599

diegoromerodev opened this issue Jan 13, 2025 · 0 comments · Fixed by #7603
Assignees
@melloware
Labels
Component: Documentation Issue or pull request is related to Documentation Typescript Issue or pull request is *only* related to TypeScript definition
Milestone
10.9.2

Comments

@diegoromerodev
Copy link

Describe the bug

The documentation mentions that there is a leaf property for TreeNode,
https://primereact.org/tree/#api.TreeNode.props.leaf
but that is incorrect, after logging the context, I can see that the property is actually named: isLeaf
image

As an additional note, the types for the pt prop are mostly broken as well:
image

I sincerely appreciate your work on this library, it has saved me a few hours!

Reproducer

No response

System Information

npmPackages:
primereact: '10.9.1',
react: "19.0.0",
typescript: "5.7.2"

Steps to reproduce the behavior

No response

Expected behavior

No response
@diegoromerodev diegoromerodev added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Jan 13, 2025
@melloware melloware added Typescript Issue or pull request is *only* related to TypeScript definition Component: Documentation Issue or pull request is related to Documentation and removed Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible labels Jan 13, 2025
akshayaqburst pushed a commit to qburst/primereact_qb_45 that referenced this issue Jan 14, 2025
fix: primefaces#7599, Tree: Incorrect props and types in documentation
0047a7d
@akshayaqburst akshayaqburst mentioned this issue Jan 14, 2025
Closed
melloware added a commit to melloware/primereact that referenced this issue Jan 14, 2025
@melloware
Fix primefaces#7599: Tree switch isLeaf to leaf
ffe2842
@melloware melloware mentioned this issue Jan 14, 2025
Merged
@melloware melloware self-assigned this Jan 14, 2025
@melloware melloware added this to the 10.9.2 milestone Jan 14, 2025
melloware added a commit to melloware/primereact that referenced this issue Jan 14, 2025
@melloware
Fix primefaces#7599: Tree switch isLeaf to leaf
6b9dcd2
melloware added a commit that referenced this issue Jan 14, 2025
@melloware
Fix #7599: Tree switch isLeaf to leaf (#7603)
10bda0c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@melloware melloware

Labels
Component: Documentation Issue or pull request is related to Documentation Typescript Issue or pull request is *only* related to TypeScript definition
Projects
None yet
Milestone
10.9.2
2 participants
@melloware @diegoromerodev