vercel/satori

Playground support for the object syntax (ie. use without JSX)

Open

#427 opened on Mar 12, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)TypeScript (13,452 stars) (352 forks)user submission
good first issue

Description

Feature Request

Description

Per the readme, Satori supports JSX (with a transpiler enabled), and also a React-like object syntax with type, props.children, and props.style fields. It would be nice if this syntax was usable on the playground as a toggle.

Additional Context

Using Satori without a transpiler, you end up needing to constantly tweak your structure, rerun the script, and re-check the output, in order to iteratively develop and tinker on Satori-made images. When I was previously using Satori with a transpiler, this was easy, thanks to the playground.

Contributor guide

Tech stack
typescriptreact
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with ReactUnderstanding of Satori playground codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The playground likely has a component for code input/editor. Look at the playground source code in the repository (likely under a 'site' or 'playground' directory). The goal is to add a toggle that switches between JSX (with transpiler) and object syntax. Study how the current playground handles parsing and rendering. Check if any existing UI components (e.g., a dropdown) can be reused. Consider how the object syntax examples are provided in the documentation to inform the implementation.