Package-level declarations
Types
Link copied to clipboard
typealias AllByAttribute = (attribute: String, container: HTMLElement, id: Matcher, options: MatcherOptions?) -> ReadonlyArray<HTMLElement>
Link copied to clipboard
typealias AllByBoundAttribute<T> = (container: HTMLElement, id: Matcher, options: MatcherOptions?) -> ReadonlyArray<T>
Link copied to clipboard
typealias AllByRole<T> = (container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions?) -> ReadonlyArray<T>
Link copied to clipboard
typealias AllByText<T> = (container: HTMLElement, id: Matcher, options: SelectorMatcherOptions?) -> ReadonlyArray<T>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias FindAllBy<Arguments> = QueryMethod<Tuple3<Any?, Any?, waitForOptions?>, Promise<ReadonlyArray<HTMLElement>>>
Link copied to clipboard
typealias FindAllByBoundAttribute<T> = (container: HTMLElement, id: Matcher, options: MatcherOptions?, waitForElementOptions: waitForOptions?) -> Promise<ReadonlyArray<T>>
Link copied to clipboard
typealias FindAllByRole<T> = (container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions?, waitForElementOptions: waitForOptions?) -> Promise<ReadonlyArray<T>>
Link copied to clipboard
typealias FindAllByText<T> = (container: HTMLElement, id: Matcher, options: SelectorMatcherOptions?, waitForElementOptions: waitForOptions?) -> Promise<ReadonlyArray<T>>
Link copied to clipboard
typealias FindBy<Arguments> = QueryMethod<Tuple3<Any?, Any?, waitForOptions?>, Promise<HTMLElement>>
Link copied to clipboard
typealias FindByBoundAttribute<T> = (container: HTMLElement, id: Matcher, options: MatcherOptions?, waitForElementOptions: waitForOptions?) -> Promise<T>
Link copied to clipboard
typealias FindByRole<T> = (container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions?, waitForElementOptions: waitForOptions?) -> Promise<T>
Link copied to clipboard
typealias FindByText<T> = (container: HTMLElement, id: Matcher, options: SelectorMatcherOptions?, waitForElementOptions: waitForOptions?) -> Promise<T>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias GetByBoundAttribute<T> = (container: HTMLElement, id: Matcher, options: MatcherOptions?) -> T
Link copied to clipboard
typealias GetByRole<T> = (container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions?) -> T
Link copied to clipboard
typealias GetByText<T> = (container: HTMLElement, id: Matcher, options: SelectorMatcherOptions?) -> T
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias Match = (textToMatch: String, node: HTMLElement?, matcher: Matcher, options: MatcherOptions?) -> Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias QueryByAttribute = (attribute: String, container: HTMLElement, id: Matcher, options: MatcherOptions?) -> HTMLElement?
Link copied to clipboard
typealias QueryByBoundAttribute<T> = (container: HTMLElement, id: Matcher, options: MatcherOptions?) -> T?
Link copied to clipboard
typealias QueryByRole<T> = (container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions?) -> T?
Link copied to clipboard
typealias QueryByText<T> = (container: HTMLElement, id: Matcher, options: SelectorMatcherOptions?) -> T?
Link copied to clipboard
query methods have a common call signature. Only the return type differs.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Properties
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Functions
Link copied to clipboard
external fun <Arguments : ReadonlyArray<Any?>> buildQueries(queryAllBy: GetAllBy<Arguments>, getMultipleError: GetErrorFunction<Arguments>, getMissingError: GetErrorFunction<Arguments>): BuiltQueryMethods<Arguments>
Link copied to clipboard
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByAltText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByAltTextAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByDisplayValue(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByDisplayValueAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByLabelText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByLabelTextAsync(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByPlaceholderText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByPlaceholderTextAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByRole(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByRoleAsync(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByTestId(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByTestIdAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByTextAsync(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findAllByTitle(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> findAllByTitleAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<ReadonlyArray<T>>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByAltText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByAltTextAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByDisplayValue(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByDisplayValueAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByLabelText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByLabelTextAsync(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByPlaceholderText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByPlaceholderTextAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByRole(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByRoleAsync(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByTestId(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByTestIdAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByTextAsync(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
suspend external fun <T : HTMLElement> findByTitle(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> findByTitleAsync(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally, waitForElementOptions: waitForOptions = definedExternally): Promise<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByAltText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByDisplayValue(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByLabelText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByPlaceholderText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByRole(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByTestId(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getAllByTitle(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> getByAltText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByDisplayValue(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByLabelText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByPlaceholderText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByRole(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByTestId(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): T
Link copied to clipboard
external fun <T : HTMLElement> getByTitle(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T
Link copied to clipboard
external fun getDefaultNormalizer(options: DefaultNormalizerOptions = definedExternally): NormalizerFn
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external fun <QueriesToBind : Queries, T : QueriesToBind> getQueriesForElement(element: HTMLElement, queriesToBind: T = definedExternally): BoundFunctions
Link copied to clipboard
Link copied to clipboard
external fun getSuggestedQuery(element: HTMLElement, variant: Variant = definedExternally, method: Method = definedExternally): Suggestion?
Link copied to clipboard
https://testing-library.com/docs/dom-testing-library/api-helpers#isinaccessible
Link copied to clipboard
external fun logDOM(dom: Element = definedExternally, maxLength: Double = definedExternally, options: PrettyDOMOptions = definedExternally)
external fun logDOM(dom: HTMLDocument = definedExternally, maxLength: Double = definedExternally, options: PrettyDOMOptions = definedExternally)
Link copied to clipboard
Link copied to clipboard
external fun prettyDOM(dom: Element = definedExternally, maxLength: Double = definedExternally, options: PrettyDOMOptions = definedExternally): Any
external fun prettyDOM(dom: HTMLDocument = definedExternally, maxLength: Double = definedExternally, options: PrettyDOMOptions = definedExternally): Any
Link copied to clipboard
external fun <T : HTMLElement> queryAllByAltText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByDisplayValue(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByLabelText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByPlaceholderText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByRole(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByTestId(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryAllByTitle(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T : HTMLElement> queryByAltText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByDisplayValue(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByLabelText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByPlaceholderText(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByRole(container: HTMLElement, role: ByRoleMatcher, options: ByRoleOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByTestId(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByText(container: HTMLElement, id: Matcher, options: SelectorMatcherOptions = definedExternally): T?
Link copied to clipboard
external fun <T : HTMLElement> queryByTitle(container: HTMLElement, id: Matcher, options: MatcherOptions = definedExternally): T?
Link copied to clipboard
suspend fun <T> waitFor(options: waitForOptions = undefined.unsafeCast<Nothing>(), fn: suspend CoroutineScope.() -> T): T
Link copied to clipboard
fun <T> waitForAsync(options: waitForOptions = undefined.unsafeCast<Nothing>(), fn: () -> PromiseLike<T>): Promise<T>
Link copied to clipboard
suspend external fun <T> waitForElementToBeRemoved(callback: T, options: waitForOptions = definedExternally): Void
suspend external fun <T> waitForElementToBeRemoved(callback: () -> T, options: waitForOptions = definedExternally): Void
Link copied to clipboard
external fun <T> waitForElementToBeRemovedAsync(callback: T, options: waitForOptions = definedExternally): Promise<Void>
external fun <T> waitForElementToBeRemovedAsync(callback: () -> T, options: waitForOptions = definedExternally): Promise<Void>
Link copied to clipboard
external fun <T> waitForRaw(callback: () -> PromiseResult<T>, options: waitForOptions = definedExternally): Promise<T>