# CellSceneNode

Source: /tuil/docs/reference/packages/cell/api/cell-scene-node
Locale: en

interface exported by @mwillbanks/tuil-cell.



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

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-cell`.

```ts
export interface CellSceneNode {
  readonly id: string;
  readonly kind: "box" | "text";
  readonly text?: string;
  readonly children?: readonly CellSceneNode[];
  readonly direction?: "row" | "column";
  readonly position?: "flow" | "absolute" | "portal";
  readonly x?: number;
  readonly y?: number;
  readonly width?: number;
  readonly height?: number;
  readonly padding?: number;
  readonly margin?: number;
  readonly border?: boolean;
  readonly clip?: boolean;
  readonly zIndex?: number;
  readonly focusable?: boolean;
  readonly pointerEvents?: "auto" | "none";
  readonly scrollContainerId?: string;
  readonly semantics?: Omit<SemanticMetadata, "id">;
  readonly style?: Partial<Omit<Cell, "grapheme" | "continuation">>;
}
```

## Members [#members]

| Member              | Type                                                             | Required | Description                                                                                            | Related types                                                             |
| ------------------- | ---------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| `id`                | `string`                                                         | Yes      | The `id` member uses the `string` contract.                                                            | —                                                                         |
| `kind`              | `"box" \| "text"`                                                | Yes      | The `kind` member uses the `"box" \| "text"` contract.                                                 | —                                                                         |
| `text`              | `string \| undefined`                                            | No       | The `text` member uses the `string \| undefined` contract.                                             | —                                                                         |
| `children`          | `readonly CellSceneNode[] \| undefined`                          | No       | The `children` member uses the `readonly CellSceneNode[] \| undefined` contract.                       | [`CellSceneNode`](/tuil/docs/reference/packages/cell/api/cell-scene-node)      |
| `direction`         | `"row" \| "column" \| undefined`                                 | No       | The `direction` member uses the `"row" \| "column" \| undefined` contract.                             | —                                                                         |
| `position`          | `"flow" \| "absolute" \| "portal" \| undefined`                  | No       | The `position` member uses the `"flow" \| "absolute" \| "portal" \| undefined` contract.               | —                                                                         |
| `x`                 | `number \| undefined`                                            | No       | The `x` member uses the `number \| undefined` contract.                                                | —                                                                         |
| `y`                 | `number \| undefined`                                            | No       | The `y` member uses the `number \| undefined` contract.                                                | —                                                                         |
| `width`             | `number \| undefined`                                            | No       | The `width` member uses the `number \| undefined` contract.                                            | —                                                                         |
| `height`            | `number \| undefined`                                            | No       | The `height` member uses the `number \| undefined` contract.                                           | —                                                                         |
| `padding`           | `number \| undefined`                                            | No       | The `padding` member uses the `number \| undefined` contract.                                          | —                                                                         |
| `margin`            | `number \| undefined`                                            | No       | The `margin` member uses the `number \| undefined` contract.                                           | —                                                                         |
| `border`            | `boolean \| undefined`                                           | No       | The `border` member uses the `boolean \| undefined` contract.                                          | —                                                                         |
| `clip`              | `boolean \| undefined`                                           | No       | The `clip` member uses the `boolean \| undefined` contract.                                            | —                                                                         |
| `zIndex`            | `number \| undefined`                                            | No       | The `zIndex` member uses the `number \| undefined` contract.                                           | —                                                                         |
| `focusable`         | `boolean \| undefined`                                           | No       | The `focusable` member uses the `boolean \| undefined` contract.                                       | —                                                                         |
| `pointerEvents`     | `"auto" \| "none" \| undefined`                                  | No       | The `pointerEvents` member uses the `"auto" \| "none" \| undefined` contract.                          | —                                                                         |
| `scrollContainerId` | `string \| undefined`                                            | No       | The `scrollContainerId` member uses the `string \| undefined` contract.                                | —                                                                         |
| `semantics`         | `Omit<SemanticMetadata, "id"> \| undefined`                      | No       | The `semantics` member uses the `Omit<SemanticMetadata, "id"> \| undefined` contract.                  | [`SemanticMetadata`](/tuil/docs/reference/packages/core/api/semantic-metadata) |
| `style`             | `Partial<Omit<Cell, "grapheme" \| "continuation">> \| undefined` | No       | The `style` member uses the `Partial<Omit<Cell, "grapheme" \| "continuation">> \| undefined` contract. | [`Cell`](/tuil/docs/reference/packages/cell/api/cell)                          |

## 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]

* [`Cell`](/tuil/docs/reference/packages/cell/api/cell)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/cell/src/index.ts)

## Package [#package]

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