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.

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

Ripple: pt property is not defined in RippleProps and documentation API but work right #6469

Closed
NikVAx opened this issue Apr 24, 2024 · 5 comments · Fixed by #6470, #6472 or leoo1992/GeradorQRCode#23
Assignees
Labels
Component: Documentation Issue or pull request is related to Documentation Type: Bug Issue contains a defect related to a specific component. Typescript Issue or pull request is *only* related to TypeScript definition
Milestone

Comments

@NikVAx
Copy link

NikVAx commented Apr 24, 2024

Describe the bug

  1. RippleProps type (ripple.d.ts) is not provide pt property for pass through, but it can be used successfully, and it will be work like in documentation example, but it will cause an error in TS.

  2. This property is not described in documentation "API" section. Documentation doesn't contains "Pass Through" section.

image

  1. Section ConfigurationDoc contains code with ripplie: false, but says that it have to be enabled globally.

  2. Example for Custom section in StackBlitz contains code where ripple is not enabled, so example doesn't work.

Reproducer

https://stackblitz.com/edit/f1m5k3?file=tsconfig.json,src%2Fmain.jsx,src%2FApp.tsx

PrimeReact version

10.6.3

React version

18.x

Language

TypeScript

Build / Runtime

Create React App (CRA)

Browser(s)

No response

Steps to reproduce the behavior

Open Reproducer example in Stackblitz, file App.ts, line 9.

Expected behavior

  1. No error in TS;
  2. Correct api description in documentation;
  3. Working code examples in the documentation.
@NikVAx NikVAx added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Apr 24, 2024
@NikVAx
Copy link
Author

NikVAx commented Apr 24, 2024

In issue #5316 was one of the points (3) that I wrote about. It is possible that it was fixed only on Configuration - Ripple page but not on Ripple - ConfigurationDoc.

UPD: i think that related code is there

@melloware melloware added 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 Apr 25, 2024
@melloware melloware added this to the 10.6.4 milestone Apr 25, 2024
melloware pushed a commit that referenced this issue Apr 25, 2024
@NikVAx
Copy link
Author

NikVAx commented Apr 25, 2024

@melloware, do I need to create new issue for point 1 of there (point 2 look like autogenerated code by ripple.d.ts), and another one for point 4?

@melloware melloware reopened this Apr 25, 2024
@melloware
Copy link
Member

NO i reopened this issue. let me look.

@github-actions github-actions bot added the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Apr 25, 2024
@melloware melloware removed the Status: Needs Triage Issue will be reviewed by Core Team and a relevant label will be added as soon as possible label Apr 25, 2024
@melloware melloware added the Typescript Issue or pull request is *only* related to TypeScript definition label Apr 25, 2024
@melloware
Copy link
Member

Please review my PR: #6472

@Rekl0w
Copy link
Contributor

Rekl0w commented Apr 25, 2024

Need doc for pt. I didn't want to do anything to doc's in my PR so i let you to make changes for pt at docs. @melloware

@nitrogenous nitrogenous added the Type: Bug Issue contains a defect related to a specific component. label Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Issue or pull request is related to Documentation Type: Bug Issue contains a defect related to a specific component. Typescript Issue or pull request is *only* related to TypeScript definition
Projects
None yet
4 participants