Skip to content

fix(types): allow bound function to accept string and regex matcher #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 17, 2020
Merged

fix(types): allow bound function to accept string and regex matcher #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4db6d2
test: reproduce issue
timdeschryver Jul 3, 2020
ea7a71d
fix: by role types
timdeschryver Jul 3, 2020
8391d49
revert "fix: by role types"
timdeschryver Jul 7, 2020
1582c73
fix(types): allow bound function to accept string and regex matcher
timdeschryver Jul 7, 2020
6637beb
refactor: replace String with workaround to allow intellisense
timdeschryver Jul 7, 2020
5d628fa
Merge branch 'master' into pr/680
eps1lon Jul 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions types/__tests__/type-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,9 @@ async function testByRole() {

// allow to query for a role that isn't included in the types
console.assert(queryByRole(element, 'foo') === null)
console.assert(queryByRole(element, /foo/) === null)
console.assert(screen.queryByRole('foo') === null)
console.assert(screen.queryByRole(/foo/) === null)
}

function testA11yHelper() {
Expand Down
6 changes: 6 additions & 0 deletions types/matches.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import {ARIARole} from 'aria-query'

export type MatcherFunction = (content: string, element: HTMLElement) => boolean
export type Matcher = string | RegExp | MatcherFunction

// Get autocomplete for ARIARole union types, while still supporting another string
// Ref: https://github.com/microsoft/TypeScript/issues/29729#issuecomment-505826972
export type ByRoleMatcher = ARIARole | (string & {}) | RegExp | MatcherFunction

export type NormalizerFn = (text: string) => string

export interface MatcherOptions {
Expand Down
75 changes: 22 additions & 53 deletions types/queries.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import {Matcher, MatcherOptions} from './matches'
import {Matcher, MatcherOptions, ByRoleMatcher} from './matches'
import {SelectorMatcherOptions} from './query-helpers'
import {waitForOptions} from './wait-for'
import {ARIARole} from 'aria-query'

export type QueryByBoundAttribute = (
container: HTMLElement,
Expand Down Expand Up @@ -98,67 +97,37 @@ export interface ByRoleOptions extends MatcherOptions {
| ((accessibleName: string, element: Element) => boolean)
}

// disable unified-signatures to have intellisense for aria roles
/* tslint:disable:unified-signatures */
export function AllByRole(
export type AllByRole = (
container: HTMLElement,
role: Matcher,
role: ByRoleMatcher,
options?: ByRoleOptions,
): HTMLElement[]
export function AllByRole(
container: HTMLElement,
role: ARIARole,
options?: ByRoleOptions,
): HTMLElement[]
) => HTMLElement[]

export function GetByRole(
container: HTMLElement,
role: Matcher,
options?: ByRoleOptions,
): HTMLElement
export function GetByRole(
export type GetByRole = (
container: HTMLElement,
role: ARIARole,
role: ByRoleMatcher,
options?: ByRoleOptions,
): HTMLElement
) => HTMLElement

export function QueryByRole(
container: HTMLElement,
role: Matcher | ByRoleOptions,
options?: ByRoleOptions,
): HTMLElement | null
export function QueryByRole(
export type QueryByRole = (
container: HTMLElement,
role: ARIARole,
role: ByRoleMatcher,
options?: ByRoleOptions,
): HTMLElement | null
) => HTMLElement | null

export function FindByRole(
export type FindByRole = (
container: HTMLElement,
role: Matcher,
role: ByRoleMatcher,
options?: ByRoleOptions,
waitForElementOptions?: waitForOptions,
): Promise<HTMLElement>
export function FindByRole(
container: HTMLElement,
role: ARIARole,
options?: ByRoleOptions,
waitForElementOptions?: waitForOptions,
): Promise<HTMLElement>
) => Promise<HTMLElement>

export function FindAllByRole(
export type FindAllByRole = (
container: HTMLElement,
role: Matcher,
role: ByRoleMatcher,
options?: ByRoleOptions,
waitForElementOptions?: waitForOptions,
): Promise<HTMLElement[]>
export function FindAllByRole(
container: HTMLElement,
role: Matcher,
options?: ByRoleOptions,
waitForElementOptions?: waitForOptions,
): Promise<HTMLElement[]>
/* tslint:enable */
) => Promise<HTMLElement[]>

export const getByLabelText: GetByText
export const getAllByLabelText: AllByText
Expand Down Expand Up @@ -196,12 +165,12 @@ export const queryByDisplayValue: QueryByBoundAttribute
export const queryAllByDisplayValue: AllByBoundAttribute
export const findByDisplayValue: FindByBoundAttribute
export const findAllByDisplayValue: FindAllByBoundAttribute
export const getByRole: typeof GetByRole
export const getAllByRole: typeof AllByRole
export const queryByRole: typeof QueryByRole
export const queryAllByRole: typeof AllByRole
export const findByRole: typeof FindByRole
export const findAllByRole: typeof FindAllByRole
export const getByRole: GetByRole
export const getAllByRole: AllByRole
export const queryByRole: QueryByRole
export const queryAllByRole: AllByRole
export const findByRole: FindByRole
export const findAllByRole: FindAllByRole
export const getByTestId: GetByBoundAttribute
export const getAllByTestId: AllByBoundAttribute
export const queryByTestId: QueryByBoundAttribute
Expand Down