# CursorState

Source: /tuil/docs/reference/packages/cell/api/cursor-state
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 CursorState {
  readonly x: number;
  readonly y: number;
  readonly visible: boolean;
  readonly shape?: "block" | "line" | "underline";
}
```

## Members [#members]

| Member    | Type                                            | Required | Description                                                                           | Related types |
| --------- | ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------- | ------------- |
| `x`       | `number`                                        | Yes      | The `x` member uses the `number` contract.                                            | —             |
| `y`       | `number`                                        | Yes      | The `y` member uses the `number` contract.                                            | —             |
| `visible` | `boolean`                                       | Yes      | The `visible` member uses the `boolean` contract.                                     | —             |
| `shape`   | `"block" \| "line" \| "underline" \| undefined` | No       | The `shape` member uses the `"block" \| "line" \| "underline" \| undefined` contract. | —             |

## 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/cell/src/index.ts)

## Package [#package]

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