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

Create Full Application Example #34

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

bootsie123
Copy link
Contributor

Overview
Adds a fully developed Vue application that demonstrates how to use many features available in UXP. The purpose of this sample/example is to show UXP Photoshop plugins in practice and to give developers an idea of what a full application might look like.

Functionality
The plugin in this example called, Plugin Info, is a simple UXP plugin that allows the user to view information on any installed UXP and CEP plugins. The plugin itself makes use of multiple entry points, interacts with the user's filesystem, includes persistent data, and more.

Documentation
Since this example is more complex and less straightforward than a plain sample, a section called The code explained as been added. The idea behind this section is to help guide developers through the plugin by providing a written explanation of the different parts of the code.

Extra Thoughts
This PR is definitely a bit different from the other samples in this repo. So, please let me know if you feel it doesn't quite fit!

Also of note, the code itself at its current state lacks comments. If you think this is something that should probably be included then let me know! I'll gladly go through and add them where I feel it might be necessary. The plugin could probably also use a refactor. Specifically, adding Vue Router and Vuex would make most of the code a lot cleaner and easier to follow.

If you have any questions feel free to let me know! Thanks!


At any point in time you can redo the setup process by either clicking on `Reload Plugins` in the home menu or using the plugin command called `Show Setup`. Any stored data can also be deleted by using the `Clear Data` plugin command.

## The code explained
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know your thoughts on this. Since this is larger than a regular sample, I thought a section explaining some of the code would be pretty useful

"main": "index.html",
"manifestVersion": 4,
"host": {
"app": "PS",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This plugin would definitely work well as a cross-compatible plugin with Adobe XD. Is there a way to indicate both PS and XD in the manifest?

Copy link
Contributor Author

@bootsie123 bootsie123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just as a heads up, I left a few comments regarding the README and the plugin manifest. Let me know if you can address these! Thanks!

@c4kaci
Copy link

c4kaci commented Jul 15, 2021

It would be nice a vuetify, tabs and router for VUE and React router, tabs example.

Thanks!

@kerrishotts
Copy link
Collaborator

Couple of quick points:

  • The "typical path" entries should be theme aware. On Ps in a light theme, they are quite hard to read at the moment.�
  • The UXP typical path should append "External"
  • When there are errors in loading plugins, these are silent -- you might want to provide some error messages (right now they're on the console)
  • The console is showing several error messages about missing manifest.json when loading CEP plugins

@bootsie123
Copy link
Contributor Author

Hi! Thanks for the feedback! Good catch on the theme-aware issues! I didn't notice that. Also, in terms of handling errors, that's a really good idea and definitely a shortcoming on my part. I'll add that in and also look into the issues you're experiencing with loading CEP plugins

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

Successfully merging this pull request may close these issues.

3 participants