https://github.com/skaplanofficial/clickable-detail
A customized Detail component for Raycast that enables interaction via mouse clicks
https://github.com/skaplanofficial/clickable-detail
jxa mac macos node nodejs raycast
Last synced: 8 months ago
JSON representation
A customized Detail component for Raycast that enables interaction via mouse clicks
- Host: GitHub
- URL: https://github.com/skaplanofficial/clickable-detail
- Owner: SKaplanOfficial
- Created: 2023-05-30T05:40:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-30T05:40:21.000Z (about 3 years ago)
- Last Synced: 2025-02-10T19:41:07.862Z (over 1 year ago)
- Topics: jxa, mac, macos, node, nodejs, raycast
- Language: TypeScript
- Homepage:
- Size: 710 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# clickable-detail
A customized Detail component for Raycast that enables interaction via mouse clicks.
## Installation
```bash
npm install clickable-detail
```
> Upon install, the package will automatically add two `.scpt` scripts to your extension's `assets` folder, i.e.:
>
> - [DetectMouseClicks](./bin/DetectMouseInput.scpt) - Used to detect mouse clicks on the Raycast window.
> - [HTML2b64](./bin/HTML2b64.scpt) - Used to convert HTML and URLs to base64-encoded PNG strings.
>
> These scripts are necessary for the package to work, but you can modify them if you wish (e.g. if you want to customize the SVG that is used to render the clickable content). Use Script Editor on your Mac to view/edit the source code.
## Usage
### Overview
```tsx
import {
ClickableDetail,
DynamicSVG,
HTML,
INPUT,
Image,
Polygon,
Toggle,
usePreloadedImages,
useToggleDelegate,
} from "clickable-detail";
import { runAppleScript } from "run-applescript";
export default function Command() {
// Preload images so they are ready to be used when the SVG is rendered
const images = usePreloadedImages(["https://placeholder.pics/svg/200x100"]);
// Delegates are used to keep track of state
const toggleDelegate = useToggleDelegate(false);
return (
{/* High-level, stateful components provided (More to be added soon) */}
runAppleScript(`display dialog "You toggled Option 1"`)}
/>
{/* Include external images */}
{/* Click handlers can access the (x, y) coordinate of the click */}
console.log(`Clicked at (${loc.x}, ${loc.y})`)}/>
{/* Supports HTML using JSX syntax */}
{/* Supports applying styles to HTML elements */}
{`
#paragraph1 {
color: red;
}
`}
{/* Use React's built-in HTML components */}
Can render arbitrary HTML content
{/* For additional functionality, use package-provided components -- just uppercase the normal tag and add, e.g., a click handler */}
console.log("Submitted!")} x={10} y={215} width={55} height={25} />
);
}
```
The `ClickableDetail` component works similarly to the built-in `Detail` component, but with a few key differences:
- You do not provide a `markdown` prop — it will be automatically generated from `ClickableDetail`'s children.
- As of now, the `metadata` prop is not supported, but will be in the future.
## How does it work?
There two two main aspects to this package:
1. Rendering clickable content
2. Listening for mouse clicks
For the first part, the `ClickableDetail` component uses a dynamically generated SVG to display content beyond what Detail normally supports. The SVG can be sourced from anywhere, but the provided [DynamicSVG](./lib/DynamicSVG.tsx), built specifically for this package, is highly recommended. It supports not just creating SVGs using JSX syntax, but also embedding HTML content, external URLs, and click handlers for SVG elements.
To enable mouse clicks, the `ClickableDetail` component uses a JXA child process to monitor mouse clicks on the Raycast window. When a click is detected, `ClickableDetail` will determine if the click was on an SVG element that has a click handler. If so, the click handler will be called.