-
Notifications
You must be signed in to change notification settings - Fork 36
/
index.d.ts
2138 lines (2070 loc) · 50.8 KB
/
index.d.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
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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
///<reference types="react"/>
import * as React from "react";
export interface BaseProps {
/**
* Additional CSS ui classes
*/
className?: string;
/**
* Use other component for composing results: <DropdownMenu component={Button}>
*/
component?: React.ReactType;
/**
* Apply default semantic UI classes for component, for example ui button
* @default true
*/
defaultClasses?: boolean;
/**
* Apply style. If using semantic-react/radium you can apply array of styles too
*/
style?: React.CSSProperties | React.CSSProperties[];
/**
* Allows to pass default html attributes.
* Not inheriting from React.DOMAttributes to prevent annoying onAnything handlers in completion popup
*/
[key: string]: any;
}
/**
* Base animation properties
*/
export interface AnimationProps {
/**
* Enter/Appear animation name
*/
enter?: string;
/**
* Leave animation name
*/
leave?: string;
/**
* Enter/Appear animation duration in ms
*/
enterDuration?: number;
/**
* Leave/Appear animation duration in ms
*/
leaveDuration?: number;
}
export type SizeType = "mini" | "tiny" | "small" | "medium" | "large" | "big" | "huge" | "massive";
export type PositionType = "top" | "bottom" | "top right" | "top left" | "bottom left" | "bottom right";
export type ColorType = "red" | "orange" | "yellow" | "olive" | "green" | "teal" | "blue" | "violet" | "purple" | "pink"
| "brown" | "grey" | "black";
// <Label />
export interface LabelProps extends BaseProps {
/**
* A label can attach to a content segment
*/
attached?: PositionType;
/**
* A label can reduce its complexity
*/
basic?: boolean;
/**
* A label can be circular
*/
circular?: boolean;
/**
* A label can have different colors
*/
color?: ColorType;
/**
* A label can position itself in the corner of an element
* @default false
*/
corner?: "left" | "right" | boolean;
/**
* Empty label
*/
empty?: boolean;
/**
* A label can float above another element
*/
floating?: boolean;
/**
* A horizontal label is formatted to label content along-side it horizontally
*/
horizontal?: boolean;
/**
* Add image to the label
*/
image?: string;
/**
* Format label as link (uses <a> tag)
*/
link?: boolean;
/**
* A label can point to content next to it
* @default false
*/
pointing?: "top" | "bottom" | "left" | "right" | boolean;
/**
* A label can appear as a ribbon attaching itself to an element.
* @default false
*/
ribbon?: "right" | boolean;
/**
* A label can be small or large
*/
size?: SizeType;
/**
* A label can appear as a tag
*/
tag?: boolean;
}
export class Label extends React.Component<LabelProps, any> {
}
// <Detail />
export interface DetailProps extends BaseProps {
}
export class Detail extends React.Component<DetailProps, any> {
}
// <Labels />
export interface LabelsProps extends BaseProps {
/**
* Labels can share shapes
*/
circular?: boolean;
/**
* Labels can share colors together
*/
color?: ColorType;
/**
* Labels can share sizes together
*/
size?: SizeType;
/**
* Labels can share tag formatting
*/
tag?: boolean;
}
export class Labels extends React.Component<LabelsProps, any> {
}
export interface ButtonProps extends BaseProps {
/**
* Html type
*/
type?: string;
/**
* Adds a fade or slide animation on hover.
*/
animated?: "fade" | "vertical" | boolean;
/**
* It's attached to some other attachable component.
*/
attached?: "left" | "right" | "bottom" | "top" | boolean;
/**
* Adds simple styling to the component.
*/
basic?: boolean;
/**
* Gives a circular shape to the component.
*/
circular?: boolean;
/**
* Adds a SemanticUI color class.
*/
color?: ColorType;
/**
* Reduces the padding on the component.
*/
compact?: boolean;
/**
* A button can be formatted to show different levels of emphasis
*/
emphasis?: "primary" | "secondary" | "positive" | "negative" | string;
/**
* Forces to component to float left or right.
*/
floated?: "right" | "left";
/**
* The component fills the parent components horizontal space.
*/
fluid?: boolean;
/**
* Styles the component for a dark background.
*/
inverted?: boolean;
/**
* Adds a SemanticUI size class.
*/
size?: SizeType;
/**
* Indicates whether the button is currently highlighted or disabled.
*/
state?: "active" | "disabled" | "loading" | string;
/**
* A button can be formatted to toggle on and off
*/
toggle?: boolean;
}
export class Button extends React.Component<ButtonProps, any> {
}
// <Buttons />
export interface ButtonsProps extends BaseProps {
/**
* It's attached to some other attachable component.
*/
attached?: "bottom" | "top";
/**
* Adds simple styling to the component.
*/
basic?: boolean;
/**
* Adds a SemanticUI color class.
*/
color?: ColorType;
/**
* Reduces the padding on the component.
*/
compact?: boolean;
/**
* Forces all children to an equal width.
*/
equal?: boolean;
/**
* Forces to component to float left or right.
*/
floated?: "left" | "right" | string;
/**
* Styles the component for a dark background.
*/
inverted?: boolean;
/**
* Adds a SemanticUI size class.
*/
size?: SizeType;
/**
* Forces child components to render vertically.
*/
vertical?: boolean;
}
export class Buttons extends React.Component<ButtonsProps, any> {
}
// <IconButton />
export interface IconButtonProps extends ButtonProps {
/**
* Adds a SemanticUI color class to the icon.
*/
iconColor?: ColorType;
/**
* Icon component
*/
iconComponent?: any;
/**
* Adds a SemanticUI name class to the icon.
*/
name: string;
}
export class IconButton extends React.Component<IconButtonProps, any> {
}
// <LabeledButton />
export interface LabeledButtonProps extends ButtonProps {
/**
* Label position, default to right
* @default "right"
*/
labeled?: "left" | "right" | string;
/**
* Type of label, could be text label or icon
* @default "text"
*/
labelType?: "text" | "icon" | string;
/**
* Label, if given string will be used as label text or icon name (if labelType is icon).
*/
label: string;
/**
* Label component. Default will be Icon for labelType icon and Label for labelType label
*/
labelComponent?: any;
}
export class LabeledButton extends React.Component<LabeledButtonProps, any> {
}
// <SocialButton />
export interface SocialButtonProps extends ButtonProps {
/**
* Adds a SemanticUI name class to the icon.
*/
name: string;
}
export class SocialButton extends React.Component<SocialButtonProps, any> {
}
// <Divider />
export interface DividerProps extends BaseProps {
/**
* Content segment vertically or horizontally
*/
aligned?: "horizontal" | "vertical";
/**
* A divider can clear the contents above it
*/
clearing?: boolean;
/**
* Formats divider as header-like (taking less space and don't capitalize content)
*/
header?: boolean;
/**
* A hidden divider divides content without creating a dividing line
*/
hidden?: boolean;
/**
* A divider can have its colors inverted
*/
inverted?: boolean;
/**
* Divider spacing
*/
spacing?: "fitted" | "padded";
}
export class Divider extends React.Component<DividerProps, any> {
}
// <Flag />
export interface FlagProps extends BaseProps {
/**
* The country code, name or alias of the flag
*/
name: string;
}
export class Flag extends React.Component<FlagProps, any> {
}
// <Header />
export interface HeaderProps extends BaseProps {
/**
* A header can have its text aligned to a side
*/
aligned?: "right" | "left" | "justified" | "center";
/**
* A header can be attached to other content, like a segment
*/
attached?: "bottom" | "top" | boolean;
/**
* A header can be formatted with different colors
*/
color?: ColorType;
/**
* A header can show that it is inactive
*/
disabled?: boolean;
/**
* Header may be used as divider
*/
divider?: boolean;
/**
* dividing: can be formatted to divide itself from the content below it
* block: can be formatted to appear inside a content block
*/
emphasis?: "dividing" | "block";
/**
* A header can sit to the left or right of other content
*/
floated?: "right" | "left";
/**
* Icon name for header. This will turn header into icon header (ui icon header)
*/
icon?: string;
/**
* Override icon component
*/
iconComponent?: any;
/**
* A header can have its colors inverted for contrast
*/
inverted?: boolean;
/**
* May be used as menu item
*/
item?: boolean;
/**
* May have various sizes
*/
size?: SizeType;
}
export class Header extends React.Component<HeaderProps, any> {
}
// <SubHeader />
export interface SubHeaderProps extends HeaderProps {
}
export class SubHeader extends React.Component<SubHeaderProps, any> {
}
// <Icon />
export interface IconProps extends BaseProps {
/**
* An icon can be formatted to appear bordered
*/
bordered?: boolean;
/**
* An icon can be formatted to appear circular
*/
circular?: boolean;
/**
* An icon can be formatted with different colors
*/
color?: ColorType;
/**
* Render as corner icon if used in <Icons/>
*/
corner?: boolean;
/**
* Icon could be disabled or used as simple loader
*/
state?: "disabled" | "loading";
/**
* An icon can be fitted, without any space to the left or right of it.
*/
fitted?: boolean;
/**
* An icon can be flipped
*/
flipped?: "horizontally" | "vertically";
/**
* An icon can have its colors inverted for contrast
*/
inverted?: boolean;
/**
* Could be formatted as link
*/
link?: boolean;
/**
* Icon name
*/
name?: string;
/**
* An icon can be rotated
*/
rotated?: "clockwise" | "counterclockwise";
/**
* Icon size
*/
size?: SizeType;
}
export class Icon extends React.Component<IconProps, any> {
}
export interface IconsProps extends BaseProps {
/**
* Size of icon group
*/
size?: SizeType;
}
export class Icons extends React.Component<IconsProps, any> {
}
// <Image />
export interface ImageProps extends BaseProps {
// Standard image html attributes
/**
* Specifies an alternate text for an image
*/
alt?: string;
/**
* Specifies the height of an image
*/
height?: number;
/**
* Specifies the width of an image
*/
width?: number;
/**
* An image can specify its vertical alignment
*/
aligned?: "top" | "middle" | "bottom";
/**
* An image may be formatted to appear inline with text as an avatar
*/
avatar?: boolean;
/**
* An image may include a border to emphasize the edges of white or transparent content
*/
bordered?: boolean;
/**
* An image can appear centered in a content block
*/
centered?: boolean;
/**
* An image can take up the width of its container
*/
fluid?: boolean;
/**
* An image can sit to the left or right of other content
*/
floated?: "right" | "left";
/**
* An image may appear at different sizes
*/
size?: SizeType;
/**
* An image can specify that it needs an additional spacing to separate it from nearby content
*/
spaced?: "right" | "left" | boolean;
/**
* Image src
*/
src: string;
/**
* Image shape
*/
shape?: "circular" | "rounded";
/**
* Image state, could be disabled or hidden
*/
state?: "disabled" | "hidden" | "visible";
/**
* Wrap image component under other component, for example <a/> or <div/>
* In this case this component will receive image classes instead
* @default false
*/
wrapComponent?: boolean | any;
}
export class Image extends React.Component<ImageProps, any> {
}
// <Images />
export interface ImagesProps extends BaseProps {
/**
* Images size
*/
size?: SizeType;
}
export class Images extends React.Component<ImagesProps, any> {
}
// <Input />
export interface InputProps extends BaseProps {
// Standard <input> html attributes
/**
* Specifies whether an <input> element should have autocomplete enabled
*/
autoComplete?: "on" | "off";
/**
* Specifies that an <input> element should automatically get focus when the page loads
*/
autoFocus?: boolean;
/**
* Specifies the maximum value for an <input> element
*/
max?: number | string;
/**
* Specifies the maximum number of characters allowed in an <input> element
*/
maxLength?: number;
/**
* Specifies a minimum value for an <input> element
*/
min?: number | string;
/**
* Specifies the name of an <input> element
*/
name?: string;
/**
* Specifies a regular expression that an <input> element's value is checked against
*/
pattern?: string;
/**
* Specifies the type <input> element to display
*/
type?: string;
// React-specific stuff
/**
* Default value
*/
defaultValue?: any;
/**
* Read only
*/
readOnly?: boolean;
/**
* Action component
*/
actionComponent?: any;
/**
* Action position
*/
actionPosition?: "left" | "right";
/**
* An input can take the size of its container
*/
fluid?: boolean;
/**
* Render icon
*/
icon?: string | boolean;
/**
* Icon position
*/
iconPosition?: "left" | "right";
/**
* Pass custom icon component
*/
iconComponent?: any;
/**
* Inverted input
*/
inverted?: boolean;
/**
* Render label for input
*/
label?: string;
/**
* Pass custom label component
*/
labelComponent?: any;
/**
* Label position
*/
labelPosition?: "left" | "right" | "left corner" | "right corner";
/**
* Input placeholder
*/
placeholder?: string;
/**
* Input size
*/
size?: SizeType;
/**
* Input state
*/
state?: "focus" | "loading" | "disabled" | "error" | Array<"focus" | "loading" | "disabled" | "error">;
/**
* Render transparent input
*/
transparent?: boolean;
/**
* Input value
*/
value?: string;
}
export class Input extends React.Component<InputProps, any> {
}
// <List />
export interface ListProps extends BaseProps {
/**
* Controls content alignment for all items in list
*/
aligned?: "top" | "middle" | "bottom";
/**
* A list can animate to set the current item apart from the list
*/
animated?: boolean;
/**
* Cell type
*/
celled?: "divided" | boolean;
/**
* Controls content floating for all items in list
*/
floated?: "right" | "left";
/**
* A list can be formatted to have items appear horizontally
*/
horizontal?: boolean;
/**
* A list can be inverted to appear on a dark background
*/
inverted?: boolean;
/**
* A list can be specially formatted for navigation links
*/
link?: boolean;
/**
* A list can relax its padding to provide more negative space
*/
relaxed?: boolean;
/**
* A selection list formats list items as possible choices
*/
selection?: boolean;
/**
* A list can vary in size
*/
size?: SizeType;
/**
* Type of the list
* Bulleted: mark items with a bullet
* Ordered: mark items with a number
*/
type?: "bulleted" | "ordered";
}
export class List extends React.Component<ListProps, any> {
}
export interface ListItemProps extends BaseProps {
/**
* Mark item as active. Valid only for link list
*/
active?: boolean;
/**
* Content alignment
*/
contentAligned?: "top" | "middle" | "bottom";
/**
* Image/Icon name
*/
image?: string;
/**
* Type of image/icon
*/
imageType?: "image" | "icon";
/**
* Image/Icon component. Override to tune
*/
imageComponent?: any;
/**
* Right floated content component. If not provided, then right floated content will not be rendered
*/
rightFloatedComponent?: any;
}
export class ListItem extends React.Component<ListItemProps, any> {}
// <Loader />
export interface LoaderProps extends BaseProps {
/**
* Loaders can appear inline centered with content
*/
centered?: boolean;
/**
* Loaders can appear inline with content
*/
inline?: boolean;
/**
* Loaders can have their colors inverted.
*/
inverted?: boolean;
/**
* Loaders can have different sizes
*/
size?: SizeType;
/**
* Loader state
*/
state?: "active" | "indeterminate" | "disabled";
/**
* A loader can contain text
*/
text?: boolean;
}
export class Loader extends React.Component<LoaderProps, any> {
}
// <Rail />
export interface RailProps extends BaseProps {
/**
* A rail can appear attached to the main viewport
*/
attached?: boolean;
/**
* A rail can appear closer to the main viewport
*/
close?: boolean | "very";
/**
* A rail can create a division between itself and a container
*/
dividing?: boolean;
/**
* A rail can be presented on the left or right side of a container
*/
floated: "right" | "left";
/**
* A rail can attach itself to the inside of a container
*/
internal?: boolean;
/**
* A rail can have different sizes
*/
size?: SizeType;
}
export class Rail extends React.Component<RailProps, any> {
}
// <Reveal />
export interface RevealProps extends BaseProps {
active?: boolean;
circular?: boolean;
disabled?: boolean;
fade?: boolean;
image?: boolean;
instant?: boolean;
move?: "right" | "up" | "down" | boolean;
rotate?: "left" | boolean;
size?: SizeType;
type?: string;
}
export class Reveal extends React.Component<RevealProps, any> {
}
// <Segment />
export interface SegmentProps extends BaseProps {
/**
* A segment can have its text aligned to a side
*/
aligned?: "right" | "left" | "center";
/**
* A segment can be attached to other content on a page
*/
attached?: "bottom" | "top" | boolean;
/**
* A basic segment has no special formatting
*/
basic?: boolean;
/**
* Blurring segment when used with dimmer
*/
blurring?: boolean;
/**
* A segment can clear floated content
*/
clearing?: boolean;
/**
* A segment can be colored
*/
color?: ColorType;
/**
* Container segment
*/
container?: boolean;
/**
* A segment may show its content is disabled
*/
disabled?: boolean;
/**
* A segment can be formatted to appear more or less noticeable
*/
emphasis?: "primary" | "secondary" | "tertiary";
/**
* A segment can appear to the left or right of other content
*/
floated?: "right" | "left";
/**
* A segment can have its colors inverted for contrast
*/
inverted?: boolean;
/**
* A segment may show its content is being loaded
*/
loading?: boolean;
/**
* Segment spacing
*/
spacing?: "fitted" | "padded";
/**
* Segment type
*/
type?: "raised" | "stacked" | "piled";
/**
* A vertical segment formats content to be aligned as part of a vertical group
*/
vertical?: boolean;
/**
* Segment zIndex
*/
zIndex?: number;
}
export class Segment extends React.Component<SegmentProps, any> {
}
// <Segments />
interface SegmentsProps extends BaseProps {
/**
* Compact segments
*/
compact?: boolean;
/**
* Horizontal segments
*/
horizontal?: boolean;
/**
* Inverted segments
*/
inverted?: boolean;
/**
* Type of segments
*/
type?: "raised" | "piled" | "stacked";
}
export class Segments extends React.Component<SegmentsProps, any> {
}
// <Actions />
export interface ActionsProps extends BaseProps {
}
export class Actions extends React.Component<ActionsProps, any> {
}
// <Author />
export interface AuthorProps extends BaseProps {
}
export class Author extends React.Component<AuthorProps, any> {
}
// <Container />
export interface ContainerProps extends BaseProps {
fluid?: boolean;
aligned?: "right" | "left" | "justified" | "center";
}
export class Container extends React.Component<ContainerProps, any> {
}
// <Content />
export interface ContentProps extends BaseProps {
active?: boolean;
aligned?: string;
extra?: boolean;
floated?: string | boolean;
hidden?: boolean;
meta?: boolean;
visible?: boolean;
image?: boolean;
}
export class Content extends React.Component<ContentProps, any> {
}
// <Date />
export interface DateProps extends BaseProps {
}
export class Date extends React.Component<DateProps, any> {
}
// <Description />
export interface DescriptionProps extends BaseProps {
hidden?: boolean;
visible?: boolean;
}
export class Description extends React.Component<DescriptionProps, any> {
}
// <Meta />
export interface MetaProps extends BaseProps {
}
export class Meta extends React.Component<MetaProps, any> {
}
// <Summary />
export interface SummaryProps extends BaseProps {
}
export class Summary extends React.Component<SummaryProps, any> {
}
// <Text />
export interface TextProps extends BaseProps {
extra?: boolean;
}
export class Text extends React.Component<TextProps, any> {
}
// <Field />
export interface FieldProps extends BaseProps {
/**
* Grouped field
*/
grouped?: boolean;
/**
* A field can have its label next to instead of above it.
*/
inline?: boolean;
/**
* Field label
*/
label?: string;
/**
* A field can show that input is mandatory
*/
required?: boolean;
/**
* Field state
*/
state?: "disabled" | "error";
/**
* Field width in columns
*/
width?: number;
}
export class Field extends React.Component<FieldProps, any> {
}
// <Fields />
export interface FieldsProps extends BaseProps {
/**
* Fields can have their widths divided evenly
*/
fluid?: boolean;