unovue / radix-vue

Vue port of Radix UI Primitives. An open-source UI component library for building high-quality, accessible design systems and web apps.
https://radix-vue.com
MIT License
3.66k stars 226 forks source link

[Feature]: Provide a description of the component #1306

Open Simon-He95 opened 1 month ago

Simon-He95 commented 1 month ago

Describe the feature

https://github.com/common-intellisense/radix-vue1

The purpose of this issue is to hope that radix-vue will generate a component information every time it is modified, so that it can be provided to common-intellisense for updating together. I hope common-intellisense can help radix-vue developers, but it is difficult for me to maintain this file, because I need to pay attention to the changes of radix-vue at any time, and then generate json from the document through the browser script. So I prefer radix to maintain it, and each update can directly generate such a json, so that the plugin can be updated consistently with radix-vue at any time.

Additional information

zernonia commented 1 month ago

Yooo @Simon-He95 ! How can this be done in radix-vue ya? Is there a script you have written that can run to generate those json files? 😁

Simon-He95 commented 1 month ago

My previous implementation was to generate json from the browser document through the dom node, and then take it one by one. I think this document can be modified to have a public place to configure the generated document, such as a json, such as quasar The document is also generated through json, and then this json can also be generated through a script to generate the json format required by common-intellisense