Skip to main content

renderWithRouter()

function renderWithRouter(ui: ReactElement, __namedParameters?: Args): {
  asFragment: () => DocumentFragment;
  baseElement: HTMLElement;
  container: HTMLElement;
  debug: (baseElement?: Element | DocumentFragment | (Element | DocumentFragment)[], maxLength?: number, options?: PrettyFormatOptions) => void;
  findAllByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findAllByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;
  findAllByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findAllByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;
  findByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  getAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  getAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];
  getAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  getAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;
  getByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement;
  getByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;
  getByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  history: History;
  queryAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  queryAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];
  queryAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  queryAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;
  queryByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement | null;
  queryByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;
  queryByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  rerender: (ui: ReactNode) => void;
  unmount: () => void;
};

Parameters​

ui​

ReactElement

__namedParameters?​

Args = ...

Returns​

{
  asFragment: () => DocumentFragment;
  baseElement: HTMLElement;
  container: HTMLElement;
  debug: (baseElement?: Element | DocumentFragment | (Element | DocumentFragment)[], maxLength?: number, options?: PrettyFormatOptions) => void;
  findAllByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findAllByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;
  findAllByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findAllByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findAllByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;
  findByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  findByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;
  findByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;
  getAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  getAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];
  getAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  getAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  getByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;
  getByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement;
  getByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  getByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;
  getByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement;
  history: History;
  queryAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  queryAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];
  queryAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];
  queryAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];
  queryByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;
  queryByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement | null;
  queryByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  queryByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;
  queryByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;
  rerender: (ui: ReactNode) => void;
  unmount: () => void;
}

asFragment​

asFragment: () => DocumentFragment;

Returns​

DocumentFragment

baseElement​

baseElement: HTMLElement;

container​

container: HTMLElement;

debug​

debug: (baseElement?: Element | DocumentFragment | (Element | DocumentFragment)[], maxLength?: number, options?: PrettyFormatOptions) => void;

Parameters​

baseElement?​

Element | DocumentFragment | (Element | DocumentFragment)[]

maxLength?​

number

options?​

PrettyFormatOptions

Returns​

void

findAllByAltText​

findAllByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findAllByDisplayValue​

findAllByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findAllByLabelText​

findAllByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, SelectorMatcherOptions, waitForOptions]

Returns​

Promise

findAllByPlaceholderText​

findAllByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findAllByRole​

findAllByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;

Parameters​

args​

...[ByRoleMatcher, ByRoleOptions, waitForOptions]

Returns​

Promise

findAllByTestId​

findAllByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findAllByText​

findAllByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, SelectorMatcherOptions, waitForOptions]

Returns​

Promise

findAllByTitle​

findAllByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findByAltText​

findByAltText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findByDisplayValue​

findByDisplayValue: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findByLabelText​

findByLabelText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, SelectorMatcherOptions, waitForOptions]

Returns​

Promise

findByPlaceholderText​

findByPlaceholderText: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findByRole​

findByRole: (...args: [ByRoleMatcher, ByRoleOptions, waitForOptions]) => Promise;

Parameters​

args​

...[ByRoleMatcher, ByRoleOptions, waitForOptions]

Returns​

Promise

findByTestId​

findByTestId: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

findByText​

findByText: (...args: [Matcher, SelectorMatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, SelectorMatcherOptions, waitForOptions]

Returns​

Promise

findByTitle​

findByTitle: (...args: [Matcher, MatcherOptions, waitForOptions]) => Promise;

Parameters​

args​

...[Matcher, MatcherOptions, waitForOptions]

Returns​

Promise

getAllByAltText​

getAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

getAllByDisplayValue​

getAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

getAllByLabelText​

getAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement[]

getAllByPlaceholderText​

getAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

getAllByRole​

getAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];

Parameters​

args​

...[ByRoleMatcher, ByRoleOptions]

Returns​

HTMLElement[]

getAllByTestId​

getAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

getAllByText​

getAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement[]

getAllByTitle​

getAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

getByAltText​

getByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement

getByDisplayValue​

getByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement

getByLabelText​

getByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement

getByPlaceholderText​

getByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement

getByRole​

getByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement;

Parameters​

args​

...[ByRoleMatcher, ByRoleOptions]

Returns​

HTMLElement

getByTestId​

getByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement

getByText​

getByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement

getByTitle​

getByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement

history​

history: History;

queryAllByAltText​

queryAllByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

queryAllByDisplayValue​

queryAllByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

queryAllByLabelText​

queryAllByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement[]

queryAllByPlaceholderText​

queryAllByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

queryAllByRole​

queryAllByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement[];

Parameters​

args​

...[ByRoleMatcher, ByRoleOptions]

Returns​

HTMLElement[]

queryAllByTestId​

queryAllByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

queryAllByText​

queryAllByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement[]

queryAllByTitle​

queryAllByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement[];

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement[]

queryByAltText​

queryByAltText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement | null

queryByDisplayValue​

queryByDisplayValue: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement | null

queryByLabelText​

queryByLabelText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement | null

queryByPlaceholderText​

queryByPlaceholderText: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement | null

queryByRole​

queryByRole: (...args: [ByRoleMatcher, ByRoleOptions]) => HTMLElement | null;

Parameters​

args​

...[ByRoleMatcher, ByRoleOptions]

Returns​

HTMLElement | null

queryByTestId​

queryByTestId: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement | null

queryByText​

queryByText: (...args: [Matcher, SelectorMatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, SelectorMatcherOptions]

Returns​

HTMLElement | null

queryByTitle​

queryByTitle: (...args: [Matcher, MatcherOptions]) => HTMLElement | null;

Parameters​

args​

...[Matcher, MatcherOptions]

Returns​

HTMLElement | null

rerender​

rerender: (ui: ReactNode) => void;

Parameters​

ui​

ReactNode

Returns​

void

unmount​

unmount: () => void;

Returns​

void