AdobeXD/plugin-docs

Helpful: A list of things which are require-able, from scenegraph

bbb999 opened this issue · 4 comments

bbb999 commented

List of require-able things

Docs

Versions

All

Description of the issue

It'd be interesting/handy to have a list of all the neat things one can require, from the scenegraph; “Color”, “ImageFill”, “LinearGradientFill”, “Matrix”, “Shadow”, “Blur”, and...

¯\(ツ)/¯

[There's currently no way to know.]

ashryanbeats commented

YES.

We currently have a partial list buried deeply in the docs. We can do better than that.

dkstevekwak commented

@ashryanbeats we could create a separate page for this if needed. What are your thoughts?

ashryanbeats commented

Let's confer with @peterflynn and @kerrishotts. I'm fine with having a manually created page if need be, but since the require-ables are coming from both XD and UXP, I'm wondering if that list is something we can somehow automatically extract (and therefore keep updated).

Wild guess, but worth discussing first.

pklaschka commented

@ashryanbeats @kerrishotts Is there any update about this? I think it's quite severe since it currently looks like Color, RadiantGradientFill etc. are global classes. I even made a mistake with the last update of the typescript definitions because of this since I thought I had interpreted the docs wrong before.

I think there are two main options for this:

  1. Include the stuff that's from the scenegraph in the scenegraph docs (although I find that to be unwise since the scenegraph docs are already quite long and difficult to navigate)
  2. Include an exported member of the scenegraph module at the top of the class docs (e.g., in Color, replace Kind: class with Kind: Exported class of the scenegraph module)

I think that this is pretty severe (at least more severe than "Helpful") and I don't think to have this on a separate page, as suggested by @dkstevekwak, is good enough – I don't go to another page to see where I can find the class whose documentation I've currently opened. The way it currently is, things like Color, Matrix etc. are classes where it's "nice" that they're documented, but without knowledge (hardly obtainable by reading the docs) they aren't beneficial (or only useful when there is a member of another class with this type). I find this too severe to "leave it" for more than two months without a (visible) update. Therefore, I'm sorry to bug you with this, but I believe that this deserves some priority 😉