Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation? #29

Open
acalvino4 opened this issue Dec 2, 2021 · 1 comment
Open

Documentation? #29

acalvino4 opened this issue Dec 2, 2021 · 1 comment

Comments

@acalvino4
Copy link

acalvino4 commented Dec 2, 2021

Is there documentation for this plugin, or are we just supposed to figure everything out from the Example.json?

If there is, could you link it in the readme?

If there isn't, consider this a feature request to add documentation, specifically about the customStyles configuration section. It would be helpful to have an annotated example, showing what all the possible keys are and what they mean.

  • For the top level entries, which keys will automatically load a button icon and which won't?
  • Is there a way to specify an alternate icon, or to specify an icon for cases where an icon is not loaded automatically?
  • Is there any way to add items to an existing dropdown, rather than creating a new one (if this isn't possible, it would be an awesome feature to implement!)
  • Under a custom styles key you can directly specify args, api, or dropdown - is there anything else we can specify, such as a a Title (for tooltip purposes, or if text toolbar is set)?

These, and I'm sure many more questions I didn't think of, would benefit from more detailed documentation.

@acalvino4
Copy link
Author

Maybe some of those things I ask about in the above post are reaching a bit beyond what this plugin is intended for. That is fine; the point is that without documentation I have no idea whether these things are out of scope or just aren't documented (as nothing is documented).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant