Struct Options

pub struct Options {
    pub computed_style_supports_pseudo_elements: Option<bool>,
    pub default_hidden: Option<bool>,
    pub default_ignore: Option<String>,
    pub show_original_stack_trace: Option<bool>,
    pub throw_suggestions: Option<bool>,
    pub test_id_attribute: Option<String>,
    pub async_util_timeout: Option<u64>,
}

Configuration options for the testing library

Fields

computed_style_supports_pseudo_elements: Option<bool>

Set to true if window.getComputedStyle supports pseudo-elements i.e. a second argument. If you’re using testing-library in a browser you almost always want to set this to true. Only very old browser don’t support this property (such as IE 8 and earlier). However, jsdom does not support the second argument currently. This includes versions of jsdom prior to 16.4.0 and any version that logs a not implemented warning when calling getComputedStyle with a second argument e.g. window.getComputedStyle(document.createElement(‘div’), ‘::after’). Defaults to false

default_hidden: Option<bool>

The default value for the hidden option used by getByRole. Defaults to false.

default_ignore: Option<String>

The default value for the ignore option used by getByText. Also determines the nodes that are being ignored when errors are printed. Defaults to “script, style”.

show_original_stack_trace: Option<bool>

By default, waitFor will ensure that the stack trace for errors thrown by Testing Library is cleaned up and shortened so it’s easier for you to identify the part of your code that resulted in the error (async stack traces are hard to debug). If you want to disable this, then set showOriginalStackTrace to false. You can also disable this for a specific call in the options you pass to waitFor.

throw_suggestions: Option<bool>

When enabled, if better queries are available, the test will fail and provide a suggested query to use instead. Defaults to false.

test_id_attribute: Option<String>

The attribute used by getByTestId and related queries. Defaults to “data-testid”.

async_util_timeout: Option<u64>

The global timeout value in milliseconds used by waitFor utilities. Defaults to 1000ms.

Implementations

impl Options

pub fn new() -> Self

Creates a new Options instance with all values set to None

pub fn with_computed_style_supports_pseudo_elements(self, value: bool) -> Self

Builder method to set computed_style_supports_pseudo_elements

pub fn with_default_hidden(self, value: bool) -> Self

Builder method to set default_hidden

pub fn with_default_ignore(self, value: &str) -> Self

Builder method to set default_ignore

pub fn with_show_original_stack_trace(self, value: bool) -> Self

Builder method to set show_original_stack_trace

pub fn with_throw_suggestions(self, value: bool) -> Self

Builder method to set throw_suggestions

pub fn with_test_id_attribute(self, value: &str) -> Self

Builder method to set test_id_attribute

pub fn with_async_util_timeout(self, value: u64) -> Self

Builder method to set async_util_timeout

pub fn to_json_string(&self) -> Result<String, Error>

Serialize the options to JSON string

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Options

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Options

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.