# CellFrame

Source: /tuil/docs/reference/packages/cell/api/cell-frame
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 CellFrame {
  readonly width: number;
  readonly height: number;
  readonly cells: readonly Cell[];
  readonly cursor?: CursorState;
  readonly semantics?: RendererScene["semantics"];
}
```

## Members [#members]

| Member      | Type                                       | Required | Description                                                                          | Related types                                                             |
| ----------- | ------------------------------------------ | -------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| `width`     | `number`                                   | Yes      | The `width` member uses the `number` contract.                                       | —                                                                         |
| `height`    | `number`                                   | Yes      | The `height` member uses the `number` contract.                                      | —                                                                         |
| `cells`     | `readonly Cell[]`                          | Yes      | The `cells` member uses the `readonly Cell[]` contract.                              | [`Cell`](/tuil/docs/reference/packages/cell/api/cell)                          |
| `cursor`    | `CursorState \| undefined`                 | No       | The `cursor` member uses the `CursorState \| undefined` contract.                    | [`CursorState`](/tuil/docs/reference/packages/cell/api/cursor-state)           |
| `semantics` | `readonly SemanticMetadata[] \| undefined` | No       | The `semantics` member uses the `readonly SemanticMetadata[] \| undefined` contract. | [`SemanticMetadata`](/tuil/docs/reference/packages/core/api/semantic-metadata) |

## 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)
* [`CursorState`](/tuil/docs/reference/packages/cell/api/cursor-state)

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