# renderTuil

Source: /tuil/docs/reference/packages/testing-ink/api/render-tuil
Locale: en

function exported by @mwillbanks/tuil-testing-ink.



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

## function [#function]

Public function exported by `@mwillbanks/tuil-testing-ink`.

```ts
export function renderTuil(
  component: ReactElement,
  options: Omit<TuilAppOptions, "component"> = {},
): TuilTestInstance;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member      | Type                                | Required | Description                                                          | Related types                                                          |
| ----------- | ----------------------------------- | -------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `component` | `ReactElement`                      | Yes      | Supplies the `component` value as `ReactElement`.                    | —                                                                      |
| `options`   | `Omit<TuilAppOptions, "component">` | No       | Supplies the `options` value as `Omit<TuilAppOptions, "component">`. | [`TuilAppOptions`](/tuil/docs/reference/packages/tuil/api/tuil-app-options) |

## Returns [#returns]

`TuilTestInstance` — Returns a value that satisfies `TuilTestInstance`.

Related types: [`TuilTestInstance`](/tuil/docs/reference/packages/testing-ink/api/tuil-test-instance)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`TuilTestInstance`](/tuil/docs/reference/packages/testing-ink/api/tuil-test-instance)

## Source [#source]

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

## Package [#package]

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