@chayns-components/core 5.5.27 → 5.5.29
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/AGENTS.md +875 -64
- package/lib/cjs/components/copyable-content/CopyableContent.js +4 -3
- package/lib/cjs/components/copyable-content/CopyableContent.js.map +1 -1
- package/lib/cjs/components/copyable-content/CopyableContent.test.js +14 -0
- package/lib/cjs/components/copyable-content/CopyableContent.test.js.map +1 -1
- package/lib/cjs/components/copyable-content/copyableContentClipboard.js +6 -5
- package/lib/cjs/components/copyable-content/copyableContentClipboard.js.map +1 -1
- package/lib/cjs/components/copyable-content/copyableContentClipboard.test.js +6 -0
- package/lib/cjs/components/copyable-content/copyableContentClipboard.test.js.map +1 -1
- package/lib/esm/components/copyable-content/CopyableContent.js +4 -3
- package/lib/esm/components/copyable-content/CopyableContent.js.map +1 -1
- package/lib/esm/components/copyable-content/CopyableContent.test.js +14 -0
- package/lib/esm/components/copyable-content/CopyableContent.test.js.map +1 -1
- package/lib/esm/components/copyable-content/copyableContentClipboard.js +6 -5
- package/lib/esm/components/copyable-content/copyableContentClipboard.js.map +1 -1
- package/lib/esm/components/copyable-content/copyableContentClipboard.test.js +6 -0
- package/lib/esm/components/copyable-content/copyableContentClipboard.test.js.map +1 -1
- package/lib/types/components/copyable-content/CopyableContent.d.ts +4 -0
- package/lib/types/components/copyable-content/copyableContentClipboard.d.ts +1 -1
- package/package.json +4 -4
package/AGENTS.md
CHANGED
|
@@ -478,7 +478,40 @@ import { Accordion } from '@chayns-components/core';
|
|
|
478
478
|
|
|
479
479
|
### Props
|
|
480
480
|
|
|
481
|
-
|
|
481
|
+
| name | type | required | description |
|
|
482
|
+
| --- | --- | --- | --- |
|
|
483
|
+
| `bodyMaxHeight` | `number \| undefined` | no | Maximum height of the accordion body element. This automatically makes the content of the<br />body element scrollable. |
|
|
484
|
+
| `children` | `ReactNode` | yes | The content of the accordion body |
|
|
485
|
+
| `colors` | `AccordionColors \| undefined` | no | Provide custom colors to the Accordion Component |
|
|
486
|
+
| `icon` | `string \| undefined` | no | The icon that is displayed in front of the title |
|
|
487
|
+
| `isDefaultOpen` | `boolean \| undefined` | no | This can be used to automatically expand the Accordion during the first render. |
|
|
488
|
+
| `isDisabled` | `boolean \| undefined` | no | This will disable the Accordion so that it cannot be opened and will gray out the title. Does not work with isOpened. |
|
|
489
|
+
| `isFixed` | `boolean \| undefined` | no | This can be used so that the Accordion cannot be opened or closed.<br />In addition, in this case the icon is exchanged to mark the Accordions. |
|
|
490
|
+
| `isOpened` | `boolean \| undefined` | no | This can be used to open the Accordion from the outside |
|
|
491
|
+
| `isTitleGreyed` | `boolean \| undefined` | no | This will gray out the title of the Accordion to indicate hidden content, for example. |
|
|
492
|
+
| `onBodyAnimationComplete` | `VoidFunction \| undefined` | no | Function that is executed when the accordion body is animated |
|
|
493
|
+
| `onBodyScroll` | `((event: UIEvent<HTMLDivElement, UIEvent>) => void) \| undefined` | no | Function that is executed when the accordion body will be scrolled |
|
|
494
|
+
| `onClose` | `VoidFunction \| undefined` | no | Function that is executed when the accordion will be closed. |
|
|
495
|
+
| `onHoverEnd` | `MouseEventHandler<HTMLDivElement> \| undefined` | no | Function to be executed when the accordion is no longer hovered. |
|
|
496
|
+
| `onHoverStart` | `MouseEventHandler<HTMLDivElement> \| undefined` | no | Function to be executed when the accordion is hovered. |
|
|
497
|
+
| `onOpen` | `VoidFunction \| undefined` | no | Function that is executed when the accordion will be opened. |
|
|
498
|
+
| `onSearchChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when the text of the search in the accordion<br />head changes. When this function is given, the search field is displayed<br />in the Accordion Head. |
|
|
499
|
+
| `onTitleInputChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when the text of the search in the accordion<br />title changes. When this function is given, the search field is displayed<br />as the Accordion title. |
|
|
500
|
+
| `rightElement` | `ReactNode` | no | Content to be displayed on the right side in the head of the Accordion |
|
|
501
|
+
| `searchPlaceholder` | `string \| undefined` | no | The placeholder to be used for the search |
|
|
502
|
+
| `searchValue` | `string \| undefined` | no | The value that is displayed inside the search |
|
|
503
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. The highlighting is only visible while the<br />user navigates with the keyboard and is reset on mouse movement or click. |
|
|
504
|
+
| `shouldForceBackground` | `boolean \| undefined` | no | This will force the background color of the accordion to be used even if it is closed and not hovered. |
|
|
505
|
+
| `shouldForceBottomLine` | `boolean \| undefined` | no | Whether the bottom line should always be shown, regardless of other line-related props. |
|
|
506
|
+
| `shouldHideBackground` | `boolean \| undefined` | no | This will hide the background color of the accordion |
|
|
507
|
+
| `shouldHideBottomLine` | `boolean \| undefined` | no | Whether the bottom line should be hidden. |
|
|
508
|
+
| `shouldIndex` | `boolean \| undefined` | no | Whether the accordion should be indexed. |
|
|
509
|
+
| `shouldRenderClosed` | `boolean \| undefined` | no | This will render the Accordion closed on the first render. |
|
|
510
|
+
| `shouldRotateIcon` | `boolean \| undefined` | no | Whether the icon should be rotating. |
|
|
511
|
+
| `shouldSkipAnimation` | `boolean \| undefined` | no | Whether the animation should be skipped.<br />If 'isDefaultOpen' is true the initial animation will be skipped even this prop is false |
|
|
512
|
+
| `title` | `string \| undefined` | no | Title of the Accordion displayed in the head |
|
|
513
|
+
| `titleElement` | `ReactNode` | no | Additional elements to be displayed in the header next to the title. |
|
|
514
|
+
| `titleInputProps` | `InputProps \| undefined` | no | The props of the title Input. |
|
|
482
515
|
|
|
483
516
|
### Types
|
|
484
517
|
|
|
@@ -488,10 +521,12 @@ No additional exported types documented.
|
|
|
488
521
|
|
|
489
522
|
- Import `Accordion` directly from `@chayns-components/core` instead of internal source paths.
|
|
490
523
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
524
|
+
- Pay special attention to required props: `children`.
|
|
491
525
|
|
|
492
526
|
### Anti Patterns
|
|
493
527
|
|
|
494
528
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
529
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
495
530
|
## AmountControl
|
|
496
531
|
|
|
497
532
|
`AmountControl` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -534,7 +569,22 @@ import { AmountControl } from '@chayns-components/core';
|
|
|
534
569
|
|
|
535
570
|
### Props
|
|
536
571
|
|
|
537
|
-
|
|
572
|
+
| name | type | required | description |
|
|
573
|
+
| --- | --- | --- | --- |
|
|
574
|
+
| `amount` | `number \| undefined` | no | The amount that should be displayed. |
|
|
575
|
+
| `icon` | `string \| undefined` | no | The icon that should be displayed if no amount is selected. |
|
|
576
|
+
| `iconColor` | `string \| undefined` | no | The color of the icon. |
|
|
577
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the control should be disabled |
|
|
578
|
+
| `label` | `string \| undefined` | no | A Text that should be displayed if no amount is selected; |
|
|
579
|
+
| `maxAmount` | `number \| undefined` | no | The maximum allowed amount. If the maxAmount is reached, a check icon is displayed on the left side. |
|
|
580
|
+
| `minAmount` | `number \| undefined` | no | The minimum allowed amount. |
|
|
581
|
+
| `onChange` | `((amount: number) => void) \| undefined` | no | A Function that is executed when the amount is changed |
|
|
582
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. The highlighting is only visible while the<br />user navigates with the keyboard and is reset on mouse movement or click. |
|
|
583
|
+
| `shouldForceLabel` | `boolean \| undefined` | no | Whether the label should be displayed even if an amount is selected. |
|
|
584
|
+
| `shouldShowAddIconOnMinAmount` | `boolean \| undefined` | no | Whether the "add"-icon should be displayed if the minAmount is reached. |
|
|
585
|
+
| `shouldShowIcon` | `boolean \| undefined` | no | Whether the icon should be displayed if no amount is selected |
|
|
586
|
+
| `shouldShowWideInput` | `boolean \| undefined` | no | Whether the input should be wider |
|
|
587
|
+
| `step` | `number \| undefined` | no | Defines the amount that will change when adjusted |
|
|
538
588
|
|
|
539
589
|
### Types
|
|
540
590
|
|
|
@@ -548,6 +598,7 @@ No additional exported types documented.
|
|
|
548
598
|
### Anti Patterns
|
|
549
599
|
|
|
550
600
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
601
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
551
602
|
## AnimatedNumber
|
|
552
603
|
|
|
553
604
|
`AnimatedNumber` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -570,7 +621,17 @@ import { AnimatedNumber } from '@chayns-components/core';
|
|
|
570
621
|
|
|
571
622
|
### Props
|
|
572
623
|
|
|
573
|
-
|
|
624
|
+
| name | type | required | description |
|
|
625
|
+
| --- | --- | --- | --- |
|
|
626
|
+
| `delay` | `number \| undefined` | no | Start delay of the animation in seconds. |
|
|
627
|
+
| `duration` | `number \| undefined` | no | Total duration of the animation in seconds. |
|
|
628
|
+
| `ease` | `Ease \| undefined` | no | Easing curve of the animation (e.g., cubic-bezier like [0.16, 1, 0.3, 1] or predefined easings).<br />Controls how the animation accelerates/decelerates. |
|
|
629
|
+
| `format` | `((n: number) => string) \| undefined` | no | Custom formatter for the displayed value.<br />If provided, it overrides locale/toLocaleString and round.<br />Example: (n) => `${Math.round(n)} points` |
|
|
630
|
+
| `locale` | `string \| undefined` | no | Locale used by toLocaleString when no custom formatter is provided. |
|
|
631
|
+
| `onComplete` | `(() => void) \| undefined` | no | Callback invoked when the animation completes. |
|
|
632
|
+
| `round` | `((n: number) => number) \| undefined` | no | Custom rounding function when no custom formatter is provided.<br />Default: Math.round |
|
|
633
|
+
| `startFrom` | `number \| undefined` | no | Starting value for the animation.<br />Default: 0 |
|
|
634
|
+
| `value` | `number` | yes | Target value to animate to. |
|
|
574
635
|
|
|
575
636
|
### Types
|
|
576
637
|
|
|
@@ -580,10 +641,12 @@ No additional exported types documented.
|
|
|
580
641
|
|
|
581
642
|
- Import `AnimatedNumber` directly from `@chayns-components/core` instead of internal source paths.
|
|
582
643
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
644
|
+
- Pay special attention to required props: `value`.
|
|
583
645
|
|
|
584
646
|
### Anti Patterns
|
|
585
647
|
|
|
586
648
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
649
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
587
650
|
## Badge
|
|
588
651
|
|
|
589
652
|
`Badge` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -635,11 +698,30 @@ import { Badge } from '@chayns-components/core';
|
|
|
635
698
|
|
|
636
699
|
### Props
|
|
637
700
|
|
|
638
|
-
|
|
701
|
+
| name | type | required | description |
|
|
702
|
+
| --- | --- | --- | --- |
|
|
703
|
+
| `backgroundColor` | `BackgroundColor \| undefined` | no | The background color of the badge. |
|
|
704
|
+
| `children` | `ReactNode` | no | The content of the badge. |
|
|
705
|
+
| `className` | `string \| undefined` | no | Additional class names for the badge element. |
|
|
706
|
+
| `design` | `BadgeDesign \| undefined` | no | The design of the Badge. |
|
|
707
|
+
| `fontColor` | `Color \| undefined` | no | The font color of the badge. |
|
|
708
|
+
| `onClick` | `MouseEventHandler \| undefined` | no | Function to be executed when the badge is clicked. |
|
|
709
|
+
| `size` | `BadgeSize \| undefined` | no | The size of the badge. |
|
|
639
710
|
|
|
640
711
|
### Types
|
|
641
712
|
|
|
642
|
-
|
|
713
|
+
- `BadgeDesign` -> `enum BadgeDesign {
|
|
714
|
+
/** Default design with background color and no border */
|
|
715
|
+
DEFAULT = 'default',
|
|
716
|
+
/** Design with border only, no background color */
|
|
717
|
+
BORDER = 'border',
|
|
718
|
+
}`
|
|
719
|
+
- `BadgeSize` -> `enum BadgeSize {
|
|
720
|
+
/** Small size */
|
|
721
|
+
SMALL = 'small',
|
|
722
|
+
/** Default size */
|
|
723
|
+
DEFAULT = 'default',
|
|
724
|
+
}`
|
|
643
725
|
|
|
644
726
|
### Usage Notes
|
|
645
727
|
|
|
@@ -649,6 +731,7 @@ No additional exported types documented.
|
|
|
649
731
|
### Anti Patterns
|
|
650
732
|
|
|
651
733
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
734
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
652
735
|
## Button
|
|
653
736
|
|
|
654
737
|
`Button` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -699,7 +782,21 @@ import { Button } from '@chayns-components/core';
|
|
|
699
782
|
|
|
700
783
|
### Props
|
|
701
784
|
|
|
702
|
-
|
|
785
|
+
| name | type | required | description |
|
|
786
|
+
| --- | --- | --- | --- |
|
|
787
|
+
| `buttonDesign` | `number \| undefined` | no | Optional button design override. |
|
|
788
|
+
| `children` | `ReactNode` | no | The label of the button. |
|
|
789
|
+
| `className` | `string \| undefined` | no | Additional class names for the button element. |
|
|
790
|
+
| `icon` | `string \| undefined` | no | An icon that is displayed on the left-hand side of the button text. |
|
|
791
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the button is disabled and cannot be clicked anymore. |
|
|
792
|
+
| `isSecondary` | `boolean \| undefined` | no | Displays the button in the secondary style. |
|
|
793
|
+
| `onClick` | `MouseEventHandler<HTMLButtonElement>` | yes | Function to be executed when the button is clicked. |
|
|
794
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
795
|
+
| `shouldShowAsSelectButton` | `boolean \| undefined` | no | Whether the button should be displayed as a selectButton. |
|
|
796
|
+
| `shouldShowTextAsRobotoMedium` | `boolean \| undefined` | no | Whether the text should be 'Roboto Medium'. |
|
|
797
|
+
| `shouldShowWaitCursor` | `boolean \| undefined` | no | Shows a wait cursor instead of button text. |
|
|
798
|
+
| `shouldStopPropagation` | `boolean \| undefined` | no | Stops event propagation on click. |
|
|
799
|
+
| `tapDuration` | `number \| undefined` | no | Duration in seconds for the tap animation. |
|
|
703
800
|
|
|
704
801
|
### Types
|
|
705
802
|
|
|
@@ -709,10 +806,12 @@ No additional exported types documented.
|
|
|
709
806
|
|
|
710
807
|
- Import `Button` directly from `@chayns-components/core` instead of internal source paths.
|
|
711
808
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
809
|
+
- Pay special attention to required props: `onClick`.
|
|
712
810
|
|
|
713
811
|
### Anti Patterns
|
|
714
812
|
|
|
715
813
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
814
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
716
815
|
## Checkbox
|
|
717
816
|
|
|
718
817
|
`Checkbox` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -735,7 +834,19 @@ import { Checkbox } from '@chayns-components/core';
|
|
|
735
834
|
|
|
736
835
|
### Props
|
|
737
836
|
|
|
738
|
-
|
|
837
|
+
| name | type | required | description |
|
|
838
|
+
| --- | --- | --- | --- |
|
|
839
|
+
| `borderRadius` | `BorderRadius<string \| number> \| undefined` | no | Border radius for the checkbox or switch indicator. |
|
|
840
|
+
| `children` | `string \| ReactElement<any, string \| JSXElementConstructor<any>> \| undefined` | no | Text for checkbox or switch |
|
|
841
|
+
| `colors` | `CheckboxColors \| undefined` | no | No description available. |
|
|
842
|
+
| `isChecked` | `boolean \| undefined` | no | Indicates whether the checkbox or switch is selected |
|
|
843
|
+
| `isDisabled` | `boolean \| undefined` | no | Disables the checkbox or switch so it cannot be toggled |
|
|
844
|
+
| `labelClassName` | `string \| undefined` | no | Classname for the label |
|
|
845
|
+
| `onChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed if the checked value changes |
|
|
846
|
+
| `shouldChangeOnLabelClick` | `boolean \| undefined` | no | Whether the label should change the state of the checkbox |
|
|
847
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
848
|
+
| `shouldShowAsSwitch` | `boolean \| undefined` | no | Changes the design to use switch instead of checkbox |
|
|
849
|
+
| `shouldShowCentered` | `boolean \| undefined` | no | Whether the Checkbox should be displayed centered to the label or at the top |
|
|
739
850
|
|
|
740
851
|
### Types
|
|
741
852
|
|
|
@@ -749,6 +860,7 @@ No additional exported types documented.
|
|
|
749
860
|
### Anti Patterns
|
|
750
861
|
|
|
751
862
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
863
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
752
864
|
## ComboBox
|
|
753
865
|
|
|
754
866
|
`ComboBox` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1278,20 +1390,69 @@ import { ComboBox } from '@chayns-components/core';
|
|
|
1278
1390
|
|
|
1279
1391
|
### Props
|
|
1280
1392
|
|
|
1281
|
-
|
|
1393
|
+
| name | type | required | description |
|
|
1394
|
+
| --- | --- | --- | --- |
|
|
1395
|
+
| `bodyWidth` | `number \| undefined` | no | The width of the body. |
|
|
1396
|
+
| `container` | `Element \| undefined` | no | The element where the content of the `ComboBox` should be rendered via React Portal. |
|
|
1397
|
+
| `direction` | `DropdownDirection \| undefined` | no | The direction in which the combobox should open. |
|
|
1398
|
+
| `inputValue` | `string \| undefined` | no | The value of the optional input. |
|
|
1399
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the combobox should be disabled. |
|
|
1400
|
+
| `lists` | `IComboBoxItems[]` | yes | The list of the items that should be displayed. |
|
|
1401
|
+
| `maxHeight` | `number \| undefined` | no | The maximum height of the combobox content. |
|
|
1402
|
+
| `onHide` | `(() => void) \| undefined` | no | Function to be executed when the content of the `ComboBox` is hidden. |
|
|
1403
|
+
| `onInputBlur` | `FocusEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed when the optional input lost its focus. |
|
|
1404
|
+
| `onInputChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed when the value of the optional input is changed. |
|
|
1405
|
+
| `onInputFocus` | `FocusEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed when the optional input gets its focus. |
|
|
1406
|
+
| `onSelect` | `((comboboxItem?: IComboBoxItem \| undefined) => boolean \| void \| Promise<boolean>) \| undefined` | no | Function that should be executed when an item is selected. If the function returns false, the item will not be selected. |
|
|
1407
|
+
| `onShow` | `(() => void) \| undefined` | no | Function to be executed when the content of the `ComboBox` is shown. |
|
|
1408
|
+
| `placeholder` | `string` | yes | A text that should be displayed when no item is selected. |
|
|
1409
|
+
| `prefix` | `string \| undefined` | no | A prefix that should be displayed before the placeholder. |
|
|
1410
|
+
| `prefixMinWidth` | `number \| undefined` | no | Optional min width for the prefix element. |
|
|
1411
|
+
| `selectedItem` | `IComboBoxItem \| undefined` | no | An item that should be preselected. |
|
|
1412
|
+
| `shouldCaptureEvents` | `boolean \| undefined` | no | Whether the outside events should be captured. |
|
|
1413
|
+
| `shouldDropDownUseMaxItemWidth` | `boolean \| undefined` | no | If true, the dropdown will use the maximum width of the items. |
|
|
1414
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables the shared keyboard-only focus ring for the combobox header. |
|
|
1415
|
+
| `shouldShowBigImage` | `boolean \| undefined` | no | If true, the images of the items are displayed in a bigger shape. This prop will automatically be set to true if the subtext of an item is given. |
|
|
1416
|
+
| `shouldShowClearIcon` | `boolean \| undefined` | no | If true, a clear icon is displayed at the end of the combo box if an item is selected. |
|
|
1417
|
+
| `shouldShowRoundImage` | `boolean \| undefined` | no | If true, the images of the items are displayed in a round shape. |
|
|
1418
|
+
| `shouldShowTransparentBackground` | `boolean \| undefined` | no | Whether the background should be transparent. |
|
|
1419
|
+
| `shouldUseCurrentItemWidth` | `boolean \| undefined` | no | Whether the width of the ComboBox should be the width of the current item. |
|
|
1420
|
+
| `shouldUseFullWidth` | `boolean \| undefined` | no | Whether the width of the 'ComboBox' should be the width of the parent or of the widest item. |
|
|
1421
|
+
| `size` | `ComboBoxSize \| undefined` | no | The size of the ComboBox. |
|
|
1282
1422
|
|
|
1283
1423
|
### Types
|
|
1284
1424
|
|
|
1285
|
-
|
|
1425
|
+
- `ComboBoxSize` -> `enum ComboBoxSize {
|
|
1426
|
+
/**
|
|
1427
|
+
* Standard height and spacing.
|
|
1428
|
+
*/
|
|
1429
|
+
NORMAL = 'normal',
|
|
1430
|
+
/**
|
|
1431
|
+
* Compact height and spacing.
|
|
1432
|
+
*/
|
|
1433
|
+
SMALL = 'small',
|
|
1434
|
+
}`
|
|
1435
|
+
- `DropdownDirection` -> `enum DropdownDirection {
|
|
1436
|
+
BOTTOM,
|
|
1437
|
+
TOP,
|
|
1438
|
+
BOTTOM_LEFT,
|
|
1439
|
+
BOTTOM_RIGHT,
|
|
1440
|
+
TOP_LEFT,
|
|
1441
|
+
TOP_RIGHT,
|
|
1442
|
+
LEFT,
|
|
1443
|
+
RIGHT,
|
|
1444
|
+
}`
|
|
1286
1445
|
|
|
1287
1446
|
### Usage Notes
|
|
1288
1447
|
|
|
1289
1448
|
- Import `ComboBox` directly from `@chayns-components/core` instead of internal source paths.
|
|
1290
1449
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
1450
|
+
- Pay special attention to required props: `lists`, `placeholder`.
|
|
1291
1451
|
|
|
1292
1452
|
### Anti Patterns
|
|
1293
1453
|
|
|
1294
1454
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
1455
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1295
1456
|
## ContentCard
|
|
1296
1457
|
|
|
1297
1458
|
`ContentCard` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1336,11 +1497,21 @@ import { ContentCard } from '@chayns-components/core';
|
|
|
1336
1497
|
|
|
1337
1498
|
### Props
|
|
1338
1499
|
|
|
1339
|
-
|
|
1500
|
+
| name | type | required | description |
|
|
1501
|
+
| --- | --- | --- | --- |
|
|
1502
|
+
| `children` | `ReactNode` | no | The content of the content card |
|
|
1503
|
+
| `onClick` | `(() => void) \| undefined` | no | The onClick event handler |
|
|
1504
|
+
| `type` | `ContentCardType \| undefined` | no | The type of the content card |
|
|
1340
1505
|
|
|
1341
1506
|
### Types
|
|
1342
1507
|
|
|
1343
|
-
|
|
1508
|
+
- `ContentCardType` -> `enum ContentCardType {
|
|
1509
|
+
Default = 'default',
|
|
1510
|
+
Error = 'error',
|
|
1511
|
+
Success = 'success',
|
|
1512
|
+
Warning = 'warning',
|
|
1513
|
+
SiteColor = 'siteColor',
|
|
1514
|
+
}`
|
|
1344
1515
|
|
|
1345
1516
|
### Usage Notes
|
|
1346
1517
|
|
|
@@ -1350,6 +1521,7 @@ No additional exported types documented.
|
|
|
1350
1521
|
### Anti Patterns
|
|
1351
1522
|
|
|
1352
1523
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
1524
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1353
1525
|
## ContextMenu
|
|
1354
1526
|
|
|
1355
1527
|
`ContextMenu` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1451,20 +1623,69 @@ import { ContextMenu } from '@chayns-components/core';
|
|
|
1451
1623
|
|
|
1452
1624
|
### Props
|
|
1453
1625
|
|
|
1454
|
-
|
|
1626
|
+
| name | type | required | description |
|
|
1627
|
+
| --- | --- | --- | --- |
|
|
1628
|
+
| `alignment` | `ContextMenuAlignment \| undefined` | no | Context menu alignment |
|
|
1629
|
+
| `children` | `ReactNode` | no | Children element |
|
|
1630
|
+
| `className` | `string \| undefined` | no | Additional class name applied to the trigger wrapper. |
|
|
1631
|
+
| `container` | `Element \| undefined` | no | Container element |
|
|
1632
|
+
| `coordinates` | `ContextMenuCoordinates \| undefined` | no | Custom coordinates |
|
|
1633
|
+
| `dialogText` | `string \| undefined` | no | Optional text for the select dialog. |
|
|
1634
|
+
| `headline` | `string \| undefined` | no | Context menu headline |
|
|
1635
|
+
| `items` | `ContextMenuItem[]` | yes | Menu items |
|
|
1636
|
+
| `onHide` | `VoidFunction \| undefined` | no | Hide callback function |
|
|
1637
|
+
| `onShow` | `VoidFunction \| undefined` | no | Show callback function |
|
|
1638
|
+
| `shouldCloseOnPopupClick` | `boolean \| undefined` | no | Close on popup click flag |
|
|
1639
|
+
| `shouldDisableClick` | `boolean \| undefined` | no | Disable click flag |
|
|
1640
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for the trigger. |
|
|
1641
|
+
| `shouldHidePopupArrow` | `boolean \| undefined` | no | Hide popup arrow flag |
|
|
1642
|
+
| `shouldShowHoverEffect` | `boolean \| undefined` | no | Show hover effect flag |
|
|
1643
|
+
| `shouldUseDefaultTriggerStyles` | `boolean \| undefined` | no | Whether the default trigger padding/background styles should be applied. |
|
|
1644
|
+
| `style` | `CSSProperties \| undefined` | no | Inline styles applied to the trigger wrapper. |
|
|
1645
|
+
| `yOffset` | `number \| undefined` | no | Vertical offset between the trigger element and the context menu. |
|
|
1646
|
+
| `zIndex` | `number \| undefined` | no | Z-index value |
|
|
1455
1647
|
|
|
1456
1648
|
### Types
|
|
1457
1649
|
|
|
1458
|
-
|
|
1650
|
+
- `ContextMenuAlignment` -> `enum ContextMenuAlignment {
|
|
1651
|
+
TopLeft,
|
|
1652
|
+
BottomLeft,
|
|
1653
|
+
TopRight,
|
|
1654
|
+
BottomRight,
|
|
1655
|
+
TopCenter,
|
|
1656
|
+
BottomCenter,
|
|
1657
|
+
}`
|
|
1658
|
+
- `ContextMenuCoordinates` -> `type ContextMenuCoordinates = {
|
|
1659
|
+
/** The x-coordinate. */
|
|
1660
|
+
x: number;
|
|
1661
|
+
/** The y-coordinate. */
|
|
1662
|
+
y: number;
|
|
1663
|
+
};`
|
|
1664
|
+
- `ContextMenuItem` -> `type ContextMenuItem = {
|
|
1665
|
+
/** Optional icons for the item. Can be strings or React nodes. */
|
|
1666
|
+
icons?: string[] | ReactNode;
|
|
1667
|
+
/** Whether the item is selected. */
|
|
1668
|
+
isSelected?: boolean;
|
|
1669
|
+
/** Unique key for the item. */
|
|
1670
|
+
key: string;
|
|
1671
|
+
/** Function called when the item is clicked. */
|
|
1672
|
+
onClick: (event?: MouseEvent<HTMLDivElement>) => Promise<void> | void;
|
|
1673
|
+
/** Whether to show a spacer after the item. */
|
|
1674
|
+
shouldShowSpacer?: boolean;
|
|
1675
|
+
/** The text displayed for the item. */
|
|
1676
|
+
text: string;
|
|
1677
|
+
};`
|
|
1459
1678
|
|
|
1460
1679
|
### Usage Notes
|
|
1461
1680
|
|
|
1462
1681
|
- Import `ContextMenu` directly from `@chayns-components/core` instead of internal source paths.
|
|
1463
1682
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
1683
|
+
- Pay special attention to required props: `items`.
|
|
1464
1684
|
|
|
1465
1685
|
### Anti Patterns
|
|
1466
1686
|
|
|
1467
1687
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
1688
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1468
1689
|
## CopyableContent
|
|
1469
1690
|
|
|
1470
1691
|
`CopyableContent` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1603,7 +1824,14 @@ import { CopyableContent } from '@chayns-components/core';
|
|
|
1603
1824
|
|
|
1604
1825
|
### Props
|
|
1605
1826
|
|
|
1606
|
-
|
|
1827
|
+
| name | type | required | description |
|
|
1828
|
+
| --- | --- | --- | --- |
|
|
1829
|
+
| `appearance` | `CopyableContentAppearance \| undefined` | no | Controls the visual surface of the content block. |
|
|
1830
|
+
| `children` | `ReactNode` | no | Replaces only the visible rendered content and never the copied source. |
|
|
1831
|
+
| `collapsedHeight` | `number \| undefined` | no | The height of the content in its collapsed state. |
|
|
1832
|
+
| `content` | `string` | yes | Markdown source used for rendering and clipboard data. |
|
|
1833
|
+
| `copyFailedMessage` | `string \| undefined` | no | Replaces the localized error message shown when copying fails. |
|
|
1834
|
+
| `transformClipboardHtml` | `((html: string) => string) \| undefined` | no | Transforms the generated HTML before it is written to the clipboard. |
|
|
1607
1835
|
|
|
1608
1836
|
### Types
|
|
1609
1837
|
|
|
@@ -1613,10 +1841,12 @@ No additional exported types documented.
|
|
|
1613
1841
|
|
|
1614
1842
|
- Import `CopyableContent` directly from `@chayns-components/core` instead of internal source paths.
|
|
1615
1843
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
1844
|
+
- Pay special attention to required props: `content`.
|
|
1616
1845
|
|
|
1617
1846
|
### Anti Patterns
|
|
1618
1847
|
|
|
1619
1848
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
1849
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1620
1850
|
## ExpandableContent
|
|
1621
1851
|
|
|
1622
1852
|
`ExpandableContent` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1643,7 +1873,11 @@ import { ExpandableContent } from '@chayns-components/core';
|
|
|
1643
1873
|
|
|
1644
1874
|
### Props
|
|
1645
1875
|
|
|
1646
|
-
|
|
1876
|
+
| name | type | required | description |
|
|
1877
|
+
| --- | --- | --- | --- |
|
|
1878
|
+
| `children` | `ReactNode` | yes | The children that should be animated. |
|
|
1879
|
+
| `isOpen` | `boolean` | yes | Whether the content is expanded. |
|
|
1880
|
+
| `startDelay` | `number \| undefined` | no | An optional start delay. |
|
|
1647
1881
|
|
|
1648
1882
|
### Types
|
|
1649
1883
|
|
|
@@ -1653,10 +1887,12 @@ No additional exported types documented.
|
|
|
1653
1887
|
|
|
1654
1888
|
- Import `ExpandableContent` directly from `@chayns-components/core` instead of internal source paths.
|
|
1655
1889
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
1890
|
+
- Pay special attention to required props: `children`, `isOpen`.
|
|
1656
1891
|
|
|
1657
1892
|
### Anti Patterns
|
|
1658
1893
|
|
|
1659
1894
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
1895
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1660
1896
|
## FileInput
|
|
1661
1897
|
|
|
1662
1898
|
`FileInput` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1706,7 +1942,23 @@ import { FileInput } from '@chayns-components/core';
|
|
|
1706
1942
|
|
|
1707
1943
|
### Props
|
|
1708
1944
|
|
|
1709
|
-
|
|
1945
|
+
| name | type | required | description |
|
|
1946
|
+
| --- | --- | --- | --- |
|
|
1947
|
+
| `files` | `IFileItem[] \| undefined` | no | Already uploaded files to display. |
|
|
1948
|
+
| `fileSelectionIcons` | `string[] \| undefined` | no | An array of icons that should be displayed inside the FileInput |
|
|
1949
|
+
| `fileSelectionPlaceholder` | `string \| undefined` | no | The text that should be displayed inside the FileInput. |
|
|
1950
|
+
| `fileTypes` | `string \| undefined` | no | The filetypes that could be selected. Example for multiple types: 'image/*, video/*'. |
|
|
1951
|
+
| `imageSelectIcons` | `string[] \| undefined` | no | The icon of the image selection. |
|
|
1952
|
+
| `imageSelectPlaceholder` | `string \| undefined` | no | If set, pictures can be select via Pixabay. |
|
|
1953
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the FileInput is disabled. |
|
|
1954
|
+
| `maxFiles` | `number \| undefined` | no | The maximum amount of Files that can be uploaded. |
|
|
1955
|
+
| `maxFileSizeInMB` | `number \| undefined` | no | The maximum size of a file in MB. |
|
|
1956
|
+
| `onAdd` | `((files: File[] \| UploadedFile[]) => void) \| undefined` | no | A function to be executed when files are added. |
|
|
1957
|
+
| `onMaxFilesReached` | `(() => void) \| undefined` | no | Function to be executed when the maximum amount of Files are reached. |
|
|
1958
|
+
| `onRemove` | `((file: IFileItem \| File \| UploadedFile) => void) \| undefined` | no | A function to be executed when a file is removed. |
|
|
1959
|
+
| `shouldAllowDownload` | `boolean \| undefined` | no | Whether to show a download icon for files that have a `source` set. |
|
|
1960
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for the file selection trigger. |
|
|
1961
|
+
| `shouldPreventImageUpload` | `boolean \| undefined` | no | Whether the image upload should be prevented. |
|
|
1710
1962
|
|
|
1711
1963
|
### Types
|
|
1712
1964
|
|
|
@@ -1720,6 +1972,7 @@ No additional exported types documented.
|
|
|
1720
1972
|
### Anti Patterns
|
|
1721
1973
|
|
|
1722
1974
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
1975
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1723
1976
|
## FileList
|
|
1724
1977
|
|
|
1725
1978
|
`FileList` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1747,7 +2000,11 @@ import { FileList } from '@chayns-components/core';
|
|
|
1747
2000
|
|
|
1748
2001
|
### Props
|
|
1749
2002
|
|
|
1750
|
-
|
|
2003
|
+
| name | type | required | description |
|
|
2004
|
+
| --- | --- | --- | --- |
|
|
2005
|
+
| `files` | `IFileItem[] \| undefined` | no | Already uploaded files to display. |
|
|
2006
|
+
| `onRemove` | `((id: string) => void) \| undefined` | no | A function to be executed when a file is removed. |
|
|
2007
|
+
| `shouldAllowDownload` | `boolean \| undefined` | no | Whether to show a download icon for files that have a `source` set. |
|
|
1751
2008
|
|
|
1752
2009
|
### Types
|
|
1753
2010
|
|
|
@@ -1761,6 +2018,7 @@ No additional exported types documented.
|
|
|
1761
2018
|
### Anti Patterns
|
|
1762
2019
|
|
|
1763
2020
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2021
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1764
2022
|
## FileSelect
|
|
1765
2023
|
|
|
1766
2024
|
`FileSelect` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -1781,7 +2039,19 @@ import { FileSelect } from '@chayns-components/core';
|
|
|
1781
2039
|
|
|
1782
2040
|
### Props
|
|
1783
2041
|
|
|
1784
|
-
|
|
2042
|
+
| name | type | required | description |
|
|
2043
|
+
| --- | --- | --- | --- |
|
|
2044
|
+
| `fileSelectionIcons` | `string[] \| undefined` | no | An array of icons that should be displayed inside the FileInput |
|
|
2045
|
+
| `fileSelectionPlaceholder` | `string \| undefined` | no | The text that should be displayed inside the FileInput. |
|
|
2046
|
+
| `fileTypes` | `string \| undefined` | no | The filetypes that could be selected. Example for multiple types: 'image/*, video/*'. |
|
|
2047
|
+
| `imageSelectIcons` | `string[] \| undefined` | no | The icon of the image selection. |
|
|
2048
|
+
| `imageSelectPlaceholder` | `string \| undefined` | no | If set, pictures can be select via Pixabay. |
|
|
2049
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the FileInput is disabled. |
|
|
2050
|
+
| `maxFiles` | `number \| undefined` | no | The maximum amount of Files that can be uploaded. |
|
|
2051
|
+
| `maxFileSizeInMB` | `number \| undefined` | no | The maximum size of a file in MB. |
|
|
2052
|
+
| `onAdd` | `((files: File[] \| UploadedFile[]) => void) \| undefined` | no | A function to be executed when files are added. |
|
|
2053
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for selection triggers. |
|
|
2054
|
+
| `shouldPreventImageUpload` | `boolean \| undefined` | no | Whether the image upload should be prevented. |
|
|
1785
2055
|
|
|
1786
2056
|
### Types
|
|
1787
2057
|
|
|
@@ -1795,6 +2065,7 @@ No additional exported types documented.
|
|
|
1795
2065
|
### Anti Patterns
|
|
1796
2066
|
|
|
1797
2067
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2068
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
1798
2069
|
## Filter
|
|
1799
2070
|
|
|
1800
2071
|
`Filter` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2007,20 +2278,61 @@ import { Filter } from '@chayns-components/core';
|
|
|
2007
2278
|
|
|
2008
2279
|
### Props
|
|
2009
2280
|
|
|
2010
|
-
|
|
2281
|
+
| name | type | required | description |
|
|
2282
|
+
| --- | --- | --- | --- |
|
|
2283
|
+
| `checkboxConfig` | `CheckboxProps \| undefined` | no | No description available. |
|
|
2284
|
+
| `comboboxConfig` | `ComboboxConfig \| undefined` | no | No description available. |
|
|
2285
|
+
| `filterButtonConfig` | `FilterButtonsProps \| undefined` | no | No description available. |
|
|
2286
|
+
| `headline` | `ReactNode` | yes | No description available. |
|
|
2287
|
+
| `onActiveChange` | `((isActive: boolean) => void) \| undefined` | no | No description available. |
|
|
2288
|
+
| `rightIcons` | `FilterRightIcon[] \| undefined` | no | No description available. |
|
|
2289
|
+
| `searchConfig` | `SearchConfig \| undefined` | no | No description available. |
|
|
2290
|
+
| `shouldAutoFocus` | `boolean \| undefined` | no | No description available. |
|
|
2291
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | No description available. |
|
|
2292
|
+
| `shouldShowRoundedHoverEffect` | `boolean \| undefined` | no | No description available. |
|
|
2293
|
+
| `sortConfig` | `SortConfig \| undefined` | no | No description available. |
|
|
2011
2294
|
|
|
2012
2295
|
### Types
|
|
2013
2296
|
|
|
2014
|
-
|
|
2297
|
+
- `FilterRightIcon` -> `interface FilterRightIcon {
|
|
2298
|
+
icons: string[];
|
|
2299
|
+
onClick: VoidFunction;
|
|
2300
|
+
}`
|
|
2301
|
+
- `SearchConfig` -> `interface SearchConfig {
|
|
2302
|
+
/**
|
|
2303
|
+
* Callback invoked whenever the search input changes.
|
|
2304
|
+
*/
|
|
2305
|
+
onSearchChange: (search: string) => void;
|
|
2306
|
+
/**
|
|
2307
|
+
* Current search value.
|
|
2308
|
+
*/
|
|
2309
|
+
searchValue: string;
|
|
2310
|
+
}`
|
|
2311
|
+
- `SortConfig` -> `interface SortConfig {
|
|
2312
|
+
/**
|
|
2313
|
+
* Callback invoked when a sort item is selected.
|
|
2314
|
+
*/
|
|
2315
|
+
onSortChange: (item: SortItem) => void;
|
|
2316
|
+
/**
|
|
2317
|
+
* Currently selected sort item.
|
|
2318
|
+
*/
|
|
2319
|
+
selectedItem: SortItem;
|
|
2320
|
+
/**
|
|
2321
|
+
* Available sort items.
|
|
2322
|
+
*/
|
|
2323
|
+
items: SortItem[];
|
|
2324
|
+
}`
|
|
2015
2325
|
|
|
2016
2326
|
### Usage Notes
|
|
2017
2327
|
|
|
2018
2328
|
- Import `Filter` directly from `@chayns-components/core` instead of internal source paths.
|
|
2019
2329
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
2330
|
+
- Pay special attention to required props: `headline`.
|
|
2020
2331
|
|
|
2021
2332
|
### Anti Patterns
|
|
2022
2333
|
|
|
2023
2334
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2335
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2024
2336
|
## FilterButtons
|
|
2025
2337
|
|
|
2026
2338
|
`FilterButtons` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2151,20 +2463,33 @@ import { FilterButtons } from '@chayns-components/core';
|
|
|
2151
2463
|
|
|
2152
2464
|
### Props
|
|
2153
2465
|
|
|
2154
|
-
|
|
2466
|
+
| name | type | required | description |
|
|
2467
|
+
| --- | --- | --- | --- |
|
|
2468
|
+
| `allCount` | `number \| undefined` | no | The number that should be displayed as count in the "all" button. |
|
|
2469
|
+
| `items` | `IFilterButtonItem[]` | yes | The items that should be displayed. |
|
|
2470
|
+
| `onSelect` | `((keys: string[]) => void) \| undefined` | no | A function that should be executed when an item is selected. |
|
|
2471
|
+
| `selectedItemIds` | `string[] \| undefined` | no | The keys of items that should be selected. |
|
|
2472
|
+
| `shouldCalcCountForAll` | `boolean \| undefined` | no | If true, the count of all items will be shown in the "all" button. |
|
|
2473
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for filter buttons. |
|
|
2474
|
+
| `size` | `FilterButtonSize \| undefined` | no | The size auf the filter buttons. Use the FilterButtonSize enum. |
|
|
2155
2475
|
|
|
2156
2476
|
### Types
|
|
2157
2477
|
|
|
2158
|
-
|
|
2478
|
+
- `FilterButtonSize` -> `enum FilterButtonSize {
|
|
2479
|
+
Small,
|
|
2480
|
+
Normal,
|
|
2481
|
+
}`
|
|
2159
2482
|
|
|
2160
2483
|
### Usage Notes
|
|
2161
2484
|
|
|
2162
2485
|
- Import `FilterButtons` directly from `@chayns-components/core` instead of internal source paths.
|
|
2163
2486
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
2487
|
+
- Pay special attention to required props: `items`.
|
|
2164
2488
|
|
|
2165
2489
|
### Anti Patterns
|
|
2166
2490
|
|
|
2167
2491
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2492
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2168
2493
|
## GridImage
|
|
2169
2494
|
|
|
2170
2495
|
`GridImage` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2193,7 +2518,14 @@ import { GridImage } from '@chayns-components/core';
|
|
|
2193
2518
|
|
|
2194
2519
|
### Props
|
|
2195
2520
|
|
|
2196
|
-
|
|
2521
|
+
| name | type | required | description |
|
|
2522
|
+
| --- | --- | --- | --- |
|
|
2523
|
+
| `background` | `Background<string \| number> \| undefined` | no | The background color of the image. |
|
|
2524
|
+
| `images` | `string[]` | yes | The images to be displayed in the `GridImage`. Only the first three images are displayed. |
|
|
2525
|
+
| `onClick` | `MouseEventHandler<HTMLDivElement> \| undefined` | no | Function to be executed when the images are clicked. |
|
|
2526
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for clickable GridImage instances. |
|
|
2527
|
+
| `shouldShowRoundImage` | `boolean \| undefined` | no | Images of users should always be displayed in a round shape. Therefore, this property can be set to true. |
|
|
2528
|
+
| `size` | `number` | yes | The size of the `GridImage` in pixels, which is set as both width and height. |
|
|
2197
2529
|
|
|
2198
2530
|
### Types
|
|
2199
2531
|
|
|
@@ -2203,10 +2535,12 @@ No additional exported types documented.
|
|
|
2203
2535
|
|
|
2204
2536
|
- Import `GridImage` directly from `@chayns-components/core` instead of internal source paths.
|
|
2205
2537
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
2538
|
+
- Pay special attention to required props: `images`, `size`.
|
|
2206
2539
|
|
|
2207
2540
|
### Anti Patterns
|
|
2208
2541
|
|
|
2209
2542
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2543
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2210
2544
|
## GroupedImage
|
|
2211
2545
|
|
|
2212
2546
|
`GroupedImage` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2262,7 +2596,18 @@ import { GroupedImage } from '@chayns-components/core';
|
|
|
2262
2596
|
|
|
2263
2597
|
### Props
|
|
2264
2598
|
|
|
2265
|
-
|
|
2599
|
+
| name | type | required | description |
|
|
2600
|
+
| --- | --- | --- | --- |
|
|
2601
|
+
| `cornerElement` | `ReactNode` | no | Optional Element to display in the right corner of the image |
|
|
2602
|
+
| `cornerImage` | `string \| undefined` | no | Optional image to display in the bottom right corner of the grouped image. |
|
|
2603
|
+
| `height` | `number \| undefined` | no | Height of the grouped image container. |
|
|
2604
|
+
| `imageBackground` | `Background<string \| number> \| undefined` | no | Background for the single images. |
|
|
2605
|
+
| `images` | `string[]` | yes | Array of image URLs to display in the grouped image. If only one image is provided, it will be displayed as a full image. |
|
|
2606
|
+
| `onClick` | `MouseEventHandler<HTMLDivElement> \| undefined` | no | Optional click handler for the grouped image. |
|
|
2607
|
+
| `onImageError` | `((event: SyntheticEvent<HTMLImageElement, Event>, index: number) => void) \| undefined` | no | Optional handler for image load errors. |
|
|
2608
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for clickable grouped images. |
|
|
2609
|
+
| `shouldPreventBackground` | `boolean \| undefined` | no | Whether to prevent the background of the images from being set. |
|
|
2610
|
+
| `shouldShowRoundImage` | `boolean \| undefined` | no | Whether to show the images in a round shape. |
|
|
2266
2611
|
|
|
2267
2612
|
### Types
|
|
2268
2613
|
|
|
@@ -2272,10 +2617,12 @@ No additional exported types documented.
|
|
|
2272
2617
|
|
|
2273
2618
|
- Import `GroupedImage` directly from `@chayns-components/core` instead of internal source paths.
|
|
2274
2619
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
2620
|
+
- Pay special attention to required props: `images`.
|
|
2275
2621
|
|
|
2276
2622
|
### Anti Patterns
|
|
2277
2623
|
|
|
2278
2624
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2625
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2279
2626
|
## HighlightSlider
|
|
2280
2627
|
|
|
2281
2628
|
`HighlightSlider` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2298,7 +2645,14 @@ import { HighlightSlider } from '@chayns-components/core';
|
|
|
2298
2645
|
|
|
2299
2646
|
### Props
|
|
2300
2647
|
|
|
2301
|
-
|
|
2648
|
+
| name | type | required | description |
|
|
2649
|
+
| --- | --- | --- | --- |
|
|
2650
|
+
| `colors` | `HighlightSliderItemColors \| undefined` | no | The Colors of the slider. |
|
|
2651
|
+
| `count` | `number` | yes | The total number of sections, that should be displayed. |
|
|
2652
|
+
| `currentIndex` | `number` | yes | The current index. |
|
|
2653
|
+
| `duration` | `number \| undefined` | no | The duration of the animation of a single item in seconds. |
|
|
2654
|
+
| `onIndexChange` | `((index: number) => void) \| undefined` | no | Function to be executed if the index has changed. |
|
|
2655
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for interactive slider items. |
|
|
2302
2656
|
|
|
2303
2657
|
### Types
|
|
2304
2658
|
|
|
@@ -2308,10 +2662,12 @@ No additional exported types documented.
|
|
|
2308
2662
|
|
|
2309
2663
|
- Import `HighlightSlider` directly from `@chayns-components/core` instead of internal source paths.
|
|
2310
2664
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
2665
|
+
- Pay special attention to required props: `count`, `currentIndex`.
|
|
2311
2666
|
|
|
2312
2667
|
### Anti Patterns
|
|
2313
2668
|
|
|
2314
2669
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2670
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2315
2671
|
## Icon
|
|
2316
2672
|
|
|
2317
2673
|
`Icon` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2348,7 +2704,19 @@ import { Icon } from '@chayns-components/core';
|
|
|
2348
2704
|
|
|
2349
2705
|
### Props
|
|
2350
2706
|
|
|
2351
|
-
|
|
2707
|
+
| name | type | required | description |
|
|
2708
|
+
| --- | --- | --- | --- |
|
|
2709
|
+
| `className` | `string \| undefined` | no | Additional class name for the icon wrapper element. |
|
|
2710
|
+
| `color` | `string \| undefined` | no | The color of the icon. |
|
|
2711
|
+
| `icons` | `string[]` | yes | The icon(s) to be displayed. |
|
|
2712
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the icon should be disabled. |
|
|
2713
|
+
| `onClick` | `MouseEventHandler<HTMLSpanElement> \| undefined` | no | Function to be executed when the icon is clicked. |
|
|
2714
|
+
| `onDoubleClick` | `MouseEventHandler<HTMLSpanElement> \| undefined` | no | Function to be executed when the icon is double-clicked. |
|
|
2715
|
+
| `onMouseDown` | `MouseEventHandler<HTMLSpanElement> \| undefined` | no | Function to be executed when the icon is pressed. |
|
|
2716
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for clickable icons. |
|
|
2717
|
+
| `shouldStopPropagation` | `boolean \| undefined` | no | Stops event propagation on click. |
|
|
2718
|
+
| `size` | `number \| undefined` | no | The size of the icon. |
|
|
2719
|
+
| `tabIndex` | `number \| undefined` | no | Optional tab index for the icon. |
|
|
2352
2720
|
|
|
2353
2721
|
### Types
|
|
2354
2722
|
|
|
@@ -2358,10 +2726,12 @@ No additional exported types documented.
|
|
|
2358
2726
|
|
|
2359
2727
|
- Import `Icon` directly from `@chayns-components/core` instead of internal source paths.
|
|
2360
2728
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
2729
|
+
- Pay special attention to required props: `icons`.
|
|
2361
2730
|
|
|
2362
2731
|
### Anti Patterns
|
|
2363
2732
|
|
|
2364
2733
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2734
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2365
2735
|
## Input
|
|
2366
2736
|
|
|
2367
2737
|
`Input` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -2419,11 +2789,41 @@ import { Input } from '@chayns-components/core';
|
|
|
2419
2789
|
|
|
2420
2790
|
### Props
|
|
2421
2791
|
|
|
2422
|
-
|
|
2792
|
+
| name | type | required | description |
|
|
2793
|
+
| --- | --- | --- | --- |
|
|
2794
|
+
| `autoComplete` | `AutoComplete` | no | Defines the auto Complete of the input |
|
|
2795
|
+
| `color` | `Color \| undefined` | no | Colors for different parts of the input. You can set the color of the placeholder and the border color. |
|
|
2796
|
+
| `disabledHint` | `string \| undefined` | no | If set and the input is disabled, the input will display a tooltip with this message. |
|
|
2797
|
+
| `id` | `string \| undefined` | no | The id of the input |
|
|
2798
|
+
| `inputMode` | `InputMode` | no | Defines the input mode of the input |
|
|
2799
|
+
| `isDisabled` | `boolean \| undefined` | no | Disables the input so that it cannot be changed anymore |
|
|
2800
|
+
| `isInvalid` | `boolean \| undefined` | no | If true, the input field is marked as invalid |
|
|
2801
|
+
| `leftElement` | `ReactNode` | no | An element to be displayed on the left side of the input field |
|
|
2802
|
+
| `onBlur` | `FocusEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when the input field loses focus |
|
|
2803
|
+
| `onChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when the text of the input changes |
|
|
2804
|
+
| `onFocus` | `FocusEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when the input field is focused |
|
|
2805
|
+
| `onKeyDown` | `KeyboardEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when a letter is pressed |
|
|
2806
|
+
| `onPaste` | `((event: ClipboardEvent<HTMLInputElement>) => void) \| undefined` | no | Function that is executed when content is pasted into the input field |
|
|
2807
|
+
| `placeholder` | `ReactNode` | no | Placeholder for the input field |
|
|
2808
|
+
| `rightElement` | `ReactElement<any, string \| JSXElementConstructor<any>> \| undefined` | no | An element that should be displayed on the right side of the Input. |
|
|
2809
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
2810
|
+
| `shouldPreventPlaceholderAnimation` | `boolean \| undefined` | no | Whether the placeholder animation should be prevented. |
|
|
2811
|
+
| `shouldRemainPlaceholder` | `boolean \| undefined` | no | Whether the placeholder should remain at its position if a value is typed. |
|
|
2812
|
+
| `shouldShowCenteredContent` | `boolean \| undefined` | no | Whether the content should be displayed centered inside the input. |
|
|
2813
|
+
| `shouldShowClearIcon` | `boolean \| undefined` | no | If true, a clear icon is displayed at the end of the input field |
|
|
2814
|
+
| `shouldShowOnlyBottomBorder` | `boolean \| undefined` | no | Whether only the bottom border should be displayed |
|
|
2815
|
+
| `shouldShowTransparentBackground` | `boolean \| undefined` | no | Whether the background should be transparent. |
|
|
2816
|
+
| `shouldUseAutoFocus` | `boolean \| undefined` | no | If true, the input field is focused when the component is mounted |
|
|
2817
|
+
| `size` | `InputSize \| undefined` | no | The size of the input field |
|
|
2818
|
+
| `type` | `HTMLInputTypeAttribute \| undefined` | no | Input type set for an input element (e.g. 'text', 'number' or 'password') |
|
|
2819
|
+
| `value` | `string \| undefined` | no | Value if the input field should be controlled |
|
|
2423
2820
|
|
|
2424
2821
|
### Types
|
|
2425
2822
|
|
|
2426
|
-
|
|
2823
|
+
- `InputSize` -> `enum InputSize {
|
|
2824
|
+
Small = 'small',
|
|
2825
|
+
Medium = 'medium',
|
|
2826
|
+
}`
|
|
2427
2827
|
|
|
2428
2828
|
### Usage Notes
|
|
2429
2829
|
|
|
@@ -2433,6 +2833,7 @@ No additional exported types documented.
|
|
|
2433
2833
|
### Anti Patterns
|
|
2434
2834
|
|
|
2435
2835
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
2836
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
2436
2837
|
## List
|
|
2437
2838
|
|
|
2438
2839
|
`List` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3153,7 +3554,11 @@ import { List, ListItem } from '@chayns-components/core';
|
|
|
3153
3554
|
|
|
3154
3555
|
### Props
|
|
3155
3556
|
|
|
3156
|
-
|
|
3557
|
+
| name | type | required | description |
|
|
3558
|
+
| --- | --- | --- | --- |
|
|
3559
|
+
| `children` | `ReactNode` | yes | The items of the list |
|
|
3560
|
+
| `isWrapped` | `boolean \| undefined` | no | This value must be set for nested AccordionGroup components. This adjusts the style of<br />the head and the padding of the content accordions. |
|
|
3561
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting and arrow-key navigation within the list. |
|
|
3157
3562
|
|
|
3158
3563
|
### Types
|
|
3159
3564
|
|
|
@@ -3163,10 +3568,12 @@ No additional exported types documented.
|
|
|
3163
3568
|
|
|
3164
3569
|
- Import `List` directly from `@chayns-components/core` instead of internal source paths.
|
|
3165
3570
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
3571
|
+
- Pay special attention to required props: `children`.
|
|
3166
3572
|
|
|
3167
3573
|
### Anti Patterns
|
|
3168
3574
|
|
|
3169
3575
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
3576
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3170
3577
|
## Masonry
|
|
3171
3578
|
|
|
3172
3579
|
`Masonry` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3358,20 +3765,40 @@ import { MentionFinder } from '@chayns-components/core';
|
|
|
3358
3765
|
|
|
3359
3766
|
### Props
|
|
3360
3767
|
|
|
3361
|
-
|
|
3768
|
+
| name | type | required | description |
|
|
3769
|
+
| --- | --- | --- | --- |
|
|
3770
|
+
| `dragCloseThresholdInPx` | `number \| undefined` | no | Threshold in pixels to drag to close the popup |
|
|
3771
|
+
| `enableDragHandle` | `boolean \| undefined` | no | Enables the optional drag handle inside the popup |
|
|
3772
|
+
| `inputValue` | `string` | yes | The text from the input field |
|
|
3773
|
+
| `members` | `MentionMember[]` | yes | Members that can be selected |
|
|
3774
|
+
| `onSelect` | `({ fullMatch, member }: { fullMatch: string; member: MentionMember; }) => void` | yes | Function to be executed when a member is selected |
|
|
3775
|
+
| `overlayContainerSelector` | `string \| undefined` | no | Selector for the container to render the overlay into (defaults to closest dialog, thread, page provider or tapp) |
|
|
3776
|
+
| `popupAlignment` | `MentionFinderPopupAlignment` | yes | Alignment of the popup |
|
|
3362
3777
|
|
|
3363
3778
|
### Types
|
|
3364
3779
|
|
|
3365
|
-
|
|
3780
|
+
- `MentionFinderPopupAlignment` -> `enum MentionFinderPopupAlignment {
|
|
3781
|
+
Top,
|
|
3782
|
+
Bottom,
|
|
3783
|
+
}`
|
|
3784
|
+
- `MentionMember` -> `type MentionMember = {
|
|
3785
|
+
id: string;
|
|
3786
|
+
info?: string;
|
|
3787
|
+
imageUrl: string;
|
|
3788
|
+
name: string;
|
|
3789
|
+
shouldShowRoundImage?: boolean;
|
|
3790
|
+
};`
|
|
3366
3791
|
|
|
3367
3792
|
### Usage Notes
|
|
3368
3793
|
|
|
3369
3794
|
- Import `MentionFinder` directly from `@chayns-components/core` instead of internal source paths.
|
|
3370
3795
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
3796
|
+
- Pay special attention to required props: `inputValue`, `members`, `onSelect`, `popupAlignment`.
|
|
3371
3797
|
|
|
3372
3798
|
### Anti Patterns
|
|
3373
3799
|
|
|
3374
3800
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
3801
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3375
3802
|
## MultiActionButton
|
|
3376
3803
|
|
|
3377
3804
|
`MultiActionButton` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3700,20 +4127,90 @@ import { MultiActionButton } from '@chayns-components/core';
|
|
|
3700
4127
|
|
|
3701
4128
|
### Props
|
|
3702
4129
|
|
|
3703
|
-
|
|
4130
|
+
| name | type | required | description |
|
|
4131
|
+
| --- | --- | --- | --- |
|
|
4132
|
+
| `backgroundColor` | `string \| undefined` | no | Optional background color for both actions. |
|
|
4133
|
+
| `className` | `string \| undefined` | no | Additional class name for the wrapper element. |
|
|
4134
|
+
| `extendedTimeoutMs` | `number \| undefined` | no | Timeout in ms before the secondary action collapses after a click. |
|
|
4135
|
+
| `gapColor` | `string \| undefined` | no | Optional color for the 1px separator line between actions. |
|
|
4136
|
+
| `height` | `number \| undefined` | no | Height of the button. |
|
|
4137
|
+
| `isCollapsed` | `boolean \| undefined` | no | Whether the button is collapsed to a single icon. |
|
|
4138
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the whole control is disabled. |
|
|
4139
|
+
| `primaryAction` | `MultiActionButtonAction` | yes | Primary action configuration. |
|
|
4140
|
+
| `secondaryAction` | `MultiActionButtonAction \| undefined` | no | Secondary action configuration. |
|
|
4141
|
+
| `secondaryContextMenu` | `MultiActionButtonSecondaryContextMenu \| undefined` | no | Context menu rendered as the secondary action. |
|
|
4142
|
+
| `shouldAutoCollapse` | `boolean \| undefined` | no | Whether the button should collapse automatically based on the available width. |
|
|
4143
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for interactive action buttons. |
|
|
4144
|
+
| `shouldUseFullWidth` | `boolean \| undefined` | no | Whether the button should take the full width of its parent. |
|
|
4145
|
+
| `width` | `number \| MotionValue<number> \| undefined` | no | Optional width override for the whole button. |
|
|
3704
4146
|
|
|
3705
4147
|
### Types
|
|
3706
4148
|
|
|
3707
|
-
|
|
4149
|
+
- `MultiActionButtonAction` -> `type MultiActionButtonAction = {
|
|
4150
|
+
/**
|
|
4151
|
+
* Optional background color for this action.
|
|
4152
|
+
* @description Overrides the component-level background color for this specific action.
|
|
4153
|
+
* If omitted, `MultiActionButton.backgroundColor` is used as fallback.
|
|
4154
|
+
* @optional
|
|
4155
|
+
*/
|
|
4156
|
+
backgroundColor?: string;
|
|
4157
|
+
/**
|
|
4158
|
+
* Optional color for the icon and label.
|
|
4159
|
+
* @description Overrides the default text/icon color. If omitted, the current theme text color is used.
|
|
4160
|
+
* @optional
|
|
4161
|
+
*/
|
|
4162
|
+
color?: string;
|
|
4163
|
+
/**
|
|
4164
|
+
* The icon for the action.
|
|
4165
|
+
* @description Can be a FontAwesome class string (e.g., 'fa fa-microphone') or a custom React element.
|
|
4166
|
+
* The icon is always rendered inside a fixed-size slot to keep alignment stable.
|
|
4167
|
+
*/
|
|
4168
|
+
icon: string | ReactElement;
|
|
4169
|
+
/**
|
|
4170
|
+
* Whether the action is disabled.
|
|
4171
|
+
* @description Disabled actions do not respond to hover or click and are visually dimmed.
|
|
4172
|
+
* @optional
|
|
4173
|
+
*/
|
|
4174
|
+
isDisabled?: boolean;
|
|
4175
|
+
/**
|
|
4176
|
+
* Optional reason shown in a tooltip when the action is disabled.
|
|
4177
|
+
* @description Use this to explain why the action is currently unavailable.
|
|
4178
|
+
* @optional
|
|
4179
|
+
*/
|
|
4180
|
+
disabledReason?: string;
|
|
4181
|
+
/**
|
|
4182
|
+
* The optional label for the action.
|
|
4183
|
+
* @description The label is shown next to the icon and will be truncated with ellipsis when
|
|
4184
|
+
* there is not enough horizontal space.
|
|
4185
|
+
* @optional
|
|
4186
|
+
*/
|
|
4187
|
+
label: ReactNode;
|
|
4188
|
+
/**
|
|
4189
|
+
* Click handler for the action.
|
|
4190
|
+
* @description Receives a payload that includes the action type, extension state, and device info.
|
|
4191
|
+
* This allows external logic to decide whether the click should trigger an action immediately.
|
|
4192
|
+
* @optional
|
|
4193
|
+
*/
|
|
4194
|
+
onClick?: (info: MultiActionButtonActionEvent) => void;
|
|
4195
|
+
/**
|
|
4196
|
+
* Status effect configuration for the action.
|
|
4197
|
+
* @description Controls optional visual emphasis like pulsing, without changing layout or sizing.
|
|
4198
|
+
* @optional
|
|
4199
|
+
*/
|
|
4200
|
+
status?: MultiActionButtonActionStatus;
|
|
4201
|
+
};`
|
|
4202
|
+
- `MultiActionButtonSecondaryContextMenu` -> `type MultiActionButtonSecondaryContextMenu = ContextMenuItem[];`
|
|
3708
4203
|
|
|
3709
4204
|
### Usage Notes
|
|
3710
4205
|
|
|
3711
4206
|
- Import `MultiActionButton` directly from `@chayns-components/core` instead of internal source paths.
|
|
3712
4207
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4208
|
+
- Pay special attention to required props: `primaryAction`.
|
|
3713
4209
|
|
|
3714
4210
|
### Anti Patterns
|
|
3715
4211
|
|
|
3716
4212
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4213
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3717
4214
|
## NumberInput
|
|
3718
4215
|
|
|
3719
4216
|
`NumberInput` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3734,7 +4231,22 @@ import { NumberInput } from '@chayns-components/core';
|
|
|
3734
4231
|
|
|
3735
4232
|
### Props
|
|
3736
4233
|
|
|
3737
|
-
|
|
4234
|
+
| name | type | required | description |
|
|
4235
|
+
| --- | --- | --- | --- |
|
|
4236
|
+
| `isDecimalInput` | `boolean \| undefined` | no | Applies rules for decimal input.<br />Enables the user to input one zero as number before the comma |
|
|
4237
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the input is disabled |
|
|
4238
|
+
| `isInvalid` | `boolean \| undefined` | no | Whether the value is invalid. |
|
|
4239
|
+
| `isMoneyInput` | `boolean \| undefined` | no | Applies rules for money input.<br />Rules: only two decimal places, one zero before the comma |
|
|
4240
|
+
| `isTimeInput` | `boolean \| undefined` | no | Whether the value should be formatted as a time. |
|
|
4241
|
+
| `maxNumber` | `number \| undefined` | no | Limits the number to this value |
|
|
4242
|
+
| `minNumber` | `number \| undefined` | no | Limits the number to this value |
|
|
4243
|
+
| `onBlur` | `((newNumber: string \| number \| null, isInvalid: boolean) => void) \| undefined` | no | Callback function that is called when the input gets out of focus |
|
|
4244
|
+
| `onChange` | `((newValue: string) => void) \| undefined` | no | Callback function that is called when the input changes<br />It will pass the text from the input |
|
|
4245
|
+
| `placeholder` | `string \| undefined` | no | Placeholder for the input field |
|
|
4246
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4247
|
+
| `shouldShowOnlyBottomBorder` | `boolean \| undefined` | no | Whether only the bottom border should be displayed |
|
|
4248
|
+
| `shouldTriggerChangeOnFormat` | `boolean \| undefined` | no | Whether the onChange function should be triggert when the value is formatted on the focus or blur |
|
|
4249
|
+
| `value` | `string \| undefined` | no | The value, that should be displayed in the input, when it is in focus.<br />You can also pass a stringified number as default value.<br />NOTE: If you pass a stringified number, it will be formatted to the selected format |
|
|
3738
4250
|
|
|
3739
4251
|
### Types
|
|
3740
4252
|
|
|
@@ -3748,6 +4260,7 @@ No additional exported types documented.
|
|
|
3748
4260
|
### Anti Patterns
|
|
3749
4261
|
|
|
3750
4262
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4263
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3751
4264
|
## Popup
|
|
3752
4265
|
|
|
3753
4266
|
`Popup` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3816,20 +4329,44 @@ import { Popup } from '@chayns-components/core';
|
|
|
3816
4329
|
|
|
3817
4330
|
### Props
|
|
3818
4331
|
|
|
3819
|
-
|
|
4332
|
+
| name | type | required | description |
|
|
4333
|
+
| --- | --- | --- | --- |
|
|
4334
|
+
| `alignment` | `PopupAlignment \| undefined` | no | The preferred alignment of the popup relative to its trigger element. |
|
|
4335
|
+
| `children` | `ReactNode` | no | The trigger element that the popup is attached to. |
|
|
4336
|
+
| `container` | `Element \| undefined` | no | The DOM element that should receive the popup portal. |
|
|
4337
|
+
| `content` | `ReactNode` | yes | The content rendered inside the popup. |
|
|
4338
|
+
| `isOpen` | `boolean \| undefined` | no | Fully controls whether the popup is visible. |
|
|
4339
|
+
| `onHide` | `VoidFunction \| undefined` | no | Callback that is called after the popup becomes hidden. |
|
|
4340
|
+
| `onShow` | `VoidFunction \| undefined` | no | Callback that is called after the popup becomes visible. |
|
|
4341
|
+
| `shouldBeOpen` | `boolean \| undefined` | no | Requests that the popup should be opened from outside. |
|
|
4342
|
+
| `shouldHideOnChildrenLeave` | `boolean \| undefined` | no | Hides the popup when the pointer leaves the trigger element. |
|
|
4343
|
+
| `shouldScrollWithContent` | `boolean \| undefined` | no | Keeps the popup aligned within the scrolling content container. |
|
|
4344
|
+
| `shouldShowOnHover` | `boolean \| undefined` | no | Opens the popup when the trigger element is hovered instead of clicked. |
|
|
4345
|
+
| `shouldUseChildrenWidth` | `boolean \| undefined` | no | Uses the trigger element width as the popup width reference. |
|
|
4346
|
+
| `shouldUseFullWidth` | `boolean \| undefined` | no | Stretches the trigger element to the full available width. |
|
|
4347
|
+
| `yOffset` | `number \| undefined` | no | Vertical offset between the trigger element and the popup. |
|
|
3820
4348
|
|
|
3821
4349
|
### Types
|
|
3822
4350
|
|
|
3823
|
-
|
|
4351
|
+
- `PopupAlignment` -> `enum PopupAlignment {
|
|
4352
|
+
TopLeft,
|
|
4353
|
+
TopCenter,
|
|
4354
|
+
TopRight,
|
|
4355
|
+
BottomLeft,
|
|
4356
|
+
BottomCenter,
|
|
4357
|
+
BottomRight,
|
|
4358
|
+
}`
|
|
3824
4359
|
|
|
3825
4360
|
### Usage Notes
|
|
3826
4361
|
|
|
3827
4362
|
- Import `Popup` directly from `@chayns-components/core` instead of internal source paths.
|
|
3828
4363
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4364
|
+
- Pay special attention to required props: `content`.
|
|
3829
4365
|
|
|
3830
4366
|
### Anti Patterns
|
|
3831
4367
|
|
|
3832
4368
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4369
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3833
4370
|
## ProgressBar
|
|
3834
4371
|
|
|
3835
4372
|
`ProgressBar` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3893,7 +4430,17 @@ import { ProgressBar } from '@chayns-components/core';
|
|
|
3893
4430
|
|
|
3894
4431
|
### Props
|
|
3895
4432
|
|
|
3896
|
-
|
|
4433
|
+
| name | type | required | description |
|
|
4434
|
+
| --- | --- | --- | --- |
|
|
4435
|
+
| `colors` | `Colors \| undefined` | no | The colors of the ProgressBar. |
|
|
4436
|
+
| `height` | `number \| undefined` | no | The height of the progress bar in pixels. If not provided, it will be 10px if shouldShowLabelInline is false and 20px if shouldShowLabelInline is true. |
|
|
4437
|
+
| `label` | `string \| undefined` | no | The label that should be displayed under the progressbar. |
|
|
4438
|
+
| `percentage` | `0 \| 2 \| 1 \| 4 \| 56 \| 38 \| 20 \| 3 \| 10 \| 6 \| 5 \| 7 \| 8 \| 9 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 21 \| 22 \| 23 \| 24 \| 25 \| 26 \| 27 \| 28 \| 29 \| 30 \| 31 \| 32 \| 33 \| 34 \| 35 \| 36 \| 37 \| 39 \| 40 \| 41 \| 42 \| 43 \| 44 \| 45 \| 46 \| 47 \| 48 \| 49 \| 50 \| 51 \| 52 \| 53 \| 54 \| 55 \| 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 \| undefined` | no | The percentage of the progress. Number between 0 and 100. |
|
|
4439
|
+
| `shouldHideProgress` | `boolean \| undefined` | no | Whether the progress should be hide and just display the label. |
|
|
4440
|
+
| `shouldShowLabelInline` | `boolean \| undefined` | no | Whether the label should be displayed inside the ProgressBar. |
|
|
4441
|
+
| `showShine` | `boolean \| undefined` | no | Whether a shine animation should be shown on the progress bar. The amount of shine is based on the percentage value. |
|
|
4442
|
+
| `steps` | `(0 \| 2 \| 1 \| 4 \| 56 \| 38 \| 20 \| 3 \| 10 \| 6 \| 5 \| 7 \| 8 \| 9 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 21 \| 22 \| 23 \| 24 \| 25 \| 26 \| 27 \| 28 \| 29 \| 30 \| 31 \| 32 \| 33 \| 34 \| 35 \| 36 \| 37 \| 39 \| 40 \| 41 \| 42 \| 43 \| 44 \| 45 \| 46 \| 47 \| 48 \| 49 \| 50 \| 51 \| 52 \| 53 \| 54 \| 55 \| 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)[] \| undefined` | no | Visual marked steps. |
|
|
4443
|
+
| `thumbLabel` | `ReactNode` | no | The label that should be displayed on the thumb of the progress bar. |
|
|
3897
4444
|
|
|
3898
4445
|
### Types
|
|
3899
4446
|
|
|
@@ -3907,6 +4454,7 @@ No additional exported types documented.
|
|
|
3907
4454
|
### Anti Patterns
|
|
3908
4455
|
|
|
3909
4456
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4457
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3910
4458
|
## RadioButton
|
|
3911
4459
|
|
|
3912
4460
|
`RadioButton` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -3976,7 +4524,16 @@ import { RadioButton } from '@chayns-components/core';
|
|
|
3976
4524
|
|
|
3977
4525
|
### Props
|
|
3978
4526
|
|
|
3979
|
-
|
|
4527
|
+
| name | type | required | description |
|
|
4528
|
+
| --- | --- | --- | --- |
|
|
4529
|
+
| `children` | `ReactNode` | no | The children that should be displayed after the RadioButton is checked. |
|
|
4530
|
+
| `id` | `string \| number` | yes | The id of the radio button. |
|
|
4531
|
+
| `isDisabled` | `boolean \| undefined` | no | whether the RadioButton should be shown. |
|
|
4532
|
+
| `label` | `ReactNode` | no | The label that should be displayed next to the radio button. |
|
|
4533
|
+
| `rightElement` | `ReactNode` | no | An element that should be displayed on the right side of the label. |
|
|
4534
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4535
|
+
| `shouldShowCentered` | `boolean \| undefined` | no | Whether the RadioButton should be displayed centered to the label or at the top |
|
|
4536
|
+
| `shouldShowRightElementOnlyOnChecked` | `boolean \| undefined` | no | Whether the rightElement should only be displayed when the RadioButton is checked |
|
|
3980
4537
|
|
|
3981
4538
|
### Types
|
|
3982
4539
|
|
|
@@ -3986,10 +4543,12 @@ No additional exported types documented.
|
|
|
3986
4543
|
|
|
3987
4544
|
- Import `RadioButton` directly from `@chayns-components/core` instead of internal source paths.
|
|
3988
4545
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4546
|
+
- Pay special attention to required props: `id`.
|
|
3989
4547
|
|
|
3990
4548
|
### Anti Patterns
|
|
3991
4549
|
|
|
3992
4550
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4551
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
3993
4552
|
## ScrollView
|
|
3994
4553
|
|
|
3995
4554
|
`ScrollView` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4010,7 +4569,15 @@ import { ScrollView } from '@chayns-components/core';
|
|
|
4010
4569
|
|
|
4011
4570
|
### Props
|
|
4012
4571
|
|
|
4013
|
-
|
|
4572
|
+
| name | type | required | description |
|
|
4573
|
+
| --- | --- | --- | --- |
|
|
4574
|
+
| `children` | `ReactNode` | yes | The elements that should be shown inside the scrollview |
|
|
4575
|
+
| `height` | `Height<string \| number> \| undefined` | no | The height of the scroll view. |
|
|
4576
|
+
| `maxHeight` | `Height<string \| number> \| null \| undefined` | no | The maximum height of the scroll view. |
|
|
4577
|
+
| `maxWidth` | `Width<string \| number> \| undefined` | no | The maximum width of the scroll view. |
|
|
4578
|
+
| `overflowX` | `"scroll" \| "auto" \| undefined` | no | The overflow-x style of the scroll view. |
|
|
4579
|
+
| `overflowY` | `"scroll" \| "auto" \| undefined` | no | The overflow-y style of the scroll view. |
|
|
4580
|
+
| `width` | `Width<string \| number> \| undefined` | no | The width of the scroll view. |
|
|
4014
4581
|
|
|
4015
4582
|
### Types
|
|
4016
4583
|
|
|
@@ -4020,10 +4587,12 @@ No additional exported types documented.
|
|
|
4020
4587
|
|
|
4021
4588
|
- Import `ScrollView` directly from `@chayns-components/core` instead of internal source paths.
|
|
4022
4589
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4590
|
+
- Pay special attention to required props: `children`.
|
|
4023
4591
|
|
|
4024
4592
|
### Anti Patterns
|
|
4025
4593
|
|
|
4026
4594
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4595
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4027
4596
|
## SearchBox
|
|
4028
4597
|
|
|
4029
4598
|
`SearchBox` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4148,20 +4717,58 @@ import { SearchBox } from '@chayns-components/core';
|
|
|
4148
4717
|
|
|
4149
4718
|
### Props
|
|
4150
4719
|
|
|
4151
|
-
|
|
4720
|
+
| name | type | required | description |
|
|
4721
|
+
| --- | --- | --- | --- |
|
|
4722
|
+
| `container` | `Element \| undefined` | no | The element where the content of the `ComboBox` should be rendered via React Portal. |
|
|
4723
|
+
| `customFilter` | `((item: ISearchBoxItem) => boolean) \| undefined` | no | An optional callback function to filter the elements to be displayed |
|
|
4724
|
+
| `dropdownDirection` | `DropdownDirection \| undefined` | no | The direction in which the dropdown should be displayed. By default, it is displayed below the input. |
|
|
4725
|
+
| `hintText` | `string \| undefined` | no | A text that should be displayed if no results are found. |
|
|
4726
|
+
| `inputProps` | `InputProps \| undefined` | no | Props that are passed to the underlying Input component. |
|
|
4727
|
+
| `isInvalid` | `boolean \| undefined` | no | If true, the input field is marked as invalid |
|
|
4728
|
+
| `leftIcons` | `string[] \| undefined` | no | An optional icon that is displayed inside the left side of the input. |
|
|
4729
|
+
| `lists` | `ISearchBoxItems[]` | yes | List of groups with items that can be searched. It is possible to give only one list; if multiple lists are provided, the 'group name' parameter becomes mandatory. |
|
|
4730
|
+
| `maxHeight` | `number \| undefined` | no | The maximum height of the dropdown body in pixels. |
|
|
4731
|
+
| `onBlur` | `FocusEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed when the input lost focus. |
|
|
4732
|
+
| `onChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed when the input is changed. |
|
|
4733
|
+
| `onKeyDown` | `KeyboardEventHandler<HTMLInputElement> \| undefined` | no | Function that is executed when a letter is pressed |
|
|
4734
|
+
| `onSelect` | `((item: ISearchBoxItem) => void) \| undefined` | no | Function to be executed when an item is selected. |
|
|
4735
|
+
| `placeholder` | `string \| undefined` | no | The placeholder that should be displayed. |
|
|
4736
|
+
| `presetValue` | `string \| undefined` | no | Set an input for the search box - it is not an item of a list, just a string. |
|
|
4737
|
+
| `selectedId` | `string \| undefined` | no | Control the selected item. If you use this prop, make sure to update it when the user selects an item. |
|
|
4738
|
+
| `shouldAddInputToList` | `boolean` | yes | If true, the value in the Input is displayed in the list. |
|
|
4739
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4740
|
+
| `shouldHideFilterButtons` | `boolean \| undefined` | no | If true, the filter buttons are hidden. |
|
|
4741
|
+
| `shouldKeepSelectedItemPosition` | `boolean \| undefined` | no | If true, the selected item keeps its original position in the dropdown list. |
|
|
4742
|
+
| `shouldShowContentOnEmptyInput` | `boolean \| undefined` | no | Whether the full list of items should be displayed if the input is empty. |
|
|
4743
|
+
| `shouldShowRoundImage` | `boolean \| undefined` | no | If true, the images of the items are displayed in a round shape. |
|
|
4744
|
+
| `shouldShowSmallItems` | `boolean \| undefined` | no | If true, the dropdown items are displayed more compactly. |
|
|
4745
|
+
| `shouldShowToggleIcon` | `boolean \| undefined` | no | Whether the icon to open and close the list should be displayed. |
|
|
4746
|
+
| `shouldUseCustomFilterOnly` | `boolean \| undefined` | no | If true, the custom filter replaces the built-in text search instead of narrowing its results. |
|
|
4747
|
+
| `tagInputSettings` | `TagInputSettings \| undefined` | no | Settings for the TagInput. |
|
|
4152
4748
|
|
|
4153
4749
|
### Types
|
|
4154
4750
|
|
|
4155
|
-
|
|
4751
|
+
- `DropdownDirection` -> `enum DropdownDirection {
|
|
4752
|
+
BOTTOM,
|
|
4753
|
+
TOP,
|
|
4754
|
+
BOTTOM_LEFT,
|
|
4755
|
+
BOTTOM_RIGHT,
|
|
4756
|
+
TOP_LEFT,
|
|
4757
|
+
TOP_RIGHT,
|
|
4758
|
+
LEFT,
|
|
4759
|
+
RIGHT,
|
|
4760
|
+
}`
|
|
4156
4761
|
|
|
4157
4762
|
### Usage Notes
|
|
4158
4763
|
|
|
4159
4764
|
- Import `SearchBox` directly from `@chayns-components/core` instead of internal source paths.
|
|
4160
4765
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4766
|
+
- Pay special attention to required props: `lists`, `shouldAddInputToList`.
|
|
4161
4767
|
|
|
4162
4768
|
### Anti Patterns
|
|
4163
4769
|
|
|
4164
4770
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4771
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4165
4772
|
## SearchInput
|
|
4166
4773
|
|
|
4167
4774
|
`SearchInput` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4184,20 +4791,37 @@ import { SearchInput } from '@chayns-components/core';
|
|
|
4184
4791
|
|
|
4185
4792
|
### Props
|
|
4186
4793
|
|
|
4187
|
-
|
|
4794
|
+
| name | type | required | description |
|
|
4795
|
+
| --- | --- | --- | --- |
|
|
4796
|
+
| `iconColor` | `Color \| undefined` | no | Color of the icon |
|
|
4797
|
+
| `isActive` | `boolean \| undefined` | no | Force the active state of the input and override the internal state |
|
|
4798
|
+
| `onActiveChange` | `((isActive: boolean) => void) \| undefined` | no | Function that is executed when the active state of the input changes |
|
|
4799
|
+
| `onChange` | `ChangeEventHandler<HTMLInputElement>` | yes | Function that is executed when the text of the input changes |
|
|
4800
|
+
| `onKeyDown` | `((event: KeyboardEvent<HTMLInputElement>) => void) \| undefined` | no | Function that is executed when a key is pressed |
|
|
4801
|
+
| `placeholder` | `string \| undefined` | no | Placeholder for the input field |
|
|
4802
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4803
|
+
| `shouldUseAbsolutePositioning` | `boolean \| undefined` | no | Whether the SearchInput should be positioned absolute. |
|
|
4804
|
+
| `size` | `InputSize \| undefined` | no | The size of the input field |
|
|
4805
|
+
| `value` | `string \| undefined` | no | Value if the input field should be controlled |
|
|
4806
|
+
| `width` | `number \| undefined` | no | The width of the parent. |
|
|
4188
4807
|
|
|
4189
4808
|
### Types
|
|
4190
4809
|
|
|
4191
|
-
|
|
4810
|
+
- `InputSize` -> `enum InputSize {
|
|
4811
|
+
Small = 'small',
|
|
4812
|
+
Medium = 'medium',
|
|
4813
|
+
}`
|
|
4192
4814
|
|
|
4193
4815
|
### Usage Notes
|
|
4194
4816
|
|
|
4195
4817
|
- Import `SearchInput` directly from `@chayns-components/core` instead of internal source paths.
|
|
4196
4818
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4819
|
+
- Pay special attention to required props: `onChange`.
|
|
4197
4820
|
|
|
4198
4821
|
### Anti Patterns
|
|
4199
4822
|
|
|
4200
4823
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4824
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4201
4825
|
## SelectButton
|
|
4202
4826
|
|
|
4203
4827
|
`SelectButton` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4226,20 +4850,39 @@ import { SelectButton } from '@chayns-components/core';
|
|
|
4226
4850
|
|
|
4227
4851
|
### Props
|
|
4228
4852
|
|
|
4229
|
-
|
|
4853
|
+
| name | type | required | description |
|
|
4854
|
+
| --- | --- | --- | --- |
|
|
4855
|
+
| `additionalText` | `string \| undefined` | no | Text used when there are more selected items than maxDisplayedItems. '##count##' will be displayed with the additional count. |
|
|
4856
|
+
| `buttonText` | `string` | yes | The text that should be displayed inside the button. |
|
|
4857
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the button should be disabled. |
|
|
4858
|
+
| `list` | `SelectButtonItem[]` | yes | A list of item that could be selected. |
|
|
4859
|
+
| `maxDisplayedItems` | `number \| undefined` | no | The maximum number of items displayed in the button text. |
|
|
4860
|
+
| `onSelect` | `((ids: (string \| number)[]) => void) \| undefined` | no | Function to be executed after an item is selected. |
|
|
4861
|
+
| `selectAllText` | `string \| undefined` | no | If a string is given and `shouldAllowMultiSelect` is true, the dialog displays a checkbox to select all items at once. |
|
|
4862
|
+
| `selectedItemIds` | `(string \| number)[] \| undefined` | no | The id of an item that should be preselected. |
|
|
4863
|
+
| `shouldAllowMultiSelect` | `boolean \| undefined` | no | Whether more than one item should be selectable. |
|
|
4864
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4865
|
+
| `shouldShowButtonTextWithSelection` | `boolean \| undefined` | no | Whether the button text should be displayed also if items are selected. |
|
|
4866
|
+
| `shouldShowSearch` | `boolean \| undefined` | no | Whether the search should be displayed inside the dialog. |
|
|
4867
|
+
| `title` | `string \| undefined` | no | The title of the dialog. |
|
|
4230
4868
|
|
|
4231
4869
|
### Types
|
|
4232
4870
|
|
|
4233
|
-
|
|
4871
|
+
- `SelectButtonItem` -> `interface SelectButtonItem {
|
|
4872
|
+
text: string;
|
|
4873
|
+
id: number | string;
|
|
4874
|
+
}`
|
|
4234
4875
|
|
|
4235
4876
|
### Usage Notes
|
|
4236
4877
|
|
|
4237
4878
|
- Import `SelectButton` directly from `@chayns-components/core` instead of internal source paths.
|
|
4238
4879
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4880
|
+
- Pay special attention to required props: `buttonText`, `list`.
|
|
4239
4881
|
|
|
4240
4882
|
### Anti Patterns
|
|
4241
4883
|
|
|
4242
4884
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4885
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4243
4886
|
## SetupWizard
|
|
4244
4887
|
|
|
4245
4888
|
`SetupWizard` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4266,7 +4909,11 @@ import { SetupWizard } from '@chayns-components/core';
|
|
|
4266
4909
|
|
|
4267
4910
|
### Props
|
|
4268
4911
|
|
|
4269
|
-
|
|
4912
|
+
| name | type | required | description |
|
|
4913
|
+
| --- | --- | --- | --- |
|
|
4914
|
+
| `children` | `ReactElement<SetupWizardItemProps, string \| JSXElementConstructor<any>> \| ReactElement<SetupWizardItemProps, string \| JSXElementConstructor<any>>[]` | yes | The steps of the setup. Use the SetupWizardItem component. |
|
|
4915
|
+
| `isWrapped` | `boolean \| undefined` | no | This value must be set if the SetupWizard is inside an Accordion. |
|
|
4916
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for setup wizard items. |
|
|
4270
4917
|
|
|
4271
4918
|
### Types
|
|
4272
4919
|
|
|
@@ -4276,10 +4923,12 @@ No additional exported types documented.
|
|
|
4276
4923
|
|
|
4277
4924
|
- Import `SetupWizard` directly from `@chayns-components/core` instead of internal source paths.
|
|
4278
4925
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4926
|
+
- Pay special attention to required props: `children`.
|
|
4279
4927
|
|
|
4280
4928
|
### Anti Patterns
|
|
4281
4929
|
|
|
4282
4930
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4931
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4283
4932
|
## SetupWizardItem
|
|
4284
4933
|
|
|
4285
4934
|
`SetupWizardItem` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4319,7 +4968,12 @@ import { Input, RadioButton, RadioButtonGroup, SetupWizardItem } from '@chayns-c
|
|
|
4319
4968
|
|
|
4320
4969
|
### Props
|
|
4321
4970
|
|
|
4322
|
-
|
|
4971
|
+
| name | type | required | description |
|
|
4972
|
+
| --- | --- | --- | --- |
|
|
4973
|
+
| `children` | `ReactNode` | yes | The content that should be displayed inside the item. |
|
|
4974
|
+
| `id` | `number` | yes | The id of the item. |
|
|
4975
|
+
| `step` | `number` | yes | The step of the item. |
|
|
4976
|
+
| `title` | `string` | yes | The title of the item. |
|
|
4323
4977
|
|
|
4324
4978
|
### Types
|
|
4325
4979
|
|
|
@@ -4329,10 +4983,12 @@ No additional exported types documented.
|
|
|
4329
4983
|
|
|
4330
4984
|
- Import `SetupWizardItem` directly from `@chayns-components/core` instead of internal source paths.
|
|
4331
4985
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
4986
|
+
- Pay special attention to required props: `children`, `id`, `step`, `title`.
|
|
4332
4987
|
|
|
4333
4988
|
### Anti Patterns
|
|
4334
4989
|
|
|
4335
4990
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
4991
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4336
4992
|
## SharingBar
|
|
4337
4993
|
|
|
4338
4994
|
`SharingBar` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4357,20 +5013,35 @@ import { SharingBar } from '@chayns-components/core';
|
|
|
4357
5013
|
|
|
4358
5014
|
### Props
|
|
4359
5015
|
|
|
4360
|
-
|
|
5016
|
+
| name | type | required | description |
|
|
5017
|
+
| --- | --- | --- | --- |
|
|
5018
|
+
| `container` | `Element \| undefined` | no | The element where the content of the `SharingBar` should be rendered via React Portal. |
|
|
5019
|
+
| `label` | `string` | yes | The label that should be displayed. |
|
|
5020
|
+
| `link` | `string` | yes | The link that should be shared. |
|
|
5021
|
+
| `popupAlignment` | `ContextMenuAlignment` | yes | The alignment of the sharing options. |
|
|
5022
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting and keyboard interaction. |
|
|
4361
5023
|
|
|
4362
5024
|
### Types
|
|
4363
5025
|
|
|
4364
|
-
|
|
5026
|
+
- `ContextMenuAlignment` -> `enum ContextMenuAlignment {
|
|
5027
|
+
TopLeft,
|
|
5028
|
+
BottomLeft,
|
|
5029
|
+
TopRight,
|
|
5030
|
+
BottomRight,
|
|
5031
|
+
TopCenter,
|
|
5032
|
+
BottomCenter,
|
|
5033
|
+
}`
|
|
4365
5034
|
|
|
4366
5035
|
### Usage Notes
|
|
4367
5036
|
|
|
4368
5037
|
- Import `SharingBar` directly from `@chayns-components/core` instead of internal source paths.
|
|
4369
5038
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
5039
|
+
- Pay special attention to required props: `label`, `link`, `popupAlignment`.
|
|
4370
5040
|
|
|
4371
5041
|
### Anti Patterns
|
|
4372
5042
|
|
|
4373
5043
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5044
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4374
5045
|
## SharingButton
|
|
4375
5046
|
|
|
4376
5047
|
`SharingButton` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4441,20 +5112,36 @@ import { SharingButton } from '@chayns-components/core';
|
|
|
4441
5112
|
|
|
4442
5113
|
### Props
|
|
4443
5114
|
|
|
4444
|
-
|
|
5115
|
+
| name | type | required | description |
|
|
5116
|
+
| --- | --- | --- | --- |
|
|
5117
|
+
| `alignment` | `ContextMenuAlignment \| undefined` | no | Context menu alignment |
|
|
5118
|
+
| `children` | `ReactNode` | no | No description available. |
|
|
5119
|
+
| `container` | `Element \| undefined` | no | Container element |
|
|
5120
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the button is disabled and cannot be clicked anymore. |
|
|
5121
|
+
| `link` | `string` | yes | The link that should be shared. |
|
|
5122
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4445
5123
|
|
|
4446
5124
|
### Types
|
|
4447
5125
|
|
|
4448
|
-
|
|
5126
|
+
- `ContextMenuAlignment` -> `enum ContextMenuAlignment {
|
|
5127
|
+
TopLeft,
|
|
5128
|
+
BottomLeft,
|
|
5129
|
+
TopRight,
|
|
5130
|
+
BottomRight,
|
|
5131
|
+
TopCenter,
|
|
5132
|
+
BottomCenter,
|
|
5133
|
+
}`
|
|
4449
5134
|
|
|
4450
5135
|
### Usage Notes
|
|
4451
5136
|
|
|
4452
5137
|
- Import `SharingButton` directly from `@chayns-components/core` instead of internal source paths.
|
|
4453
5138
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
5139
|
+
- Pay special attention to required props: `link`.
|
|
4454
5140
|
|
|
4455
5141
|
### Anti Patterns
|
|
4456
5142
|
|
|
4457
5143
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5144
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4458
5145
|
## Signature
|
|
4459
5146
|
|
|
4460
5147
|
`Signature` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4477,7 +5164,15 @@ import { Signature } from '@chayns-components/core';
|
|
|
4477
5164
|
|
|
4478
5165
|
### Props
|
|
4479
5166
|
|
|
4480
|
-
|
|
5167
|
+
| name | type | required | description |
|
|
5168
|
+
| --- | --- | --- | --- |
|
|
5169
|
+
| `buttonText` | `string` | yes | The text that should be displayed inside the button. |
|
|
5170
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the button is disabled. |
|
|
5171
|
+
| `onEdit` | `((signatureUrl: string) => void) \| undefined` | no | Function to be executed when the signature is edited. |
|
|
5172
|
+
| `onRemove` | `(() => void) \| undefined` | no | Function to be executed when the user deletes the signature. |
|
|
5173
|
+
| `onSubscribe` | `((signatureUrl: string) => void) \| undefined` | no | Function to be executed when the user subscribes. |
|
|
5174
|
+
| `onUnsubscribe` | `(() => void) \| undefined` | no | Function to be executed when the user unsubscribes. |
|
|
5175
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting for interactive controls. |
|
|
4481
5176
|
|
|
4482
5177
|
### Types
|
|
4483
5178
|
|
|
@@ -4487,10 +5182,12 @@ No additional exported types documented.
|
|
|
4487
5182
|
|
|
4488
5183
|
- Import `Signature` directly from `@chayns-components/core` instead of internal source paths.
|
|
4489
5184
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
5185
|
+
- Pay special attention to required props: `buttonText`.
|
|
4490
5186
|
|
|
4491
5187
|
### Anti Patterns
|
|
4492
5188
|
|
|
4493
5189
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5190
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4494
5191
|
## Skeleton
|
|
4495
5192
|
|
|
4496
5193
|
`Skeleton` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4677,7 +5374,22 @@ import { Slider } from '@chayns-components/core';
|
|
|
4677
5374
|
|
|
4678
5375
|
### Props
|
|
4679
5376
|
|
|
4680
|
-
|
|
5377
|
+
| name | type | required | description |
|
|
5378
|
+
| --- | --- | --- | --- |
|
|
5379
|
+
| `interval` | `SliderInterval \| undefined` | no | The current interval of the slider. |
|
|
5380
|
+
| `isDisabled` | `boolean \| undefined` | no | Disables the slider, preventing user interaction. |
|
|
5381
|
+
| `maxEnabledValue` | `number \| undefined` | no | The maximum enabled value of the slider. |
|
|
5382
|
+
| `maxValue` | `number` | yes | The maximum value of the slider. |
|
|
5383
|
+
| `minEnabledValue` | `number \| undefined` | no | The minimum enabled value of the slider. |
|
|
5384
|
+
| `minValue` | `number` | yes | The minimum value of the slider. |
|
|
5385
|
+
| `onChange` | `((value?: number \| undefined, interval?: SliderInterval \| undefined) => void) \| undefined` | no | Callback function that is called when the slider value changes. |
|
|
5386
|
+
| `onSelect` | `((value?: number \| undefined, interval?: SliderInterval \| undefined) => void) \| undefined` | no | Callback function that is called when the slider selection is finalized. |
|
|
5387
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
5388
|
+
| `shouldHighlightSteps` | `boolean \| undefined` | no | Indicates whether the slider should highlight steps. |
|
|
5389
|
+
| `shouldShowThumbLabel` | `boolean \| undefined` | no | Indicates whether the slider should show a label on the thumb. |
|
|
5390
|
+
| `step` | `number \| undefined` | no | The step size for the slider. |
|
|
5391
|
+
| `thumbLabelFormatter` | `((value: number, isMeasuring?: boolean \| undefined) => string) \| undefined` | no | A function to format the thumb label. |
|
|
5392
|
+
| `value` | `number \| undefined` | no | The current value of the slider. |
|
|
4681
5393
|
|
|
4682
5394
|
### Types
|
|
4683
5395
|
|
|
@@ -4687,10 +5399,12 @@ No additional exported types documented.
|
|
|
4687
5399
|
|
|
4688
5400
|
- Import `Slider` directly from `@chayns-components/core` instead of internal source paths.
|
|
4689
5401
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
5402
|
+
- Pay special attention to required props: `maxValue`, `minValue`.
|
|
4690
5403
|
|
|
4691
5404
|
### Anti Patterns
|
|
4692
5405
|
|
|
4693
5406
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5407
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4694
5408
|
## SliderButton
|
|
4695
5409
|
|
|
4696
5410
|
`SliderButton` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4749,20 +5463,33 @@ import { SliderButton } from '@chayns-components/core';
|
|
|
4749
5463
|
|
|
4750
5464
|
### Props
|
|
4751
5465
|
|
|
4752
|
-
|
|
5466
|
+
| name | type | required | description |
|
|
5467
|
+
| --- | --- | --- | --- |
|
|
5468
|
+
| `isDisabled` | `boolean \| undefined` | no | Whether the button is disabled and cannot be clicked anymore. |
|
|
5469
|
+
| `isRounded` | `boolean \| undefined` | no | No description available. |
|
|
5470
|
+
| `isSecondary` | `boolean \| undefined` | no | Displays the button in the secondary style. |
|
|
5471
|
+
| `items` | `SliderButtonItem[]` | yes | The items that should be displayed in the slider button. |
|
|
5472
|
+
| `onChange` | `((id: string) => void) \| undefined` | no | Function to be executed when a button is selected. The id of the selected button is passed as an argument. |
|
|
5473
|
+
| `selectedButtonId` | `string \| undefined` | no | The id of the button that should be selected. |
|
|
5474
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
4753
5475
|
|
|
4754
5476
|
### Types
|
|
4755
5477
|
|
|
4756
|
-
|
|
5478
|
+
- `SliderButtonItem` -> `interface SliderButtonItem {
|
|
5479
|
+
id: string;
|
|
5480
|
+
text: string;
|
|
5481
|
+
}`
|
|
4757
5482
|
|
|
4758
5483
|
### Usage Notes
|
|
4759
5484
|
|
|
4760
5485
|
- Import `SliderButton` directly from `@chayns-components/core` instead of internal source paths.
|
|
4761
5486
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
5487
|
+
- Pay special attention to required props: `items`.
|
|
4762
5488
|
|
|
4763
5489
|
### Anti Patterns
|
|
4764
5490
|
|
|
4765
5491
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5492
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4766
5493
|
## SmallWaitCursor
|
|
4767
5494
|
|
|
4768
5495
|
`SmallWaitCursor` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4786,11 +5513,21 @@ import { SmallWaitCursor } from '@chayns-components/core';
|
|
|
4786
5513
|
|
|
4787
5514
|
### Props
|
|
4788
5515
|
|
|
4789
|
-
|
|
5516
|
+
| name | type | required | description |
|
|
5517
|
+
| --- | --- | --- | --- |
|
|
5518
|
+
| `color` | `string \| undefined` | no | No description available. |
|
|
5519
|
+
| `shouldHideBackground` | `boolean \| undefined` | no | No description available. |
|
|
5520
|
+
| `shouldHideWaitCursor` | `boolean \| undefined` | no | No description available. |
|
|
5521
|
+
| `size` | `number \| undefined` | no | No description available. |
|
|
5522
|
+
| `speed` | `SmallWaitCursorSpeed \| undefined` | no | No description available. |
|
|
4790
5523
|
|
|
4791
5524
|
### Types
|
|
4792
5525
|
|
|
4793
|
-
|
|
5526
|
+
- `SmallWaitCursorSpeed` -> `enum SmallWaitCursorSpeed {
|
|
5527
|
+
Slow = 1.5,
|
|
5528
|
+
Medium = 1,
|
|
5529
|
+
Fast = 0.5,
|
|
5530
|
+
}`
|
|
4794
5531
|
|
|
4795
5532
|
### Usage Notes
|
|
4796
5533
|
|
|
@@ -4800,6 +5537,7 @@ No additional exported types documented.
|
|
|
4800
5537
|
### Anti Patterns
|
|
4801
5538
|
|
|
4802
5539
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5540
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4803
5541
|
## TagInput
|
|
4804
5542
|
|
|
4805
5543
|
`TagInput` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4849,11 +5587,32 @@ import { TagInput } from '@chayns-components/core';
|
|
|
4849
5587
|
|
|
4850
5588
|
### Props
|
|
4851
5589
|
|
|
4852
|
-
|
|
5590
|
+
| name | type | required | description |
|
|
5591
|
+
| --- | --- | --- | --- |
|
|
5592
|
+
| `leftElement` | `ReactNode` | no | An element that should be displayed on the left side of the input. |
|
|
5593
|
+
| `onAdd` | `((tag: Tag) => boolean \| void \| Promise<boolean>) \| undefined` | no | Function to be executed when a tag is added. |
|
|
5594
|
+
| `onBlur` | `FocusEventHandler \| undefined` | no | Function to be executed when the input is blurred. |
|
|
5595
|
+
| `onChange` | `ChangeEventHandler<HTMLInputElement> \| undefined` | no | Function to be executed when the value of the input is changed. |
|
|
5596
|
+
| `onFocus` | `FocusEventHandler \| undefined` | no | Function to be executed when the input is focused. |
|
|
5597
|
+
| `onRemove` | `((id: string) => void) \| undefined` | no | Function to be executed when a tag is removed. |
|
|
5598
|
+
| `placeholder` | `string \| undefined` | no | The placeholder that should be displayed. |
|
|
5599
|
+
| `shouldAllowMultiple` | `boolean \| undefined` | no | Whether multiple tags should be allowed. |
|
|
5600
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
5601
|
+
| `shouldPreventEnter` | `boolean \| undefined` | no | Whether the enter key should be prevented. |
|
|
5602
|
+
| `size` | `InputSize \| undefined` | no | The size of the input field. |
|
|
5603
|
+
| `tags` | `Tag[] \| undefined` | no | The tags that should be displayed. |
|
|
4853
5604
|
|
|
4854
5605
|
### Types
|
|
4855
5606
|
|
|
4856
|
-
|
|
5607
|
+
- `InputSize` -> `enum InputSize {
|
|
5608
|
+
Small = 'small',
|
|
5609
|
+
Medium = 'medium',
|
|
5610
|
+
}`
|
|
5611
|
+
- `Tag` -> `interface Tag {
|
|
5612
|
+
id: string;
|
|
5613
|
+
text: string;
|
|
5614
|
+
rightElement?: ReactNode;
|
|
5615
|
+
}`
|
|
4857
5616
|
|
|
4858
5617
|
### Usage Notes
|
|
4859
5618
|
|
|
@@ -4863,6 +5622,7 @@ No additional exported types documented.
|
|
|
4863
5622
|
### Anti Patterns
|
|
4864
5623
|
|
|
4865
5624
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5625
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4866
5626
|
## TextArea
|
|
4867
5627
|
|
|
4868
5628
|
`TextArea` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -4931,7 +5691,21 @@ import { TextArea } from '@chayns-components/core';
|
|
|
4931
5691
|
|
|
4932
5692
|
### Props
|
|
4933
5693
|
|
|
4934
|
-
|
|
5694
|
+
| name | type | required | description |
|
|
5695
|
+
| --- | --- | --- | --- |
|
|
5696
|
+
| `colors` | `TextAreaColors \| undefined` | no | Provide custom colors to the TextArea Component |
|
|
5697
|
+
| `isDisabled` | `boolean \| undefined` | no | Disables the text area so that it cannot be changed. |
|
|
5698
|
+
| `isInvalid` | `boolean \| undefined` | no | If true, the text area is marked as invalid |
|
|
5699
|
+
| `maxHeight` | `MaxHeight<string \| number> \| undefined` | no | The maximum height of the text area. |
|
|
5700
|
+
| `minHeight` | `MinHeight<string \| number> \| undefined` | no | The minimum height of the text area. |
|
|
5701
|
+
| `onBlur` | `FocusEventHandler<HTMLTextAreaElement> \| undefined` | no | Function that is executed when the text area loses focus. |
|
|
5702
|
+
| `onChange` | `ChangeEventHandler<HTMLTextAreaElement> \| undefined` | no | Function that is executed when the text of the text area changes. |
|
|
5703
|
+
| `onFocus` | `FocusEventHandler<HTMLTextAreaElement> \| undefined` | no | Function that is executed when the input field is focused |
|
|
5704
|
+
| `onKeyDown` | `KeyboardEventHandler<HTMLTextAreaElement> \| undefined` | no | Function that is executed when a letter is pressed |
|
|
5705
|
+
| `placeholder` | `string \| ReactElement<any, string \| JSXElementConstructor<any>> \| undefined` | no | Placeholder for the text area field. |
|
|
5706
|
+
| `rightElement` | `ReactElement<any, string \| JSXElementConstructor<any>> \| undefined` | no | An element that should be displayed on the right side of the Input. |
|
|
5707
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
5708
|
+
| `value` | `string \| undefined` | no | Value if the text area should be controlled. |
|
|
4935
5709
|
|
|
4936
5710
|
### Types
|
|
4937
5711
|
|
|
@@ -4945,6 +5719,7 @@ No additional exported types documented.
|
|
|
4945
5719
|
### Anti Patterns
|
|
4946
5720
|
|
|
4947
5721
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5722
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
4948
5723
|
## Tooltip
|
|
4949
5724
|
|
|
4950
5725
|
`Tooltip` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -5010,20 +5785,41 @@ import { Tooltip } from '@chayns-components/core';
|
|
|
5010
5785
|
|
|
5011
5786
|
### Props
|
|
5012
5787
|
|
|
5013
|
-
|
|
5788
|
+
| name | type | required | description |
|
|
5789
|
+
| --- | --- | --- | --- |
|
|
5790
|
+
| `alignment` | `PopupAlignment \| undefined` | no | The alignment of the tooltip. By default, the tooltip will calculate the best alignment. |
|
|
5791
|
+
| `children` | `ReactNode` | yes | The elements that the tooltip should surround. |
|
|
5792
|
+
| `container` | `Element \| undefined` | no | The element where the content of the `Tooltip` should be rendered via React Portal. |
|
|
5793
|
+
| `isDisabled` | `boolean \| undefined` | no | whether the tooltip should be shown. |
|
|
5794
|
+
| `item` | `ReactNode \| ITooltipItem` | yes | The content that should be displayed. |
|
|
5795
|
+
| `itemWidth` | `Width<string \| number> \| undefined` | no | The width of an item. |
|
|
5796
|
+
| `maxItemWidth` | `number \| undefined` | no | The max width of the Tooltip. |
|
|
5797
|
+
| `shouldHideOnChildrenLeave` | `boolean \| undefined` | no | Whether the tooltip should be hidden after the children is not hovered. |
|
|
5798
|
+
| `shouldUseChildrenWidth` | `boolean \| undefined` | no | Whether the width of the children should be used. |
|
|
5799
|
+
| `shouldUseFullWidth` | `boolean \| undefined` | no | Whether the tooltip children should use the full width. |
|
|
5800
|
+
| `yOffset` | `number \| undefined` | no | The Y offset of the tooltip to the children. |
|
|
5014
5801
|
|
|
5015
5802
|
### Types
|
|
5016
5803
|
|
|
5017
|
-
|
|
5804
|
+
- `PopupAlignment` -> `enum PopupAlignment {
|
|
5805
|
+
TopLeft,
|
|
5806
|
+
TopCenter,
|
|
5807
|
+
TopRight,
|
|
5808
|
+
BottomLeft,
|
|
5809
|
+
BottomCenter,
|
|
5810
|
+
BottomRight,
|
|
5811
|
+
}`
|
|
5018
5812
|
|
|
5019
5813
|
### Usage Notes
|
|
5020
5814
|
|
|
5021
5815
|
- Import `Tooltip` directly from `@chayns-components/core` instead of internal source paths.
|
|
5022
5816
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
5817
|
+
- Pay special attention to required props: `children`, `item`.
|
|
5023
5818
|
|
|
5024
5819
|
### Anti Patterns
|
|
5025
5820
|
|
|
5026
5821
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
5822
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
5027
5823
|
## Truncation
|
|
5028
5824
|
|
|
5029
5825
|
`Truncation` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|
|
@@ -5221,20 +6017,35 @@ import { Button, Truncation } from '@chayns-components/core';
|
|
|
5221
6017
|
|
|
5222
6018
|
### Props
|
|
5223
6019
|
|
|
5224
|
-
|
|
6020
|
+
| name | type | required | description |
|
|
6021
|
+
| --- | --- | --- | --- |
|
|
6022
|
+
| `children` | `ReactElement<any, string \| JSXElementConstructor<any>>` | yes | The elements that should be expanding or collapsing. |
|
|
6023
|
+
| `clampPosition` | `ClampPosition \| undefined` | no | The position of the clamp. |
|
|
6024
|
+
| `collapsedHeight` | `number \| undefined` | no | The height of the children element in its collapsed state. |
|
|
6025
|
+
| `isOpen` | `boolean \| undefined` | no | If set to true, the content is exposed. |
|
|
6026
|
+
| `lessLabel` | `string \| undefined` | no | A text that should be displayed if the content is expanded. |
|
|
6027
|
+
| `moreLabel` | `string \| undefined` | no | A text that should be displayed if the content is collapsed. |
|
|
6028
|
+
| `onChange` | `((event: MouseEvent<HTMLAnchorElement, MouseEvent>, isOpen: boolean) => void) \| undefined` | no | Function to be executed when the component is expanding or collapsing. |
|
|
6029
|
+
| `shouldEnableKeyboardHighlighting` | `boolean \| undefined` | no | Enables keyboard-only focus highlighting. |
|
|
5225
6030
|
|
|
5226
6031
|
### Types
|
|
5227
6032
|
|
|
5228
|
-
|
|
6033
|
+
- `ClampPosition` -> `enum ClampPosition {
|
|
6034
|
+
Right,
|
|
6035
|
+
Middle,
|
|
6036
|
+
Left,
|
|
6037
|
+
}`
|
|
5229
6038
|
|
|
5230
6039
|
### Usage Notes
|
|
5231
6040
|
|
|
5232
6041
|
- Import `Truncation` directly from `@chayns-components/core` instead of internal source paths.
|
|
5233
6042
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
6043
|
+
- Pay special attention to required props: `children`.
|
|
5234
6044
|
|
|
5235
6045
|
### Anti Patterns
|
|
5236
6046
|
|
|
5237
6047
|
- Avoid imports from internal paths such as `@chayns-components/core/src/...`; always use the public package export.
|
|
6048
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
|
5238
6049
|
## VerificationBadge
|
|
5239
6050
|
|
|
5240
6051
|
`VerificationBadge` is exported by `@chayns-components/core` and should be imported from the public package entry point.
|