stackblitz / stackblitz/sdk

Support for setting title/description when embedding projects

Open
#30 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
50
Forks
32
PR merge metrics
No merged PRs in 30d

Description

When embedding using the SDK, e.g. using sdk.embedGithubProject(...) there is no way to control the title and description for the displayed project.

For projects saved on StackBlitz this can be edited manually, but in cases like GitHub, the title is derived from the file path and there doesn’t appear to be any way to control it. You can theoretically set this with the title and description query parameters on the iframe URL, but setting that as part of the repoPath argument doesn’t work because the internal SDK code then appends ?embed=1 to that, resulting in ?embed=1 being appended to the final query parameter.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the SDK implementation behind sdk.embedGithubProject(...) and inspect how the repoPath argument is combined with the iframe query string. Done means callers can control the embedded project's title and description without malformed or conflicting query parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.