Document Interactive Widgets

vizhub-core / vzcode

Mob Programming Code Editor

MIT License

71 stars 14 forks source link

Document Interactive Widgets #210

Open curran opened 1 year ago

curran commented 1 year ago

As a VZCode user who may not know about the interactive widgets features, I want to be informed about them and able to reference some documentation for how to use them.

curran commented 1 year ago

We need to specifically document the interactive widgets.

curran commented 1 year ago

Animated Gif would be the perfect way of explaining it (on loop).

The work here is:

[ ] Write text for the intro of the section of the documentation
[ ] Record one or more gifs
[ ] Make sure we cover all the interactive widgets, maybe have bullet points, one for each
[ ] Figure out where the entry point is in the UI - maybe a "?" icon in the editor header (where the file name is)? Or in Settings?

Darmin-Geek commented 1 year ago

demo1

Number literals: alt-drag to change the number (right is positive)
Boolean literals: alt-click to toggle
Hex/rgb color: alt-click and then use color picker
Vec2: alt-drag horizontally to change x number (right is positive), alt-drag vertically to change y number (up is positive)
Rotate: alt-drag around the word rotate. The angle is set to the angle in degrees between the x-axis and a line from the point where the user first clicks to the current mouse position.
Links: alt-click to open link in new tab

curran commented 11 months ago

Next steps here:

[ ] Drop the documentation from the last comment into the README