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

[Feature Request]: Additional Developer Documentation for Plugin Development #2010

Open
bjazmoore opened this issue Feb 10, 2025 · 0 comments

Comments

@bjazmoore
Copy link

bjazmoore commented Feb 10, 2025

Feature Description

I know that some documentation exists (thank you so very much Tom!), but there are still things that need some explanation. Specifically I wanted to understand the following (which is hinted at in the docs but not explained):

I would like to know how validation and error messaging works when creating a plugin. How can I communicate back to the user that a validation of their input in a plugin failed. I have the following test code, but I lack documentation on this functionality. Any assistance would be awesome. This is what I tried. I am hoping it is close, but I know it does not work.

validateRules() {
    let valid = true;
    this.errorMessages = []; // Reset previous errors

/* testing */

    valid = false;
    this.errorMessages.push(`There is an Error!`);
  });

  return valid;

Also - while we are on the subject - how can I echo back a value being manipulated before saving a config in the this.API.saveConfig(this.config);. I tried console.log(), but it does not seem to be accessible. Thanks.

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