> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tappify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# RenderWithTapOptions

> What renderWithTap takes: its own three options, plus every CreateTapMockOptions member it forwards to the mock.

What `renderWithTap` takes: its own three options, plus every
`CreateTapMockOptions` member it forwards to the mock.

## Extends

* [`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions)

## Properties

### confirmAnswer?

```ts theme={null}
optional confirmAnswer?: boolean;
```

What `tap.ui.confirm` resolves to. Defaults to `true`.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`confirmAnswer`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#confirmanswer)

***

### container?

```ts theme={null}
optional container?: HTMLElement;
```

Passed to Testing Library's `render`, for a mount point of your own.

***

### context?

```ts theme={null}
optional context?: Record<string, unknown>;
```

What `tap.context` holds. Defaults to empty.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`context`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#context)

***

### extensionId?

```ts theme={null}
optional extensionId?: string;
```

Defaults to `starter`, and has to match `handler`'s own extension id.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`extensionId`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#extensionid)

***

### extensionName?

```ts theme={null}
optional extensionName?: string;
```

Defaults to `Starter`.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`extensionName`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#extensionname)

***

### filters?

```ts theme={null}
optional filters?: Partial<TapFilters>;
```

Merged over the fixture filter bar.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`filters`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#filters)

***

### handler?

```ts theme={null}
optional handler?: TappifyFetchHandler;
```

Your own handler, so `tap.server.<name>` goes through its real routes.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`handler`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#handler)

***

### handlerToken?

```ts theme={null}
optional handlerToken?: string;
```

A token to send to `handler`. Defaults to one the mock signs itself.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`handlerToken`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#handlertoken)

***

### installId?

```ts theme={null}
optional installId?: string;
```

Defaults to `ins_test`.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`installId`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#installid)

***

### mock?

```ts theme={null}
optional mock?: TapMock;
```

A mock you built yourself. Given, every mock option here is ignored.

***

### params?

```ts theme={null}
optional params?: Record<string, string>;
```

What `tap.params` holds, in the host's positional shape. Defaults to empty.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`params`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#params)

***

### project?

```ts theme={null}
optional project?: Partial<{
  apps: TapApp[];
  id: string;
  keywords: TapKeyword[];
  name: string;
  platforms: TapPlatform[];
  releases: TapRelease[];
}>;
```

Merged over the fixture Northlight project.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`project`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#project)

***

### queryClient?

```ts theme={null}
optional queryClient?: QueryClient;
```

Your own client, for a test that reads the cache. Defaults to a fresh one.

***

### scopes?

```ts theme={null}
optional scopes?: (
  | "ui:render"
  | "projects:read"
  | "analytics:read"
  | "store.metadata:read"
  | "reviews:read"
  | "crashes:read"
  | "revenue:read"
  | "metrics:write"
  | "alerts:write"
  | "insights:write"
  | "ai:tools"
  | "ai:actions"
  | "store.metadata:write"
  | "autopilot:trigger"
  | "work:create"
  | "work:sync"
  | "storage:write"
  | "messaging:send"
  | "ai:skills")[];
```

What the install granted. Defaults to every scope.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`scopes`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#scopes)

***

### server?

```ts theme={null}
optional server?: Record<string, (input) => unknown>;
```

One function per procedure, answering `tap.server.<name>` in process.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`server`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#server)

***

### size?

```ts theme={null}
optional size?: TapSize;
```

What `tap.ui.size` reports. Defaults to `slot`.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`size`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#size)

***

### storage?

```ts theme={null}
optional storage?: Record<string, "singleton" | "collection">;
```

The collections to expose, and the kind of each. Left out, every name works.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`storage`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#storage)

***

### theme?

```ts theme={null}
optional theme?: "light" | "dark";
```

What `useTapTheme` reports. Defaults to `light`.

#### Inherited from

[`CreateTapMockOptions`](/extensions/reference/testing-api/Interface.CreateTapMockOptions).[`theme`](/extensions/reference/testing-api/Interface.CreateTapMockOptions#theme)