@wearenotch/ui-react 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,11 +1,10 @@
1
1
  import { ChartData } from 'chart.js';
2
2
  import { ChartOptions } from 'chart.js';
3
3
  import { default as default_2 } from 'react';
4
- import { ForwardRefExoticComponent } from 'react';
5
4
  import { JSX } from 'react/jsx-runtime';
6
5
  import { MouseEventHandler } from 'react';
7
6
  import { ReactNode } from 'react';
8
- import { RefAttributes } from 'react';
7
+ import { Ref } from 'react';
9
8
 
10
9
  export declare function Accordion({ multiple, defaultValue, value: controlledValue, onValueChange, children, className, }: AccordionProps): JSX.Element;
11
10
 
@@ -83,7 +82,13 @@ export declare interface AlertProps {
83
82
 
84
83
  export declare type AlertVariant = 'info' | 'success' | 'warning' | 'error';
85
84
 
86
- export declare const Avatar: ForwardRefExoticComponent<AvatarProps & RefAttributes<HTMLSpanElement>>;
85
+ export declare function Avatar({ src, alt, initials, size, className, ref, }: AvatarProps & {
86
+ ref?: Ref<HTMLSpanElement>;
87
+ }): JSX.Element;
88
+
89
+ export declare namespace Avatar {
90
+ var displayName: string;
91
+ }
87
92
 
88
93
  export declare function AvatarGroup({ children, max, size, className, }: AvatarGroupProps): JSX.Element;
89
94
 
@@ -137,7 +142,13 @@ export declare interface BreadcrumbItem {
137
142
  onClick?: (e: default_2.MouseEvent) => void;
138
143
  }
139
144
 
140
- export declare const Breadcrumbs: default_2.ForwardRefExoticComponent<BreadcrumbsProps & default_2.RefAttributes<HTMLElement>>;
145
+ export declare function Breadcrumbs({ items, separator, maxItems, className, ref, }: BreadcrumbsProps & {
146
+ ref?: Ref<HTMLElement>;
147
+ }): JSX.Element;
148
+
149
+ export declare namespace Breadcrumbs {
150
+ var displayName: string;
151
+ }
141
152
 
142
153
  export declare interface BreadcrumbsProps {
143
154
  items: BreadcrumbItem[];
@@ -147,7 +158,13 @@ export declare interface BreadcrumbsProps {
147
158
  className?: string;
148
159
  }
149
160
 
150
- export declare const Button: ForwardRefExoticComponent<ButtonProps & RefAttributes<HTMLButtonElement>>;
161
+ export declare function Button({ children, variant, size, disabled, loading, type, leftIcon, rightIcon, fullWidth, onClick, 'aria-label': ariaLabel, className, ref, }: ButtonProps & {
162
+ ref?: Ref<HTMLButtonElement>;
163
+ }): JSX.Element;
164
+
165
+ export declare namespace Button {
166
+ var displayName: string;
167
+ }
151
168
 
152
169
  export declare interface ButtonProps {
153
170
  /** Button label */
@@ -178,7 +195,13 @@ export declare type ButtonSize = 'sm' | 'md' | 'lg';
178
195
 
179
196
  export declare type ButtonType = 'primary' | 'secondary' | 'tertiary' | 'link' | 'destructive';
180
197
 
181
- export declare const Card: default_2.ForwardRefExoticComponent<CardProps & default_2.RefAttributes<HTMLElement>>;
198
+ export declare function Card({ variant, clickable, href, children, className, onClick, ref, ...rest }: CardProps & {
199
+ ref?: Ref<HTMLElement>;
200
+ }): JSX.Element;
201
+
202
+ export declare namespace Card {
203
+ var displayName: string;
204
+ }
182
205
 
183
206
  export declare function CardBody({ children, className }: CardBodyProps): JSX.Element;
184
207
 
@@ -237,7 +260,13 @@ export declare interface CardProps {
237
260
 
238
261
  export declare type CardVariant = 'elevated' | 'outlined' | 'filled';
239
262
 
240
- export declare const Carousel: default_2.ForwardRefExoticComponent<CarouselProps & default_2.RefAttributes<HTMLDivElement>>;
263
+ export declare function Carousel({ slides, size, showArrows, showDots, autoPlay, autoPlayInterval, loop, defaultIndex, onSlideChange, className, ref, ...rest }: CarouselProps & {
264
+ ref?: Ref<HTMLDivElement>;
265
+ }): JSX.Element;
266
+
267
+ export declare namespace Carousel {
268
+ var displayName: string;
269
+ }
241
270
 
242
271
  export declare interface CarouselProps extends default_2.HTMLAttributes<HTMLDivElement> {
243
272
  slides: default_2.ReactNode[];
@@ -253,7 +282,13 @@ export declare interface CarouselProps extends default_2.HTMLAttributes<HTMLDivE
253
282
 
254
283
  export declare type CarouselSize = 'sm' | 'md' | 'lg';
255
284
 
256
- export declare const Chart: ForwardRefExoticComponent<ChartProps & RefAttributes<HTMLDivElement>>;
285
+ export declare function Chart({ type, data, options, title, description, height, width, className, id, ref, }: ChartProps & {
286
+ ref?: Ref<HTMLDivElement>;
287
+ }): JSX.Element;
288
+
289
+ export declare namespace Chart {
290
+ var displayName: string;
291
+ }
257
292
 
258
293
  export declare interface ChartProps {
259
294
  type: ChartVariant;
@@ -269,7 +304,13 @@ export declare interface ChartProps {
269
304
 
270
305
  export declare type ChartVariant = 'line' | 'bar' | 'pie' | 'doughnut';
271
306
 
272
- export declare const Checkbox: ForwardRefExoticComponent<CheckboxProps & RefAttributes<HTMLInputElement>>;
307
+ export declare function Checkbox({ id, indeterminate, label, helperText, errorMessage, className, checked, disabled, ref, ...props }: CheckboxProps & {
308
+ ref?: Ref<HTMLInputElement>;
309
+ }): JSX.Element;
310
+
311
+ export declare namespace Checkbox {
312
+ var displayName: string;
313
+ }
273
314
 
274
315
  export declare interface CheckboxProps {
275
316
  id?: string;
@@ -290,8 +331,20 @@ export declare interface CheckboxProps {
290
331
  className?: string;
291
332
  }
292
333
 
293
- export declare const DangerButton: ForwardRefExoticComponent<DangerButtonProps & RefAttributes<HTMLButtonElement>>;
334
+ export declare function DangerButton({ children, variant, size, disabled, loading, type, onClick, 'aria-label': ariaLabel, className, ref, }: DangerButtonProps & {
335
+ ref?: Ref<HTMLButtonElement>;
336
+ }): JSX.Element;
337
+
338
+ export declare namespace DangerButton {
339
+ var displayName: string;
340
+ }
294
341
 
342
+ /**
343
+ * `DangerButton` provides outline and ghost destructive treatments that
344
+ * `<Button variant="destructive">` does not. For the canonical solid
345
+ * destructive button, prefer `<Button variant="destructive">`; reach for
346
+ * `DangerButton` only when you need the outline or ghost variant.
347
+ */
295
348
  export declare interface DangerButtonProps {
296
349
  /** Button label */
297
350
  children: ReactNode;
@@ -315,7 +368,13 @@ export declare type DangerButtonSize = 'sm' | 'md' | 'lg';
315
368
 
316
369
  declare type DangerButtonVariant = 'filled' | 'outline' | 'ghost';
317
370
 
318
- export declare const DatePicker: default_2.ForwardRefExoticComponent<DatePickerProps & default_2.RefAttributes<HTMLDivElement>>;
371
+ export declare function DatePicker({ value, defaultValue, placeholder, size, disabled, label, error, dateFormat, minDate, maxDate, onChange, className, id: idProp, ref, }: DatePickerProps & {
372
+ ref?: Ref<HTMLDivElement>;
373
+ }): JSX.Element;
374
+
375
+ export declare namespace DatePicker {
376
+ var displayName: string;
377
+ }
319
378
 
320
379
  export declare interface DatePickerProps {
321
380
  value?: Date | null;
@@ -335,7 +394,13 @@ export declare interface DatePickerProps {
335
394
 
336
395
  export declare type DatePickerSize = 'sm' | 'md' | 'lg';
337
396
 
338
- export declare const EmptyState: default_2.ForwardRefExoticComponent<EmptyStateProps & default_2.RefAttributes<HTMLDivElement>>;
397
+ export declare function EmptyState({ icon, title, description, action, className, ref, ...rest }: EmptyStateProps & {
398
+ ref?: Ref<HTMLDivElement>;
399
+ }): JSX.Element;
400
+
401
+ export declare namespace EmptyState {
402
+ var displayName: string;
403
+ }
339
404
 
340
405
  export declare interface EmptyStateProps extends default_2.HTMLAttributes<HTMLDivElement> {
341
406
  icon?: default_2.ReactNode;
@@ -344,7 +409,13 @@ export declare interface EmptyStateProps extends default_2.HTMLAttributes<HTMLDi
344
409
  action?: default_2.ReactNode;
345
410
  }
346
411
 
347
- export declare const FileUpload: default_2.ForwardRefExoticComponent<FileUploadProps & default_2.RefAttributes<HTMLDivElement>>;
412
+ export declare function FileUpload({ accept, multiple, maxSize, disabled, size, label, hint, error, onFiles, className, id: idProp, ref, }: FileUploadProps & {
413
+ ref?: Ref<HTMLDivElement>;
414
+ }): JSX.Element;
415
+
416
+ export declare namespace FileUpload {
417
+ var displayName: string;
418
+ }
348
419
 
349
420
  export declare interface FileUploadProps {
350
421
  accept?: string;
@@ -379,7 +450,13 @@ export declare interface FormFieldProps {
379
450
  className?: string;
380
451
  }
381
452
 
382
- export declare const IconButton: ForwardRefExoticComponent<IconButtonProps & RefAttributes<HTMLButtonElement>>;
453
+ export declare function IconButton({ icon, 'aria-label': ariaLabel, variant, size, disabled, loading, type, onClick, className, ref, }: IconButtonProps & {
454
+ ref?: Ref<HTMLButtonElement>;
455
+ }): JSX.Element;
456
+
457
+ export declare namespace IconButton {
458
+ var displayName: string;
459
+ }
383
460
 
384
461
  export declare interface IconButtonProps {
385
462
  /** The icon to display — required */
@@ -395,7 +472,13 @@ export declare interface IconButtonProps {
395
472
  className?: string;
396
473
  }
397
474
 
398
- export declare const Input: ForwardRefExoticComponent<InputProps & RefAttributes<HTMLInputElement>>;
475
+ export declare function Input({ id, name, type, value, defaultValue, placeholder, label, helperText, errorMessage, size, disabled, required, readOnly, leadingContent, trailingContent, maxLength, onChange, onBlur, onFocus, className, 'aria-describedby': ariaDescribedby, ref, }: InputProps & {
476
+ ref?: Ref<HTMLInputElement>;
477
+ }): JSX.Element;
478
+
479
+ export declare namespace Input {
480
+ var displayName: string;
481
+ }
399
482
 
400
483
  export declare interface InputProps {
401
484
  /** Input id — links label to input */
@@ -439,9 +522,21 @@ export declare interface InputProps {
439
522
 
440
523
  export declare type InputSize = 'sm' | 'md' | 'lg';
441
524
 
442
- export declare const List: default_2.ForwardRefExoticComponent<ListProps & default_2.RefAttributes<HTMLElement>>;
525
+ export declare function List({ variant, size, divided, className, children, ref, ...rest }: ListProps & {
526
+ ref?: Ref<HTMLElement>;
527
+ }): JSX.Element;
528
+
529
+ export declare namespace List {
530
+ var displayName: string;
531
+ }
532
+
533
+ export declare function ListItem({ disabled, selected, leading, trailing, className, children, ref, ...rest }: ListItemProps & {
534
+ ref?: Ref<HTMLLIElement>;
535
+ }): JSX.Element;
443
536
 
444
- export declare const ListItem: default_2.ForwardRefExoticComponent<ListItemProps & default_2.RefAttributes<HTMLLIElement>>;
537
+ export declare namespace ListItem {
538
+ var displayName: string;
539
+ }
445
540
 
446
541
  export declare interface ListItemProps extends default_2.LiHTMLAttributes<HTMLLIElement> {
447
542
  disabled?: boolean;
@@ -460,7 +555,13 @@ export declare type ListSize = 'sm' | 'md' | 'lg';
460
555
 
461
556
  export declare type ListVariant = 'unordered' | 'ordered' | 'none';
462
557
 
463
- export declare const Modal: default_2.ForwardRefExoticComponent<ModalProps & default_2.RefAttributes<HTMLDivElement>>;
558
+ export declare function Modal({ open, onClose, title, description, footer, size, preventBackdropClose, hideCloseButton, children, className, ref, }: ModalProps & {
559
+ ref?: Ref<HTMLDivElement>;
560
+ }): JSX.Element | null;
561
+
562
+ export declare namespace Modal {
563
+ var displayName: string;
564
+ }
464
565
 
465
566
  export declare function ModalActions({ leading, children, className }: ModalActionsProps): JSX.Element;
466
567
 
@@ -495,7 +596,13 @@ export declare interface ModalProps {
495
596
 
496
597
  export declare type ModalSize = 'sm' | 'md' | 'lg' | 'xl' | 'full';
497
598
 
498
- export declare const MultiSelect: default_2.ForwardRefExoticComponent<MultiSelectProps & default_2.RefAttributes<HTMLDivElement>>;
599
+ export declare function MultiSelect({ options, value, defaultValue, placeholder, size, disabled, searchable, label, error, maxSelected, onChange, className, id: idProp, ref, }: MultiSelectProps & {
600
+ ref?: Ref<HTMLDivElement>;
601
+ }): JSX.Element;
602
+
603
+ export declare namespace MultiSelect {
604
+ var displayName: string;
605
+ }
499
606
 
500
607
  export declare interface MultiSelectProps {
501
608
  options: SelectOption[];
@@ -513,7 +620,13 @@ export declare interface MultiSelectProps {
513
620
  id?: string;
514
621
  }
515
622
 
516
- declare const Notification_2: default_2.ForwardRefExoticComponent<NotificationProps & default_2.RefAttributes<HTMLDivElement>>;
623
+ declare function Notification_2({ variant, title, message, duration, dismissible, onDismiss, className, ref, }: NotificationProps & {
624
+ ref?: Ref<HTMLDivElement>;
625
+ }): JSX.Element;
626
+
627
+ declare namespace Notification_2 {
628
+ var displayName: string;
629
+ }
517
630
  export { Notification_2 as Notification }
518
631
 
519
632
  declare interface NotificationContextValue {
@@ -543,7 +656,13 @@ export declare function NotificationProvider({ children, position, }: {
543
656
 
544
657
  export declare type NotificationVariant = 'info' | 'success' | 'warning' | 'error';
545
658
 
546
- export declare const Pagination: default_2.ForwardRefExoticComponent<PaginationProps & default_2.RefAttributes<HTMLElement>>;
659
+ export declare function Pagination({ total, page, pageSize, pageSizeOptions, onPageChange, onPageSizeChange, size, showFirstLast, showPageNumbers, showPageSize, showGoToPage, siblingCount, className, ref, }: PaginationProps & {
660
+ ref?: Ref<HTMLElement>;
661
+ }): JSX.Element;
662
+
663
+ export declare namespace Pagination {
664
+ var displayName: string;
665
+ }
547
666
 
548
667
  export declare interface PaginationProps {
549
668
  /** Total number of items */
@@ -572,7 +691,13 @@ export declare interface PaginationProps {
572
691
 
573
692
  export declare type PaginationSize = 'sm' | 'md';
574
693
 
575
- export declare const ProgressBar: default_2.ForwardRefExoticComponent<ProgressBarProps & default_2.RefAttributes<HTMLDivElement>>;
694
+ export declare function ProgressBar({ value, max, size, variant, label, showValue, animated, indeterminate, className, ref, }: ProgressBarProps & {
695
+ ref?: Ref<HTMLDivElement>;
696
+ }): JSX.Element;
697
+
698
+ export declare namespace ProgressBar {
699
+ var displayName: string;
700
+ }
576
701
 
577
702
  export declare interface ProgressBarProps {
578
703
  /** Current value (0 – max) */
@@ -595,7 +720,13 @@ export declare type ProgressBarSize = 'sm' | 'md' | 'lg';
595
720
 
596
721
  export declare type ProgressBarVariant = 'default' | 'success' | 'warning' | 'error';
597
722
 
598
- export declare const RichTextEditor: default_2.ForwardRefExoticComponent<RichTextEditorProps & default_2.RefAttributes<HTMLDivElement>>;
723
+ export declare function RichTextEditor({ value, defaultValue, placeholder, size, disabled, label, error, minHeight, onChange, className, id, ref, }: RichTextEditorProps & {
724
+ ref?: Ref<HTMLDivElement>;
725
+ }): JSX.Element;
726
+
727
+ export declare namespace RichTextEditor {
728
+ var displayName: string;
729
+ }
599
730
 
600
731
  export declare interface RichTextEditorProps {
601
732
  value?: string;
@@ -613,7 +744,13 @@ export declare interface RichTextEditorProps {
613
744
 
614
745
  export declare type RichTextEditorSize = 'sm' | 'md' | 'lg';
615
746
 
616
- export declare const Select: default_2.ForwardRefExoticComponent<SelectProps & default_2.RefAttributes<HTMLDivElement>>;
747
+ export declare function Select({ options, value, defaultValue, placeholder, size, disabled, searchable, clearable, label, error, onChange, className, id: idProp, ref, }: SelectProps & {
748
+ ref?: Ref<HTMLDivElement>;
749
+ }): JSX.Element;
750
+
751
+ export declare namespace Select {
752
+ var displayName: string;
753
+ }
617
754
 
618
755
  export declare interface SelectOption {
619
756
  value: string;
@@ -658,7 +795,13 @@ export declare interface SkeletonProps {
658
795
 
659
796
  export declare type SkeletonVariant = 'text' | 'circle' | 'rect';
660
797
 
661
- export declare const Slider: default_2.ForwardRefExoticComponent<SliderProps & default_2.RefAttributes<HTMLInputElement>>;
798
+ export declare function Slider({ value, defaultValue, min, max, step, disabled, label, showValue, showTicks, size, onChange, formatValue, className, ref, }: SliderProps & {
799
+ ref?: Ref<HTMLInputElement>;
800
+ }): JSX.Element;
801
+
802
+ export declare namespace Slider {
803
+ var displayName: string;
804
+ }
662
805
 
663
806
  export declare interface SliderProps {
664
807
  value?: number;
@@ -701,7 +844,13 @@ export declare type SpinnerSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
701
844
 
702
845
  export declare type SpinnerVariant = 'primary' | 'white' | 'current';
703
846
 
704
- export declare const Stepper: default_2.ForwardRefExoticComponent<StepperProps & default_2.RefAttributes<HTMLElement>>;
847
+ export declare function Stepper({ steps, activeStep, orientation, onStepClick, className, ref, }: StepperProps & {
848
+ ref?: Ref<HTMLElement>;
849
+ }): JSX.Element;
850
+
851
+ export declare namespace Stepper {
852
+ var displayName: string;
853
+ }
705
854
 
706
855
  export declare type StepperOrientation = 'horizontal' | 'vertical';
707
856
 
@@ -721,7 +870,13 @@ export declare interface StepperStep {
721
870
  optional?: boolean;
722
871
  }
723
872
 
724
- export declare const Switch: ForwardRefExoticComponent<SwitchProps & RefAttributes<HTMLInputElement>>;
873
+ export declare function Switch({ id, name, checked, defaultChecked, disabled, label, labelPosition, size, onChange, className, 'aria-label': ariaLabel, ref, }: SwitchProps & {
874
+ ref?: Ref<HTMLInputElement>;
875
+ }): JSX.Element;
876
+
877
+ export declare namespace Switch {
878
+ var displayName: string;
879
+ }
725
880
 
726
881
  export declare interface SwitchProps {
727
882
  id?: string;
@@ -747,9 +902,13 @@ export declare namespace Tab {
747
902
  var displayName: string;
748
903
  }
749
904
 
750
- export declare const Table: <T extends Record<string, unknown>>(props: TableProps<T> & {
751
- ref?: default_2.Ref<HTMLDivElement>;
752
- }) => default_2.ReactElement;
905
+ export declare function Table<T extends Record<string, unknown>>({ columns, data, rowKey, sortKey, sortDirection, onSort, selectable, selectedKeys, onSelectionChange, striped, hoverable, bordered, size, emptyState, loading, loadingRows, className, tableClassName, ref, }: TableProps<T> & {
906
+ ref?: Ref<HTMLDivElement>;
907
+ }): JSX.Element;
908
+
909
+ export declare namespace Table {
910
+ var displayName: string;
911
+ }
753
912
 
754
913
  export declare interface TableColumn<T = Record<string, unknown>> {
755
914
  /** Unique key matching a property of T, or a custom id */
@@ -864,7 +1023,13 @@ export declare type TabsSize = 'sm' | 'md';
864
1023
 
865
1024
  export declare type TabsVariant = 'underline' | 'button' | 'line' | 'enclosed' | 'pills';
866
1025
 
867
- export declare const Tag: default_2.ForwardRefExoticComponent<TagProps & default_2.RefAttributes<HTMLSpanElement>>;
1026
+ export declare function Tag({ size, variant, dismissible, onDismiss, disabled, className, children, ref, ...rest }: TagProps & {
1027
+ ref?: Ref<HTMLSpanElement>;
1028
+ }): JSX.Element;
1029
+
1030
+ export declare namespace Tag {
1031
+ var displayName: string;
1032
+ }
868
1033
 
869
1034
  export declare interface TagProps extends default_2.HTMLAttributes<HTMLSpanElement> {
870
1035
  size?: TagSize;
@@ -878,7 +1043,13 @@ export declare type TagSize = 'sm' | 'md' | 'lg';
878
1043
 
879
1044
  export declare type TagVariant = 'default' | 'primary' | 'success' | 'warning' | 'error';
880
1045
 
881
- export declare const Textarea: ForwardRefExoticComponent<TextareaProps & RefAttributes<HTMLTextAreaElement>>;
1046
+ export declare function Textarea({ id, name, value, defaultValue, placeholder, label, helperText, errorMessage, disabled, required, readOnly, autoResize, rows, maxLength, showCount, onChange, onBlur, className, ref, }: TextareaProps & {
1047
+ ref?: Ref<HTMLTextAreaElement>;
1048
+ }): JSX.Element;
1049
+
1050
+ export declare namespace Textarea {
1051
+ var displayName: string;
1052
+ }
882
1053
 
883
1054
  export declare interface TextareaProps {
884
1055
  id?: string;
@@ -903,7 +1074,9 @@ export declare interface TextareaProps {
903
1074
  className?: string;
904
1075
  }
905
1076
 
906
- export declare function Tooltip({ content, children, position, delay, className, }: TooltipProps): JSX.Element;
1077
+ export declare function Tooltip({ content, children, position, delay, className, ref, }: TooltipProps & {
1078
+ ref?: Ref<HTMLSpanElement>;
1079
+ }): JSX.Element;
907
1080
 
908
1081
  export declare namespace Tooltip {
909
1082
  var displayName: string;