{"id":26914525,"url":"https://github.com/danielmeloalencar/stackblitz-sdk-react","last_synced_at":"2026-02-23T14:31:14.074Z","repository":{"id":285484104,"uuid":"958303166","full_name":"danielmeloalencar/stackblitz-sdk-react","owner":"danielmeloalencar","description":"A unofficial React wrapper for the StackBlitz SDK that makes it easy to embed interactive code editors in React applications.","archived":false,"fork":false,"pushed_at":"2025-04-01T02:17:30.000Z","size":32,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-25T05:49:33.067Z","etag":null,"topics":["nextjs","react","sdk","stackblitz","stackblitz-react-sdk","stackblitz-sdk"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielmeloalencar.png","metadata":{"files":{"readme":"README-pt.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-01T01:21:02.000Z","updated_at":"2025-04-01T02:17:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"7f6fef70-d9f5-4088-8c6b-db5022cc6074","html_url":"https://github.com/danielmeloalencar/stackblitz-sdk-react","commit_stats":null,"previous_names":["danielmeloalencar/stackblitz-sdk-react"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/danielmeloalencar/stackblitz-sdk-react","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielmeloalencar%2Fstackblitz-sdk-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielmeloalencar%2Fstackblitz-sdk-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielmeloalencar%2Fstackblitz-sdk-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielmeloalencar%2Fstackblitz-sdk-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielmeloalencar","download_url":"https://codeload.github.com/danielmeloalencar/stackblitz-sdk-react/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielmeloalencar%2Fstackblitz-sdk-react/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29745520,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","react","sdk","stackblitz","stackblitz-react-sdk","stackblitz-sdk"],"created_at":"2025-04-01T17:28:38.725Z","updated_at":"2026-02-23T14:31:14.069Z","avatar_url":"https://github.com/danielmeloalencar.png","language":"JavaScript","readme":"# StackBlitz SDK React Wrapper\n[English Version](README.md)\n\nUm wrapper React não oficial para o SDK do StackBlitz que facilita a incorporação de editores de código interativos em aplicações React.\n\n## Índice\n\n- [Instalação](#instalação)\n- [Visão Geral](#visão-geral)\n- [Componentes](#componentes)\n  - [Editor](#editor)\n  - [ProjectEditor](#projecteditor)\n  - [ProjectIdEditor](#projecteditor)\n- [Funções Auxiliares](#funções-auxiliares)\n- [Exemplos de Uso](#exemplos-de-uso)\n- [API VM do StackBlitz](#api-vm-do-stackblitz)\n- [Hooks Personalizados](#hooks-personalizados)\n\n## Instalação\n\n```bash\nnpm install @stackblitz-react/sdk\n```\n\nEm seguida, importe o wrapper em seus componentes:\n\n```javascript\nimport {stackBlitz} from '@stackblitz-react/sdk';\n```\n\n## Visão Geral\n\nEste wrapper fornece uma interface React para o SDK do StackBlitz, permitindo que você facilmente:\n\n- Incorpore projetos do GitHub em sua aplicação\n- Crie projetos com arquivos personalizados\n- Incorpore projetos existentes do StackBlitz usando seu ID\n- Interaja com o editor em tempo real através da API VM\n\n## Componentes\n\n### Editor\n\nComponente para incorporar projetos do GitHub em sua aplicação.\n\n#### Props\n\n| Prop | Tipo | Padrão | Descrição |\n|------|------|--------|-----------|\n| embedId | string | 'stackblitz-container' | ID do elemento onde o editor será incorporado |\n| github | string | - | Repositório do GitHub no formato 'usuario/repositorio' |\n| openFile | string/boolean | false | Arquivo a ser aberto inicialmente |\n| hideNavigation | boolean | false | Se deve ocultar a navegação |\n| hideExplorer | boolean | false | Se deve ocultar o explorador de arquivos |\n| view | string | 'both' | Tipo de visualização ('preview', 'editor', 'both') |\n| height | string/number | 500 | Altura do editor |\n| width | string/number | '100%' | Largura do editor |\n| options | object | {} | Opções adicionais de configuração |\n| onLoad | function | null | Callback chamado quando a VM é carregada |\n\n#### Exemplo\n\n```jsx\n\u003cstackBlitz.Editor\n  embedId=\"github-editor-example\"\n  github=\"usuario/repositorio\"\n  openFile=\"README.md\"\n  height=\"400px\"\n  width=\"100%\"\n  view=\"editor\"\n  onLoad={(vm) =\u003e console.log('VM carregada', vm)}\n/\u003e\n```\n\n### ProjectEditor\n\nComponente para criar projetos com arquivos personalizados.\n\n#### Props\n\n| Prop | Tipo | Padrão | Descrição |\n|------|------|--------|-----------|\n| embedId | string | 'stackblitz-project-editor' | ID do elemento onde o editor será incorporado |\n| template | string | 'javascript' | Tipo de projeto (javascript, node, react, etc) |\n| title | string | 'Projeto StackBlitz' | Título do projeto |\n| description | string | '' | Descrição do projeto |\n| files | object | {} | Objeto com arquivos do projeto e seus conteúdos |\n| openFile | string/boolean | false | Arquivo a ser aberto inicialmente |\n| hideNavigation | boolean | false | Se deve ocultar a navegação |\n| hideExplorer | boolean | false | Se deve ocultar o explorador de arquivos |\n| view | string | 'editor' | Tipo de visualização ('preview', 'editor', 'both') |\n| height | string/number | 500 | Altura do editor |\n| width | string/number | '100%' | Largura do editor |\n| options | object | {} | Opções adicionais de configuração |\n| onLoad | function | null | Callback chamado quando a VM é carregada |\n\n#### Exemplo\n\n```jsx\n\u003cstackBlitz.ProjectEditor\n  embedId=\"custom-editor-example\"\n  template=\"node\"\n  title=\"Exemplo de Node.js\"\n  files={{\n    'index.js': 'console.log(\"Olá do StackBlitz!\");',\n    'package.json': JSON.stringify({\n      name: \"node-starter\",\n      version: \"0.0.0\",\n      private: true,\n      scripts: {\n        start: \"node index.js\"\n      }\n    }, null, 2)\n  }}\n  height=\"400px\"\n  width=\"100%\"\n  view=\"editor\"\n  onLoad={(vm) =\u003e console.log('VM carregada', vm)}\n/\u003e\n```\n\n### ProjectIdEditor\n\nComponente para incorporar projetos existentes do StackBlitz usando seu ID.\n\n#### Props\n\n| Prop | Tipo | Padrão | Descrição |\n|------|------|--------|-----------|\n| embedId | string | 'stackblitz-project-id-editor' | ID do elemento onde o editor será incorporado |\n| projectId | string | - | ID do projeto do StackBlitz a ser incorporado |\n| openFile | string | - | Arquivo a ser aberto inicialmente |\n| hideNavigation | boolean | false | Se deve ocultar a navegação |\n| hideExplorer | boolean | false | Se deve ocultar o explorador de arquivos |\n| view | string | 'editor' | Tipo de visualização ('preview', 'editor', 'both') |\n| height | string/number | 500 | Altura do editor |\n| width | string/number | '100%' | Largura do editor |\n| options | object | {} | Opções adicionais de configuração |\n| onLoad | function | null | Callback chamado quando a VM é carregada |\n\n#### Exemplo\n\n```jsx\n\u003cstackBlitz.ProjectIdEditor\n  embedId=\"project-id-editor-example\"\n  projectId=\"sdk-example-project\"\n  openFile=\"index.js\"\n  height=\"500px\"\n  width=\"100%\"\n  view=\"both\"\n  onLoad={(vm) =\u003e console.log('VM carregada', vm)}\n/\u003e\n```\n\n## Funções Auxiliares\n\nO wrapper também fornece funções auxiliares para abrir projetos em novas abas ou incorporá-los diretamente sem componentes React.\n\n### openGithubProject\n\nAbre um projeto do GitHub em uma nova aba.\n\n```javascript\nstackBlitz.openGithubProject('usuario/repositorio', {\n  openFile: 'README.md'\n});\n```\n\n### openProject\n\nAbre um projeto personalizado em uma nova aba.\n\n```javascript\nstackBlitz.openProject({\n  template: 'node',\n  title: 'Projeto Node.js de exemplo',\n  description: 'Um projeto Node.js simples',\n  files: {\n    'index.js': 'console.log(\"Olá do StackBlitz!\");',\n    'package.json': JSON.stringify({\n      name: \"node-starter\",\n      version: \"0.0.0\",\n      private: true,\n      scripts: {\n        start: \"node index.js\"\n      }\n    }, null, 2)\n  }\n});\n```\n\n### openProjectId\n\nAbre um projeto do StackBlitz pelo ID em uma nova aba.\n\n```javascript\nstackBlitz.openProjectId('sdk-example-project', {\n  openFile: 'index.html',\n  view: 'both'\n});\n```\n\n### embedGithubProject\n\nIncorpora um projeto do GitHub em um elemento da DOM.\n\n```javascript\nstackBlitz.embedGithubProject('element-id', 'usuario/repositorio', {\n  openFile: 'README.md',\n  height: 500\n}).then(vm =\u003e {\n  console.log('VM carregada', vm);\n});\n```\n\n### embedProject\n\nIncorpora um projeto personalizado em um elemento da DOM.\n\n```javascript\nstackBlitz.embedProject('element-id', {\n  template: 'node',\n  title: 'Projeto Node.js',\n  files: {\n    'index.js': 'console.log(\"Olá do StackBlitz!\");'\n  }\n}, {\n  height: 500\n}).then(vm =\u003e {\n  console.log('VM carregada', vm);\n});\n```\n\n### embedProjectId\n\nIncorpora um projeto do StackBlitz pelo ID em um elemento da DOM.\n\n```javascript\nstackBlitz.embedProjectId('element-id', 'sdk-example-project', {\n  openFile: 'index.js',\n  height: 500\n}).then(vm =\u003e {\n  console.log('VM carregada', vm);\n});\n```\n\n## Exemplos de Uso\n\n### Incorporando um editor do GitHub\n\n```jsx\nimport React, { useCallback, useState } from 'react';\nimport stackBlitz from '../stackblitzEditor';\n\nexport default function ExemploGithubEditor() {\n  const [log, setLog] = useState([]);\n  \n  const handleVmReady = useCallback((vm) =\u003e {\n    setLog(prev =\u003e [...prev, 'VM inicializada com sucesso!']);\n    \n    // Exemplo de interação com a VM\n    vm.editor.openFile('README.md');\n  }, []);\n  \n  return (\n    \u003cdiv\u003e\n      \u003ch1\u003eEditor GitHub\u003c/h1\u003e\n      \u003cstackBlitz.Editor\n        embedId=\"github-editor-example\"\n        github=\"usuario/repositorio\"\n        openFile=\"README.md\"\n        height=\"400px\"\n        width=\"100%\"\n        view=\"editor\"\n        onLoad={handleVmReady}\n      /\u003e\n      \u003cdiv\u003e\n        {log.map((entry, index) =\u003e \u003cdiv key={index}\u003e{entry}\u003c/div\u003e)}\n      \u003c/div\u003e\n    \u003c/div\u003e\n  );\n}\n```\n\n### Criando um projeto com arquivos personalizados\n\n```jsx\nimport React from 'react';\nimport stackBlitz from '../stackblitzEditor';\n\nexport default function ExemploProjetoCustomizado() {\n  return (\n    \u003cdiv\u003e\n      \u003ch1\u003eProjeto Personalizado\u003c/h1\u003e\n      \u003cstackBlitz.ProjectEditor\n        embedId=\"custom-editor-example\"\n        template=\"node\"\n        title=\"Exemplo de Node.js\"\n        files={{\n          'index.js': 'console.log(\"Olá do StackBlitz!\");',\n          'package.json': JSON.stringify({\n            name: \"node-starter\",\n            version: \"0.0.0\",\n            private: true,\n            scripts: {\n              start: \"node index.js\"\n            }\n          }, null, 2)\n        }}\n        height=\"400px\"\n        width=\"100%\"\n        view=\"editor\"\n      /\u003e\n    \u003c/div\u003e\n  );\n}\n```\n\n## API VM do StackBlitz\n\nQuando você usa o callback `onLoad`, você recebe acesso à API VM do StackBlitz, que permite interagir com o editor em tempo real.\n\n### Principais métodos da VM\n\n#### applyFsDiff\n\nAplica alterações no sistema de arquivos.\n\n```javascript\nvm.applyFsDiff({\n  create: {\n    'novoArquivo.js': 'console.log(\"Novo arquivo\");'\n  },\n  destroy: ['arquivoAntigo.js']\n});\n```\n\n#### getFsSnapshot\n\nObtém um snapshot atual do sistema de arquivos.\n\n```javascript\nvm.getFsSnapshot().then(files =\u003e {\n  console.log('Arquivos disponíveis:', Object.keys(files));\n});\n```\n\n#### editor.openFile\n\nAbre um arquivo específico no editor.\n\n```javascript\nvm.editor.openFile('index.js');\n```\n\n#### preview.getUrl\n\nObtém a URL do preview.\n\n```javascript\nvm.preview.getUrl().then(url =\u003e {\n  console.log('URL do preview:', url);\n});\n```\n\n\n---\n\n## Limitações e Considerações\n\n- O StackBlitz SDK funciona apenas em navegadores modernos.\n- Projetos muito grandes podem levar mais tempo para carregar.\n---\n\n## Contribuição\n\nSinta-se à vontade para contribuir com este wrapper criando issues ou pull requests.\n\n## Licença\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielmeloalencar%2Fstackblitz-sdk-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielmeloalencar%2Fstackblitz-sdk-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielmeloalencar%2Fstackblitz-sdk-react/lists"}