aframe icon indicating copy to clipboard operation
aframe copied to clipboard

[feature request] Schema - add "displayname" and "description" fields

Open nightgryphon opened this issue 2 years ago • 8 comments

The Aframe-Inspector and possible other editors use component schema to build editor UI. It will be useful to add human readable displayname and description fields to schema so editor can create human friendly interface. This especially useful for things like material parameters which need some usage tips.

nightgryphon avatar Jul 14 '23 09:07 nightgryphon

We had some discussion about that with @kfarr 6 months ago when I was working on the react upgrade and fixing issues in aframe-inspector and was planning to work on an editor from the aframe-inspector code base. My work on an editor was put on stand by at that time, but I'll be working on it in the coming months, not sure how the code and UI will end up though, I'm just starting thinking about it. You can read my notes here https://gist.github.com/vincentfretin/cf4c80eaa0cb07fa35c0a93360be88eb#ui-customization I need to split those notes into issues in the https://github.com/c-frame/aframe-editor repo. Also I was thinking about registering aframe primitives with additional title, description, icon for use with drag and drop from a panel https://github.com/c-frame/aframe-editor/pull/1

vincentfretin avatar Jul 17 '23 12:07 vincentfretin

I'm copying here the relevant passage from my notes, for archive, in case I modify or remove my notes later.

Be able to specify which fields of a component appear in the panel, with which widget and label with a component schema that can be registered for the editor, similar to aframe components, see discussion on https://stackoverflow.com/questions/73271455/how-to-specify-widget-behavior-for-component-properties-with-a-custom-a-frame-in/73279049#73279049 Some field like the animation loop property that allows number or boolean indeed has an issue that would be fixed by a system where you can say that this component property needs to use the boolean widget. For now it's hard coded here https://github.com/aframevr/aframe-inspector/pull/638/commits/c541c41c1064566285f9dd9ecc673e17c1e8bf4b

vincentfretin avatar Jul 17 '23 14:07 vincentfretin

Yes in general this would be helpful for all of us. FYI the only thing we've implemented so far with 3dstreet editor is a display name of sorts for an individual entity by using a custom attribute data-layer-name on the entity. When added it simply allows for string with custom capitalization and spaces to make the entity names look nicer for non-technical end-users.

kfarr avatar Jul 18 '23 17:07 kfarr