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.

Sign up for GitHub

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

Jump to bottom

Update Photoshop sample list in repository readme #35

Merged
merged 2 commits into from
Dec 14, 2021
Merged

Update Photoshop sample list in repository readme #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00e4354
Updated samples list in readme to be even with main
jake-pauls Jul 16, 2021
69d52ba
Adding latest batch of plugin samples
jake-pauls Aug 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,28 @@ This repository contains a library of sample Photoshop plugins to help you on yo

## Samples list

| Extension | Main APIs Used | Description | Minimum Version |
| ----------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------- |
io-websocket-example | Spectrum UXP, Websocket | Shows how to use a websocket server & client in Photoshop | UXP 4.1 / PS 22.0.0
ui-kitchen-sink | Spectrum UXP, HTML | The kitchen sink example includes all of the available UI components, along with some sample usages. | UXP 4.1 / PS 22.0.0
ui-playground | Spectrum UXP, React | Playground for testing HTML, CSS, and JS snippets in Photoshop. | UXP 4.1 / PS 22.0.0
ui-react-starter | Spectrum UXP, React | Shows how to use React in a simple plugin | UXP 4.1 / PS 22.0.0
**If you're adding a sample to the repo, feel free to add it to this list.**

| Extension | Main APIs Used | Description | Minimum Version |
| --------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- |
| cross-compatible-js-sample | Spectrum UXP, BatchPlay, XD Scenegraph, Cross Compatibility | Demonstrates bundling a plugin that is compatible for both PS and XD development | UXP 4.1 / PS 22.0.0 / XD 36.0.0 |
| desktop-helper-sample | Spectrum UXP, React Spectrum, Electron, React, socket.io | Demonstrates using Electron and socket.io to communicate with a UXP plugin from a helper app | UXP 4.1 / PS 22.0.0 |
| direct-action-js-sample | Spectrum UXP, File I/O | Shows how to create a file containing the names of all layers in an active Photoshop document | UXP 4.1 / PS 22.0.0 |
| hello-world-js-sample | Photoshop API | Shows how to create basic UXP entrypoints in Photoshop using vanilla JS | UXP 4.1 / PS 22.0.0 |
| hello-world-panel-js-sample | Spectrum UXP | Shows how to create basic UI panels in Photoshop using vanilla JS | UXP 4.1 / PS 22.0.0 |
| io-websocket-example | Spectrum UXP, Websocket | Shows how to use a websocket server & client in Photoshop | UXP 4.1 / PS 22.0.0 |
| jszip-sample | Spectrum UXP, JSZip | Uses JSZip to manipulate artboards through importing and exporting zip files | UXP 4.1 / PS 22.0.0 |
| layer-creation-js-sample | Spectrum UXP, File I/O, BatchPlay | Creates a text layer using input from a local file in Photoshop | UXP 4.1 / PS 22.0.0 |
| oauth-workflow-sample | Spectrum UXP, Express | Implements a simple OAuth workflow using a server to interface a web API | UXP 4.1 / PS 22.0.0 |
| plugin-info-vue-full-app | Spectrum UXP, Vue, File I/O, Local Storage | Example of a fully developed UXP plugin with multiple entrypoints, application/platform specific UXP features, and File I/O best practices | UXP 4.1 / PS 22.0.0 |
| secure-storage-sample | Spectrum UXP, UXP Secure Storage | Demonstrates using UXP's Secure Storage API to store and retrieve local data | UXP 4.1 / PS 22.0.0 |
| ui-kitchen-sink | Spectrum UXP, HTML | The kitchen sink example includes all of the available UI components, along with some sample usages | UXP 4.1 / PS 22.0.0 |
| ui-playground | Spectrum UXP, React | Playground for testing HTML, CSS, and JS snippets in Photoshop | UXP 4.1 / PS 22.0.0 |
| ui-react-starter | Spectrum UXP, React | Shows how to use React in a simple plugin | UXP 4.1 / PS 22.0.0 |
| ui-svelte-starter | Spectrum UXP, Svelte | Shows how to use Svelte in a simple plugin | UXP 4.1 / PS 22.0.0 |
| ui-vue-starter | Spectrum UXP, Vue | Shows how to use Vue in a simple plugin | UXP 4.1 / PS 22.0.0 |
| wasm-rust-sample | Spectrum UXP, Rust, WebAssembly | Uses wasm-bindgen and Rust to leverage WebAssembly in a UXP plugin | UXP 4.1 / PS 22.0.0 |
| web-service-call-js-sample | Spectrum UXP, Fetch, BatchPlay | Creates a text layer in Photoshop containing data fetched from a web API | UXP 4.1 / PS 22.0.0 |

## Recommended development setup

Expand All @@ -19,6 +35,6 @@ ui-react-starter | Spectrum UXP, React | Shows how to use React in a simple plug
git clone [email protected]:AdobeDocs/uxp-photoshop-plugin-samples.git
```

2. Launch the [UXP Developer Tool](https://www.adobe.io/photoshop/uxp/devtool/), and use the "Add Plugin..." button to add each plugin to your workspace. (Select the `manifest.json` file inside each plugin's folder.)
2. Launch the [UXP Developer Tool](https://www.adobe.io/photoshop/uxp/devtool/) and use the "Add Plugin..." button to add each plugin to your workspace (select the `manifest.json` file indicated by your plugin's README, typically these are in the root, `plugin`, or `dist` folders)

3. Load plugins into Photoshop by using **••• > Load**.