# @types/react-codesandboxer

> TypeScript definitions for react-codesandboxer

Latest version **3.1.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-codesandboxer
pnpm add @types/react-codesandboxer
yarn add @types/react-codesandboxer
bun add @types/react-codesandboxer
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.1.4 |
| Published | 2023-11-07 |
| First published | 2021-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51442 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-codesandboxer
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-codesandboxer
- npm.io page: https://npm.io/package/@types/react-codesandboxer

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 3.1.4 (latest) — 2023-11-07
- 3.1.1 (ts3.6) — 2021-07-08
- 3.1.0 (ts3.4) — 2021-01-25
- 3.1.3 — 2023-10-18
- 3.1.2 — 2023-09-27

## README

# Installation
> `npm install --save @types/react-codesandboxer`

# Summary
This package contains type definitions for react-codesandboxer (https://github.com/codesandbox/codesandboxer#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-codesandboxer.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-codesandboxer/index.d.ts)
````ts
import * as React from "react";

export interface GitInfo {
    account: string;
    repository: string;
    branch?: string | undefined;
    host: "bitbucket" | "github";
}

export interface Files {
    [key: string]: { content: string };
}

export interface Package {
    name: string;
    version: string;
    dependencies: {
        [key: string]: string;
    };
    devDependencies: {
        [key: string]: string;
    };
    peerDependencies: {
        [key: string]: string;
    };
}

export type ImportReplacement = [string, string];

export interface Error {
    name: string;
    description?: string | undefined;
    content?: string | undefined;
}

export interface State {
    parameters: string;
    isLoading: boolean;
    isDeploying: boolean;
    sandboxId?: string | undefined;
    sandboxUrl?: string | undefined;
    deployPromise?: Promise<any> | undefined;
    files?: Files | undefined;
    error?: Error | undefined;
    fileName: string;
}

export interface Props {
    examplePath: string;
    name?: string | undefined;
    gitInfo: GitInfo;
    example?: string | Promise<string> | undefined;
    pkgJSON?: Package | string | Promise<Package | string> | undefined;
    importReplacements?: ImportReplacement[] | undefined;
    dependencies?: { [key: string]: string } | undefined;
    skipRedirect?: boolean | undefined;
    ignoreInternalImports?: boolean | undefined;
    preload?: boolean | undefined;
    autoDeploy?: boolean | undefined;
    onLoadComplete?:
        | ((
            arg: { parameters: string; files: Files } | { error: any },
        ) => unknown)
        | undefined;
    afterDeploy?: ((sandboxUrl: string, sandboxId: string) => unknown) | undefined;
    afterDeployError?: ((error: Error) => unknown) | undefined;
    providedFiles?: Files | undefined;
    children: (obj: {
        isLoading: boolean;
        files?: Files | undefined;
        sandboxId?: string | undefined;
        sandboxUrl?: string | undefined;
    }) => React.ReactNode;
    style?: object | undefined;
    extensions?: string[] | undefined;
    template?: "create-react-app" | "create-react-app-typescript" | "vue-cli" | undefined;
}

export default class CodeSandboxDeployer extends React.Component<Props, State> {}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [Nathan Bierema](https://github.com/Methuselah96).

---
_Source: https://npm.io/package/@types/react-codesandboxer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._