# PlaygroundNodeV1

Source: /tuil/docs/reference/packages/ghostty-web/api/playground-node-v1
Locale: en

export exported by @mwillbanks/tuil-ghostty-web.



{/* Generated by tooling/docs/generate-reference.ts. */}

## export [#export]

Public export exported by `@mwillbanks/tuil-ghostty-web`.

```ts
export interface PlaygroundNodeV1 {
  readonly id: string;
  readonly component: keyof typeof browserComponents;
  readonly props: Readonly<Record<string, unknown>>;
  readonly children?: readonly PlaygroundNodeV1[];
  readonly slots?: Readonly<Record<string, readonly PlaygroundNodeV1[]>>;
}
```

## Members [#members]

| Member      | Type                                                                                                                                                                                                                     | Required | Description                                                                                                                                                                                                                                                        | Related types                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`        | `string`                                                                                                                                                                                                                 | Yes      | The `id` member uses the `string` contract.                                                                                                                                                                                                                        | —                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `component` | `"Alert" \| "AppBar" \| "AppShell" \| "Badge" \| "Box" \| "Button" \| "Container" \| "Divider" \| "Heading" \| "HStack" \| "Progress" \| "ResponsiveStack" \| "Spinner" \| "Stack" \| "StatusBar" \| "Text" \| "VStack"` | Yes      | The `component` member uses the `"Alert" \| "AppBar" \| "AppShell" \| "Badge" \| "Box" \| "Button" \| "Container" \| "Divider" \| "Heading" \| "HStack" \| "Progress" \| "ResponsiveStack" \| "Spinner" \| "Stack" \| "StatusBar" \| "Text" \| "VStack"` contract. | [`Alert`](/tuil/docs/reference/packages/ink/api/alert), [`AppBar`](/tuil/docs/reference/packages/ink/api/app-bar), [`AppShell`](/tuil/docs/reference/packages/ink/api/app-shell), [`Badge`](/tuil/docs/reference/packages/ink/api/badge), [`Box`](/tuil/docs/reference/packages/ink/api/box), [`Button`](/tuil/docs/reference/packages/ink/api/button), [`Container`](/tuil/docs/reference/packages/ink/api/container), [`Divider`](/tuil/docs/reference/packages/ink/api/divider), [`HStack`](/tuil/docs/reference/packages/ink/api/hstack), [`Heading`](/tuil/docs/reference/packages/ink/api/heading), [`Progress`](/tuil/docs/reference/packages/ink/api/progress), [`ResponsiveStack`](/tuil/docs/reference/packages/ink/api/responsive-stack), [`Spinner`](/tuil/docs/reference/packages/ink/api/spinner), [`Stack`](/tuil/docs/reference/packages/ink/api/stack), [`StatusBar`](/tuil/docs/reference/packages/ink/api/status-bar), [`Text`](/tuil/docs/reference/packages/ink/api/text), [`VStack`](/tuil/docs/reference/packages/ink/api/vstack) |
| `props`     | `Readonly<Record<string, unknown>>`                                                                                                                                                                                      | Yes      | The `props` member uses the `Readonly<Record<string, unknown>>` contract.                                                                                                                                                                                          | —                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `children`  | `readonly PlaygroundNodeV1[] \| undefined`                                                                                                                                                                               | No       | The `children` member uses the `readonly PlaygroundNodeV1[] \| undefined` contract.                                                                                                                                                                                | [`PlaygroundNodeV1`](/tuil/docs/reference/packages/ghostty-web/api/playground-node-v1)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `slots`     | `Readonly<Record<string, readonly PlaygroundNodeV1[]>> \| undefined`                                                                                                                                                     | No       | The `slots` member uses the `Readonly<Record<string, readonly PlaygroundNodeV1[]>> \| undefined` contract.                                                                                                                                                         | [`PlaygroundNodeV1`](/tuil/docs/reference/packages/ghostty-web/api/playground-node-v1)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

No package-local related types.

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/ghostty-web/src/document.tsx)

## Package [#package]

[@mwillbanks/tuil-ghostty-web](/tuil/docs/reference/packages/ghostty-web)