search

JetBrains / web-types

JSON standard for documenting web component libraries for IDEs, documentation generators and other tools
Apache License 2.0
278 stars 25 forks source link

Does Web-Types support React? #66

Open mduenias opened 1 year ago

mduenias commented 1 year ago

Hi :)

I am working on a component library that uses Web Components, so web-types has been very useful to feed good documentation to JetBrains IDEs for Vue consumers :D. JetBrains IDEs are not working very well with our React Bundle. Therefore I would like to try to also generate web-types metadata for React, but simple tries are not picked up by IntelliJ.

Could you let me know if it currently supports React and if there is some example out there.

Thanks!

piotrtomiak commented 1 year ago

@mduenias - I am sorry, but we do not support Web Types with React at the moment, but we do plan to enable them with React at some point. I think, for now, the best way is to use .d.ts files to provide React components definitions.

mduenias commented 1 year ago

@piotrtomiak thanks for your quick response and for the update. We will keep then the default use of the d.ts for now as you suggest. Unfortunately this is not working great. IntelliJ is not picking up very well the types, which is curious because VSCode parse them without issues. I followed up this suggestions but didn't help.

Looking forward to see how the Web-Types topic evolves.

Thanks!

melloware commented 11 months ago

+1 for React support