vercel/satori

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

Open

#427 geöffnet am 12. März 2023

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)TypeScript (13.452 Stars) (352 Forks)user submission
good first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Familiarity with ReactUnderstanding of Satori playground codebase
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
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.