ngx-speculoos documentation
  1. Classes
  2. TestButton

File

src/lib/test-button.ts

Description

A wrapped button element, providing additional methods and attributes helping with writing tests

Extends

TestHtmlElement

Index

Methods
Accessors

Constructor

constructor(tester: ComponentTester<>, debugElement: DebugElement)
Defined in src/lib/test-button.ts:8
Parameters :
Name Type Optional
tester ComponentTester<> No
debugElement DebugElement No

Methods

Async click
click()
Inherited from TestHtmlElement
Defined in TestHtmlElement:16

Clicks on the wrapped element, then triggers a change detection

Returns : Promise<void>
attr
attr(name: string)
Inherited from TestElement
Defined in TestElement:66

Gets the attribute of the wrapped element with the given name

Parameters :
Name Type Optional Description
name string No

the name of the attribute to get
Returns : string | null
button
button(selector: string | Type)
Inherited from TestElement
Defined in TestElement:327

Gets the first button matched by the given selector. Throws an Error if the matched element isn't actually a button.

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
Returns : TestButton | null

the wrapped button, or null if no element was matched
component
component(selector: Type)
Inherited from TestElement
Defined in TestElement:335
Type parameters :
  • R

Gets the first directive matching the given component directive selector and returns its component instance

Parameters :
Name Type Optional Description
selector Type<R> No

the selector of a component directive
Returns : R
components
components(selector: Type)
Inherited from TestElement
Defined in TestElement:343
Type parameters :
  • R

Gets the directives matching the given component directive selector and returns their component instance

Parameters :
Name Type Optional Description
selector Type<R> No

the selector of a component directive
Returns : Array<R>
custom
custom(selector: string | Type, customTestElementType: Type)
Inherited from TestElement
Defined in TestElement:372
Type parameters :
  • E

Gets the element matching the given selector, and if found, creates and returns a custom TestElement of the provided type. This is useful to create custom higher-level abstractions similar to TestInput, TestSelect, etc. for custom elements or components.

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
customTestElementType Type<E> No

the type of the TestElement subclass that will wrap the found element
Returns : E | null
customs
customs(selector: string | Type, customTestElementType: Type)
Inherited from TestElement
Defined in TestElement:384
Type parameters :
  • E

Gets the elements matching the given selector, and creates and returns custom TestElements of the provided type. This is useful to create custom higher-level abstractions similar to TestInput, TestSelect, etc. for custom elements or components.

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
customTestElementType Type<E> No

the type of the TestElement subclass that will wrap the found elements
Returns : Array<E>
Async dispatchEvent
dispatchEvent(event: Event)
Inherited from TestElement
Defined in TestElement:50

dispatches the given event from the wrapped element, then triggers a change detection

Parameters :
Name Type Optional
event Event No
Returns : Promise<void>
Async dispatchEventOfType
dispatchEventOfType(type: string)
Inherited from TestElement
Defined in TestElement:42

dispatches an event of the given type from the wrapped element, then triggers a change detection

Parameters :
Name Type Optional
type string No
Returns : Promise<void>
element
element(selector: K)
Inherited from TestElement
Defined in TestElement:81
Type parameters :
  • K

Gets the first element matching the given CSS selector and wraps it into a TestElement. The actual type of the returned value is the TestElement subclass matching the type of the found element. So, if the matched element is an input for example, the method will return a TestInput.

Usage:

const testElement: TestHtmlElement<HTMLDivElement> | null = tester.element('div');
Parameters :
Name Type Optional Description
selector K No

a CSS selector
Returns : TestHtmlElement | null

the wrapped element, or null if no element matches the selector.
elements
elements(selector: K)
Inherited from TestElement
Defined in TestElement:193
Type parameters :
  • K

Gets all the elements matching the given CSS selector and wraps them into a TestElement. The actual type of the returned elements is the TestElement subclass matching the type of the found element. So, if the matched elements are inputs for example, the method will return an array of TestInput.

Usage:

const testElements: Array<TestHtmlElement<HTMLDivElement>> = tester.elements('div');
Parameters :
Name Type Optional Description
selector K No

a CSS selector
Returns : Array<TestHtmlElement<>>

the array of matched elements, empty if no element was matched
input
input(selector: string | Type)
Inherited from TestElement
Defined in TestElement:299

Gets the first input matched by the given selector. Throws an Error if the matched element isn't actually an input.

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
Returns : TestInput | null

the wrapped input, or null if no element was matched
select
select(selector: string | Type)
Inherited from TestElement
Defined in TestElement:308

Gets the first select matched by the given selector. Throws an Error if the matched element isn't actually a select.

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
Returns : TestSelect | null

the wrapped select, or null if no element was matched
textarea
textarea(selector: string | Type)
Inherited from TestElement
Defined in TestElement:318

Gets the first textarea matched by the given selector

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
Returns : TestTextArea | null

the wrapped textarea, or null if no element was matched. Throws an Error if the matched element isn't actually a textarea.
token
token(selector: string | Type, token: ProviderToken)
Inherited from TestElement
Defined in TestElement:352
Type parameters :
  • R

Gets the first element matching the given selector, then gets the given token from its injector, or null if there is no such token

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
token ProviderToken<R> No

the token to get from the matched element injector
Returns : R | null
tokens
tokens(selector: string | Type, token: ProviderToken)
Inherited from TestElement
Defined in TestElement:361
Type parameters :
  • R

Gets the elements matching the given selector, then gets their given token from their injector, or null if there is no such token

Parameters :
Name Type Optional Description
selector string | Type<any> No

a CSS or directive selector
token ProviderToken<R> No

the token to get from the matched element injector
Returns : Array<R | null>

Accessors

disabled
getdisabled()
Defined in src/lib/test-button.ts:16

the disabled flag of the button

Returns : boolean 
import { ComponentTester } from './component-tester';
import { TestHtmlElement } from './test-html-element';
import { DebugElement } from '@angular/core';

/**
 * A wrapped button element, providing additional methods and attributes helping with writing tests
 */
export class TestButton extends TestHtmlElement<HTMLButtonElement> {
  constructor(tester: ComponentTester<unknown>, debugElement: DebugElement) {
    super(tester, debugElement);
  }

  /**
   * the disabled flag of the button
   */
  get disabled(): boolean {
    return this.nativeElement.disabled;
  }
}

results matching ""

    No results matching ""