reacl-c.test-util.dom-testing — de.active-group/reacl-c 0.10.16

all-of cljs

(all-of)

(all-of q)

(all-of q1 & more)

Query for all elements that match all of the given queries.

any-of cljs

(any-of)

(any-of q)

(any-of q1 & more)

Query for all elements that match any of the given queries.

anything cljs

base-element cljs

(base-element env)

Returns the base element used in the given rendering environment.

build-query-fn cljs

(build-query-fn query-all make-multi-error make-missing-error)

Creates a function that returns custom query like by-label-text, via a function that implements the 'query-all' logic, which should return a sequence of all matching nodes, and two functions that return an error message for the cases of finding more than one, resp. nothing at all.

For example:

  (def by-my-property (build-query-fn (fn [env v1] node-seq...) (fn [env v1] "Error") (fn [env v1] "Error")))

  (find node (by-my-property "foo"))

See https://testing-library.com/docs/react-testing-library/setup#add-custom-queries for some additional notes.

by-alt-text cljs

(by-alt-text text & options)

Query by the alternate text of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#byalttext

by-attribute cljs

(by-attribute attribute text & options)

Query by the given attribute, matching nodes where the attribute value matches the given string, regex of predicate text.

by-display-value cljs

(by-display-value text & options)

Query by the text shown in an input element. See https://testing-library.com/docs/dom-testing-library/api-queries#bydisplayvalue

by-label-text cljs

(by-label-text text & options)

Query by the label text of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#bylabeltext

by-placeholder-text cljs

(by-placeholder-text text & options)

Query by the placeholder text of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#byplaceholdertext

by-role cljs

(by-role text & options)

Query by the Aria role of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#byrole

by-test-id cljs

(by-test-id value & options)

Query by the test-id attribute of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#bytestid

by-text cljs

(by-text text & options)

Query by the text of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#bytext

by-title cljs

(by-title text & options)

Query by the title of a node. See https://testing-library.com/docs/dom-testing-library/api-queries#bytitle

container cljs

(container env)

Returns the container element used in the given rendering environment.

current-state cljs

(current-state env)

Returns the current state of the item running in the given rendering environemnt.

find cljs

(find env what & options)

Asynchronously returns the matching node. If none or more than one nodes match, this will repeat the search until a timeout expires and then throw an exception. Options are the same as for wait-for.

find-all cljs

(find-all env what & options)

Asynchronously returns all matching node. If no nodes match, this will repeat the search until a timeout expires and then throw an exception. Options are the same as for wait-for.

fire-event cljs

(fire-event node event & [event-properties])

Fire an event on the given DOM node, where event can be a DOM Event object, or a keywork like :click for standard events. See https://github.com/testing-library/dom-testing-library/blob/master/src/event-map.js for a list.

get cljs

(get env what)

Returns the matching node, and throws if none or more than one node matches.

For example (get env (by-text "Hello")) will find an element containing the text "Hello".

get-all cljs

(get-all env what)

Returns all matching nodes, but throws if no nodes match.

For example (get-all env (by-text "Hello")) will find all elements containing the text "Hello".

nothing cljs

pop-action! cljs

(pop-action! env)

(pop-action! env default)

Removes and returns an action that was previously emitted by the item running in the given rendering environment. Throws if action queueing is not enabled, either by the queue-actions? option to rendering, or by queue-actions. Also throws if the queue is empty, unless a second argument is provided, which is then returned instead.

Note that you can use wait-for to wait for an action that is emitted asynchronously.

pretty-dom cljs

(pretty-dom node)

Returns a string showing a pretty HTML markup corresponding to the given DOM node as good as possible.

query cljs

(query env what)

Returns matching node or nil, but throws if more than one node matches.

For example (query env (by-text "Hello")) will find an element containing the text "Hello".

query-all cljs

(query-all env what)

Returns all matching nodes.

For example (query-all env (by-text "Hello")) will find all elements containing the text "Hello".

queue-actions cljs

(queue-actions env thunk)

Enables action queueing during the evaluation of the given thunk. This has the same effect as setting the option :queue-actions? in the call to rendering otherwise. See pop-action! to check for queued actions.

rendering cljs

(rendering item & args)

Calls f with a rendering environment that 'runs' the given item. Options can be

• :state for the initial state of the item (defaulting to nil),
• :visible? specifying if the rendered dom should be made visible (the default looks at the hidden property of js/document),
• :configuration for configuration corresponing to https://testing-library.com/docs/dom-testing-library/api-configuration
• :container, :baseElement, :hydrate and :wrapper for rendering options corresponing to https://testing-library.com/docs/react-testing-library/api#render-options
• :queue-actions? to specify that actions emitted by the rendered item should be stored in a queue, accessible via pop-action!

Note that if f is asynchronous (returns a promise), then rendering will continue until the promise is resolved or rejected.

send-message! cljs

(send-message! env msg)

Sends a message to the item running in the given rendering environment.

set-state! cljs

(set-state! env state)

Changes the state of the item running in the given rendering component to a new value.

unmount! cljs

(unmount! env)

Stops rendering in the given rendering environment. You usually don't have to call this.

update! cljs

(update! env item)

(update! env item state)

Change the item and state rendered in the given rendering environment. If not state is given, the state will stay as it is.

wait-for clj macro

(wait-for expr & options)

Returns a promise that evaluates expr repeatedly until it does not throw or a timeout elapses. Options can be:

• :timeout the maximum number of milliseconds to wait,
• :interval the number of milliseconds to wait between to evaluationg of expr.

For more options see https://testing-library.com/docs/dom-testing-library/api-async#waitfor.

wait-for* cljs

(wait-for* f & options)

Functional version of the macro wait-for.

wait-for-removal clj macro

(wait-for-removal expr & options)

Returns a promise that evaluates expr repeatedly until it throws or a timeout elapses. Options can be:

• :timeout the maximum number of milliseconds to wait,
• :interval the number of milliseconds to wait between to evaluationg of expr.

For more options see https://testing-library.com/docs/dom-testing-library/api-async#waitfor.

wait-for-removal* cljs

(wait-for-removal* f & options)

Functional version of the macro wait-for-removal.

within cljs

(within base-q child-q)

Query for elements matching child-q within the elements matching base-q.

within-node cljs

(within-node base node)

Specifies node as different root node in element queries. base should be either a rendering environemnt, or the result of a previous call to within-node.