-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.ts
154 lines (149 loc) · 3.51 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
import type { ComponentProps, ComponentType, ReactElement } from "react";
/**
* Parameters for searching for elements
*/
export type QueryType<
// biome-ignore lint/suspicious/noExplicitAny: supports any component
Component extends keyof JSX.IntrinsicElements | ComponentType<any>,
> = {
/**
* Type of jsx node. E.g.
*
* ```
* search(<button>Test</button>, {
* component: 'button',
* })
*
* search(<MyComponent>Test</MyComponent>, {
* component: MyComponent,
* })
* ```
*/
component?: Component;
/**
* Props that the target elements should have
*
* ```
* search(
* <button type="button">
* Test
* </button>,
* {
* type: 'button',
* },
* )
* ```
*/
props?: Record<string, unknown>;
/**
* Classname that the target elements should have
*
* ```
* search(
* <button
* className="foo bar baz"
* >
* Test
* </button>,
* {
* className: 'bar',
* },
* )
* ```
*/
className?: string;
};
/**
* Additional parameters for searching inside exotic elements
*/
export type ParamsType<
// biome-ignore lint/suspicious/noExplicitAny: supports any component
Component extends keyof JSX.IntrinsicElements | ComponentType<any>,
> = {
/**
* Get children from the element of the exotic component,
* e.g. other prop for rendering children or render props
*
* ```
* search(
* <ExoticComponent>
* {() => (
* <button>
* Test
* </button>
* )}
* </ExoticComponent>,
* {
* component: 'button',
* },
* {
* getChildren: (
* element,
* ) => {
* if (element.type === ExoticComponent) {
* return [element.props.children()];
* }
*
* return defaultGetChildren(element);
* },
* },
* )
* ```
*
* @param element Target react element
* @returns List of child nodes
*/
getChildren?: (element: ReactElement) => ReactElement[];
/**
* Check if the target element is matching for search, e.g.
*
* ```
* search(
* <ComponentWithCustomClassNameProp
* customClassName="foo bar baz"
* />,
* {
* className: 'bar',
* },
* {
* match: (
* element,
* query,
* ) => {
* if (element.type === ComponentWithCustomClassNameProp) {
* return element.props.customClassName.split(' ').includes(query.className);
* }
*
* return defaultMatch(element, query);
* },
* },
* )
* ```
* @param element Target react element
* @param query Current query
* @returns Is element matching for current query
*/
match?: (element: ReactElement, query: QueryType<Component>) => boolean;
};
/**
* Additional parameters for searching multiple elements inside exotic elements
*/
export type ParamsWithLimitType<
// biome-ignore lint/suspicious/noExplicitAny: supports any component
Component extends keyof JSX.IntrinsicElements | ComponentType<any>,
> = ParamsType<Component> & {
/**
* Max number of elements in result
*/
limit?: number | null;
};
export type AccessorsType<
// biome-ignore lint/suspicious/noExplicitAny: supports any component
Component extends keyof JSX.IntrinsicElements | ComponentType<any>,
> = {
get: () => ReactElement<ComponentProps<Component>, Component>;
getProps: () => ComponentProps<Component>;
getAll: () => ReactElement<ComponentProps<Component>, Component>[];
query: () => ReactElement<ComponentProps<Component>, Component> | null;
queryAll: () => ReactElement<ComponentProps<Component>, Component>[];
};