-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathtypes.ts
More file actions
849 lines (814 loc) · 22.6 KB
/
Copy pathtypes.ts
File metadata and controls
849 lines (814 loc) · 22.6 KB
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
import type { FC, PropsWithChildren } from 'react';
import type React from 'react';
import type { Animated, DimensionValue, FlatList, ImageSourcePropType,
StyleProp, TextProps, TextStyle, ViewProps, ViewStyle } from 'react-native';
import { Swipeable } from 'react-native-gesture-handler';
import type { defaultTypography } from './core/typography/typography';
import { DEFAULT_THEME } from './core/theme/colors';
export type DefaultProps = { typography?: TypographyType }
/**
* Functional component with children
*/
export type FCC<P = {}> = FC<PropsWithChildren<P>>
/**
*
* Functional component with children and defaults
*/
export type FCCWD<P = {}> = FCC<P & DefaultProps>
export type CoreThemeType = typeof DEFAULT_THEME
export type ThemeType = CoreThemeType & {
dark: {
colors:{ custom: any}
},
light: {
colors:{ custom: any}
}
}
export type ComponentThemeType = typeof DEFAULT_THEME.light.components
export type Components =keyof ComponentThemeType
export type TypographyType = typeof defaultTypography & any;
export type AccordionListProps = {
/**
*The data to render in the accordion list
*/
data: any[],
/**
*Renders the given React element to the left side
*/
left?: (event: boolean) => React.ReactElement,
/**
*Renders the given React element to the right side
*/
right?: (event: boolean) => React.ReactElement,
/**
*Callback called when accordion list is opened
*/
onExpand?: () => void,
/**
*The label to display at the top of the accordion list
*/
label?: string,
/**
*Additional styles to apply to the accordion list container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Additional styles to apply to the label container
*/
labelContainerStyle?: StyleProp<ViewStyle>,
/**
*A callback function that will be called when a row is selected
*/
onSelect: (event: any) => void,
/**
*A function that returns a string or JSX element to display for each row
*/
itemDisplay: (event: any) => any,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to each the row text
*/
rowTextStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to each row container
*/
rowStyle?: StyleProp<ViewStyle>
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['accordionList'])>
/**
*Used to locate this view in end-to-end tests
*/
testID?: string
}
export type AvatarGroupProps = {
/**
*Takes avatar props into array
*/
avatars: Array<Omit<AvatarProps, 'theme' | 'size'>>,
/**
*Limit of avatars to be listed. Defaults to 10
*/
avatarLimit?: number,
/**
*Additional styles to apply to the limit container
*/
limitContainerStyle?: StyleProp<TextStyle>
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['avatarGroup'])>
}
export type AvatarProps = {
/**
*The size of the avatar. Defaults to 'medium'
*/
size?: 'small' | 'medium',
/**
*Used to specify the image source
*/
source?: ImageSourcePropType,
/**
*Specifies the border type of the avatar. Defaults to 'circular'
*/
variant?: 'circular' | 'rounded',
/**
*Used to add icon to avatar
*/
avatarIcon?: React.ReactNode,
/**
*Additional styles to apply to the avatar container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Label to be displayed on the avatar
*/
label?: string,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['avatar'])>
}
export type BadgeProps = {
/**
*Visibility status. Defaults to true
*/
visible?: boolean,
/**
*Label to be displayed on the badge
*/
label?: string | number,
/**
*The size of the badge. Defaults to 'medium'
*/
size?: 'medium' | 'small',
/**
*Additional styles to apply to the badge container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Additional styles to apply to the badge
*/
badgeStyle?:StyleProp<ViewStyle>,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*Specifies the border type of the badge. Defaults to 'circular'
*/
variant?: 'circular' | 'rectangular'
/**
*Icon to be added to badge
*/
icon?: React.ReactNode,
/**
*Location of the badge. Defaults to 'top-right'
*/
badgePosition: 'topRight' | 'topLeft' | 'bottomRight' | 'bottomLeft'
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['badge'])>
}
export type ButtonProps = {
/**
*The size of the button. Defaults to 'medium'
*/
size?: 'large' | 'medium' | 'small',
/**
*Whether the press behavior is disabled
*/
disabled?: boolean,
/**
*The label to display on the button
*/
label?: string,
/**
*Additional element to apply to left side of the button
*/
left?:(event:boolean)=> React.ReactElement,
/**
*Additional element to apply to right side of the button
*/
right?:(event:boolean)=> React.ReactElement,
/**
*The position of the icon in relation to the label. Defaults to 'left'
*/
iconPosition?: 'left' | 'right',
/**
*Additional styles to apply to the button
*/
style?: StyleProp<ViewStyle>,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*Determines what the opacity of the wrapped view should be when touch is active. Defaults to 1.
*/
activeOpacity?:number,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['button'])>
}
export type CheckBoxProps = {
/**
*Callback function to be called when the value of a check box component changes
*/
onChange?: (event: boolean) => void
/**
*Callback function to be called when the checkbox component is pressed
*/
onPress?: (event: boolean) => void
/**
*Additional styles to apply to the check box
*/
style?: StyleProp<ViewStyle>
/**
*The value of the check box. Defaults to false
*/
value?: boolean | undefined
/**
*Whether the press behavior is disabled
*/
disabled?: boolean,
/**
*Variant of the text input. Defaults to 'circular'
*/
variant?:'circular' |'rectangular'
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['checkbox'])>
}
export type ChipProps = {
/**
*The label to display on the chip
*/
label?: string,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to the chip
*/
style?: StyleProp<ViewStyle>,
/**
*The value of the chip. Defaults to false
*/
value?: boolean,
/**
*Additional element to apply to left side of the chip
*/
left?:(event:boolean)=> React.ReactElement,
/**
*Additional element to apply to right side of the chip
*/
right?:(event:boolean)=> React.ReactElement,
/**
*The size of the chip. Defaults to 'small'
*/
size?: 'large' | 'medium' | 'small',
/**
*Callback function to be called when the value of a chip component changes
*/
onChange?: (event: boolean) => void,
/**
*Whether the press behavior is disabled
*/
disabled?: boolean,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['chip'])>
}
export type DividerProps = {
/**
*Additional styles to apply to the divider border style. Defaults to 'solid'
*/
variant?: 'solid' | 'dotted' | 'dashed'
/**
*Width of divider
*/
width?: DimensionValue,
/**
*Additional styles to apply to the divider.
*/
style?: StyleProp<ViewStyle>
/**
*Border width to be apply to the divider
*/
borderWidth?:number,
/**
*The theme to use for the component
*/
theme?: DeepPartial<DeepPartial<(ComponentThemeType['divider'])>>
}
export type DrowdownProps = {
/**
*The size of the dropdown. Defaults to 'medium'
*/
size?: 'large' | 'medium' | 'small',
/**
*Whether the press behavior is disabled
*/
disabled?: boolean | undefined,
/**
*The number of items to display in the button
*/
displayLength?: number,
/**
*An array of objects or strings to be used as options in the dropdown
*/
data: Array<any>,
/**
*Additional styles to apply to the dropdown button
*/
buttonStyle?: StyleProp<ViewStyle>,
/**
*A function that takes an item from the data array and returns a value to be displayed in the dropdown
*/
displayedRowValue: (item: any) => any,
/**
*A function that takes an item from the data array and returns a value to be displayed on the dropdown button
*/
displayedButtonValue: (item: any) => any,
/**
*Additional styles to be applied to the dropdown container
*/
containerStyle?: StyleProp<ViewStyle>
/**
*The default text to be displayed on the dropdown button when no options are selected
*/
buttonTitle?: string,
/**
*Additional styles to apply to each item in the dropdown
*/
rowStyle?: StyleProp<ViewStyle>
/**
*Function to be called whenever an item is selected in the dropdown
*/
onSelect?: (item: any) => void,
/**
*Default value to be pre-selected in the dropdown
*/
defaultValue?: any,
/**
*Additional styles to apply to the text inside each item in the dropdown
*/
rowTextStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to the text inside the dropdown button
*/
buttonTextStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to the dropdown list container
*/
listContainerStyle?: StyleProp<ViewStyle>,
/**
*Renders the given React element to the left side
*/
left?: (event: boolean) => React.ReactNode,
/**
*Renders the given React element to the right side
*/
right?: (event: boolean) => React.ReactNode,
/**
*Function to be called whenever submit button pressed
*/
onComplete?: (item: any) => void,
/**
* Controls the dropdown menu's opening direction.
* Accepts 'up' or 'down' for specific directions, or 'auto' to adjust direction automatically based on available space.
* Defaults to 'auto'.
*/
direction?:'up'|'down'|'auto'
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['dropdown'])>
/**
*The value of the dropdown.
*/
value?:any
/**
*Used to locate this view in end-to-end tests
*/
testID?: string
}
export type MultipleDropdownProps = DrowdownProps & {
/**
*Additional styles to apply to complete selection button label
*/
completeButtonLabelStyle?:StyleProp<TextStyle>,
/**
*Text to be displayed in the complete button
*/
completeButtonLabel?:string,
/**
*Text to be displayed in the selectall button
*/
selectallButtonLabel?:string,
/**
*Whether to include a "Select All" option in the dropdown. Defaults to false
*/
selectall?: boolean,
/**
* Text to display when the selection exceeds the display length limit
*/
overflowButtonLabel?:(event: number)=>void,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['multipleDropdown'])>
}
export type DrowdownRouteProps= MultipleDropdownProps& {
/**
* Determines whether the dropdown should allow multiple selections. Defaults to false
*/
multiple?: boolean
}
export type IconProps = {
/**
*Name of icon
*/
name: string;
/**
*Color of icon
*/
color?: string;
/**
*Size of icon
*/
size: number;
/**
*Additional styles to apply to the icon
*/
style?: ViewStyle,
/**
*Specifies whether fonts should scale to respect Text Size accessibility settings. Defaults to true
*/
allowFontScaling?: boolean;
};
export type IconComponentProps =
TextProps & {
/**
*Name of icon
*/
name: string;
/**
*Color of icon
*/
color?: string;
/**
*Size of icon
*/
size: number;
/**
* Determines whether the icon responds to pointer events.
*
* - `"auto"`: The default value. The behavior is determined by the parent component's pointerEvents property.
* - `"none"`: The icon does not respond to pointer events.
* - `"box-only"`: The icon only responds to pointer events on the
* box surrounding it. The icon itself does not respond to pointer events.
* - `"box-none"`: The icon does not respond to pointer events on
* the box surrounding it, but its children can respond to pointer events.
*/
pointerEvents?: ViewProps['pointerEvents'];
};
export type SwitchProps={
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['switch'])>
}
export type MenuProps = {
/**
* Items to be listed in the menu
*
* - `"label"`: The label to display on the menu item
* - `"left"`: Renders the given React element to the left side of the menu item
* - `"right"`: Renders the given React element to the right side of the menu item
* - `"onPress"`: Callback function to be called when the menu item component is pressed
*/
items: Array<{ label: string, left?: React.ReactNode, right?: React.ReactNode, onPress?: () => void }>,
/**
*Additional styles to apply to the menu container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Additional styles to apply to each the row text
*/
rowTextStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to the menu
*/
menuStyle?: ViewStyle,
/**
*Used to open or close the menu
*/
button?: (event: boolean) => React.ReactNode,
/**
*Additional styles to apply to each row container
*/
rowStyle?: StyleProp<ViewStyle>,
/**
*Specifies whether it should close when an option is selected
*/
closeOnPress?: boolean,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['menu'])>
}
export type ProgressBarProps = {
/**
*The progress value as a percentage. Defaults to 0
*/
progress?: number,
/**
*Additional styles to apply to the progress
*/
progressStyle?: StyleProp<ViewStyle>,
/**
*Used to locate this view in end-to-end tests
*/
testID?: string,
/**
*Additional styles to apply to the progress bar
*/
barStyle?: StyleProp<ViewStyle>,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['progressBar'])>
}
export type RadioButtonProps = {
/**
*Callback function to be called when the value of radio button component changes
*/
onChange: (event: boolean) => void
/**
*Additional styles to apply to the radio button container
*/
style?: StyleProp<ViewStyle>,
/**
*Used to locate this view in end-to-end tests
*/
testID?: string,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['radioButton'])>
}
export type SliderProps = {
/**
*Additional styles to apply to the slider container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Determines whether to show the percentage indicator above the slider button
*/
showPercentage?: boolean
/**
*Callback function that is called when the user releases the slider button
*/
onChangeEnd: (value: number) => void
/**
*The initial value of the slider
*/
defaultValue?: number
/**
*Additional styles to apply to the slider button
*/
buttonStyle?: StyleProp<ViewStyle>
/**
*Additional styles to apply to the slider bar
*/
barStyle?: StyleProp<ViewStyle>
/**
*Additional styles to apply to the progress bar
*/
progressStyle?: StyleProp<ViewStyle>
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['slider'])>
}
export type ActionProps = {
/**
*The label to display on the swipe action button
*/
label?: string,
/**
*Additional styles to apply to the swipe action button
*/
style?: StyleProp<ViewStyle>,
/**
*Used to add icon to swipe action button
*/
icon?: React.ReactNode,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*Callback function to be called when the swipe action button is pressed
*/
onPress?: (ref: React.RefObject<Swipeable>) => void
}
export type SwipeProps = {
/**
*The content to be wrapped by the Swipeable component
*/
children?: any,
/**
*Determines whether to use a rounded border radius on the component. Defaults to 'no-radius'
*/
variant?: 'radius' | 'no-radius',
/**
*An array of objects representing the right swipe actions to be rendered
*/
rightActions?: Array<ActionProps>,
/**
*An object representing the left swipe action to be rendered
*/
leftAction?: ActionProps,
}
export type RenderRightActionProps = {
item: ActionProps,
dragValue: number,
progress: Animated.AnimatedInterpolation<string | number>,
index: number
}
export type TextInputProps = {
/**
*The size of the text input. Defaults to 'medium'
*/
size?: 'large' | 'medium' | 'small',
/**
*Text to be displayed under the text input
*/
bottomLabel?: string,
/**
*Additional styles to apply to the bottom label
*/
bottomLabelStyle?: StyleProp<TextStyle>,
/**
*Variant of the text input. Defaults to 'filled'
*/
variant?: 'filled' | 'outlined',
/**
*Additional styles to apply to the input container
*/
inputContainerStyle?: StyleProp<ViewStyle>,
/**
*Additional styles to apply to the label container
*/
labelContainerStyle?: StyleProp<ViewStyle>,
/**
*Shows the number of text input characters. Defaults to false
*/
count?: boolean,
/**
*The text to use for the floating label
*/
label?: string,
/**
*Additional styles to apply to the label
*/
labelStyle?: StyleProp<TextStyle>,
/**
*If false, text is not editable. Defaults to true.
*/
editable?: boolean,
/**
*Additional styles to apply to the text input.
*/
inputStyle?: StyleProp<TextStyle>,
/**
*Additional styles to apply to the container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Checks error status
*/
error?: boolean,
/**
*Renders the given React element to the left side
*/
left?:(event:boolean)=> React.ReactNode,
/**
*Renders the given React element to the right side
*/
right?:(event:boolean)=> React.ReactNode,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['textInput'])>
}
export type ToggleButtonProps = {
/**
* Array of buttons
*
* - `"label"`: The label to display on the toggle button
* - `"onPress"`: Callback function to be called when the toggle button is pressed
* - `"id"`: Id of the toggle button
*/
buttons: {
label: string,
onPress: (event: boolean) => void,
id?: number
}[]
/**
*The size of the toggle button. Defaults to 'medium'
*/
size?: 'small' | 'medium',
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['toggleButton'])>
}
export type SpeedDialProps = {
/**
*Additional styles to apply to the container
*/
containerStyle?: StyleProp<ViewStyle>,
/**
*Items to be listed in the speed dial.
*
* - `"icon"`: Used to add icon to speeddial item
* - `"title"`: The title to display on the speeddial item
* - `"titleColor"`: Color of the title to be displayed in the speed dial item
* - `"backgroundColor"`: The background color of the speed dial item
* - `"onPress"`: Callback function to be called when the speed dial item is pressed
*/
items: Array<{ icon?: React.ReactNode, title?: string,
titleColor?: string, backgroundColor?: string, onPress?: () => void }>,
/**
*Represents the opening animation. Defaults to 'flat'
*/
variant: 'flat' | 'spread',
/**
*Callback function that returns whether the SpeedDial component is on or off
*/
onChange?: (event: boolean) => void,
/**
*Icon of base item
*/
baseItemIcon?: React.ReactNode,
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['speedDial'])>
};
export type PagerViewProps = {
ref: React.RefObject<FlatList>,
children: React.ReactNode
containerStyle?: StyleProp<ViewStyle>
pageContainerStyle?: StyleProp<ViewStyle>
headerSliderStyle?: StyleProp<ViewStyle>,
headerContainerStyle?: StyleProp<ViewStyle>,
headerLabelStyle?: StyleProp<TextStyle>,
theme?: DeepPartial<(ComponentThemeType['pagerView'])>
}
export type ActivityIndicatorProps = {
/**
*Loading indicator to display
*/
children?: React.ReactNode
/**
*The theme to use for the component
*/
theme?: DeepPartial<(ComponentThemeType['activityIndicator'])>
}
export type IconType =
| 'material'
| 'material-community'
| 'simple-line-icon'
| 'zocial'
| 'font-awesome'
| 'octicon'
| 'ionicon'
| 'foundation'
| 'feather'
| 'fontisto'
| 'evilicon'
| 'entypo'
| 'ant-design'
| 'font-awesome-5'
| 'font-awesome-6';
export type DeepPartial<T> = T extends object ? {
[P in keyof T]?: DeepPartial<T[P]>;
} : T;