Skip to content

docs: type inference issue on exposed API documentation #21278

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

eesayas
Copy link
Contributor

@eesayas eesayas commented Apr 16, 2025

Description

  1. CleanHTMLInputElement will filter out native HTMLInputElement inferred props. Currently, these components are the ones that uses VTextField (and consequently an input, where the native props are coming from)
  2. A non-blocking warning after build that shows the components with missing API descriptions.
    Screen Shot 2025-04-16 at 2 18 01 PM

Markup:

N/A

eesayas added 4 commits April 16, 2025 14:28
Components that have exposed reference of VTextField and consequently input
are infering HTMLInputElement props, which should not not be documented.
This change will filter out these irrelevant props through type.
@eesayas eesayas self-assigned this Apr 16, 2025
@eesayas eesayas changed the title docs: type inference issue on docs: type inference issue on exposed props Apr 16, 2025
@eesayas eesayas changed the title docs: type inference issue on exposed props docs: type inference issue on exposed api Apr 16, 2025
@eesayas eesayas changed the title docs: type inference issue on exposed api docs: type inference issue on exposed API documentation Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants