@cwellt_software/cwellt-reactjs-lib 1.5.4 → 1.6.0

package/dist/index.d.ts

@@ -77,28 +77,28 @@ declare function CwLabel(props: CwLabelProps): React$1.JSX.Element;
 type ChipColorScheme = 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'neutral' | 'custom';
 type ChipVariant = 'soft' | 'solid' | 'outline' | 'ghost';
 interface CwChipProps {
-    /*** Text content of the chip **/
+    /**Text content of the chip */
     label?: string;
-    /*** Predefined color of the chip **/
+    /**Predefined color of the chip */
     color?: ChipColorScheme;
     /**
      * Predefined color scheme of the chip
      * @deprecated Use `color` instead. Still honoured, but `color` wins when both are passed.
      */
     colorScheme?: ChipColorScheme;
-    /*** Custom color (only used when the color is 'custom') **/
+    /**Custom color (only used when the color is 'custom') */
     customColor?: string;
-    /*** Visual variant of the chip **/
+    /**Visual variant of the chip */
     variant?: ChipVariant;
-    /*** Additional CSS class name **/
+    /**Additional CSS class name */
     className?: string;
-    /*** Whether to show a close icon **/
+    /**Whether to show a close icon */
     closable?: boolean;
-    /*** Handler for close icon click, required if closable is true **/
+    /**Handler for close icon click, required if closable is true */
     onClose?: () => void;
-    /*** Optional icon **/
+    /**Optional icon */
     icon?: string;
-    /*** Additional inline styles **/
+    /**Additional inline styles */
     style?: React__default.CSSProperties;
 }
 /**
@@ -482,6 +482,10 @@ interface CwGenericTooltipProps {
  *
  * @see CwTooltipNew
  */
+/**
+ * Portal-per-instance tooltip.
+ * @deprecated Use {@link CwTooltipNew}: same API, one shared portal for every tooltip on the page.
+ */
 declare const CwGenericTooltip: FC<CwGenericTooltipProps>;
 
 interface CwTooltipProps {
@@ -568,6 +572,11 @@ interface ConfirmationPopupProps {
     placement?: 'top' | 'right' | 'bottom' | 'left';
     children: ReactNode;
 }
+/**
+ * Small anchored confirmation for a destructive action.
+ *
+ * Preferably avoid using it, it needs a refactor.
+ */
 declare function CwConfirmationPopup(props: ConfirmationPopupProps): React__default.JSX.Element;
 
 interface CwReportModalFunctionalProps {
@@ -619,7 +628,8 @@ interface CwModalHoverProps extends Omit<HTMLProps<HTMLDialogElement>, "classNam
     hovereable: JSX.Element;
 }
 /**
- * A modal that appears when an element is hovered
+ * A modal that appears when an element is hovered.
+ * Preferably avoid using it, it needs a refactor.
  * @param children Contents of the modal
  * @param hovereable Element to hover to display the modal
  * @param onFirstOpened Function to run only once when the modal opens for the first time
@@ -654,7 +664,7 @@ interface CwDialogProps extends HTMLProps<PropsWithChildren<HTMLDialogElement>>
     onClose?: () => void;
     /** If true, the footer will not be displayed */
     hideFooter?: boolean;
-    /*** Reposition the dialog when content size changes after opening. For modals with slow loading content. Default: false **/
+    /** Reposition the dialog when content size changes after opening. For modals with slow loading content. Default: false */
     autoReposition?: boolean;
     /** If true, the save button will be disabled */
     disableSave?: boolean;
@@ -715,17 +725,17 @@ declare function CwAlign(props: CwAlignProps): React$1.JSX.Element;
 
 type CardChip = Omit<CwChipProps, 'closable' | 'onClose' | 'className' | 'style'>;
 interface CwCardProps {
-    /*** Unique identifier for the card **/
+    /** Unique identifier for the card */
     id?: string;
-    /*** Card title content **/
+    /** Card title content */
     title?: ReactNode;
-    /*** Card subtitle content **/
+    /** Card subtitle content */
     subtitle?: ReactNode;
-    /** @deprecated Use layout.align instead ("left" → "start", "center" → "center") **/
+    /** @deprecated Use layout.align instead ("left" → "start", "center" → "center") */
     alignment?: "center" | "left";
-    /*** Main content of the card **/
+    /** Main content of the card */
     children: ReactNode;
-    /*** Footer content of the card **/
+    /** Footer content of the card */
     footer?: ReactNode;
     /** Optional callback for edit action - displays edit button when provided */
     onEdit?: () => void;
@@ -733,27 +743,27 @@ interface CwCardProps {
     onDelete?: () => void;
     /** Additional actions beyond edit/delete (for edge cases) */
     extraActions?: ReactNode;
-    /*** Additional CSS class name to apply **/
+    /** Additional CSS class name to apply */
     className?: string;
-    /*** Whether the card is clickable **/
+    /** Whether the card is clickable */
     clickable?: boolean;
-    /*** Click handler when clickable is true **/
+    /** Click handler when clickable is true */
     onClick?: () => void;
-    /*** Whether the card is in a loading state - the content zone renders skeleton lines instead of children **/
+    /** Whether the card is in a loading state - the content zone renders skeleton lines instead of children */
     isLoading?: boolean;
-    /*** Number of skeleton text lines shown in the content while isLoading. Default 3 **/
+    /** Number of skeleton text lines shown in the content while isLoading. Default 3 */
     skeletonLines?: number;
-    /*** Whether the card is disabled **/
+    /** Whether the card is disabled */
     disabled?: boolean;
-    /*** Custom style object for additional inline styles **/
+    /** Custom style object for additional inline styles */
     style?: React__default.CSSProperties;
-    /*** Tags or chips to be displayed in the card **/
+    /** Tags or chips to be displayed in the card */
     chips?: CardChip[];
-    /*** Variant design **/
+    /** Variant design */
     variant?: "border" | "shadow";
-    /** @deprecated Use layout.direction instead **/
+    /** @deprecated Use layout.direction instead */
     direction?: "column" | "row";
-    /** Card layout: direction controls card flex direction; align controls header content alignment **/
+    /** Card layout: direction controls card flex direction; align controls header content alignment */
     layout?: CwLayoutProps;
 }
 /**
@@ -815,10 +825,8 @@ interface CwAccordionContainerProps {
     style?: React$1.CSSProperties;
 }
 /**
- *
- * @param CwelltAccordionContainerProps
- * @remarks Previously CwAccordionContainer
- * @returns
+ * Legacy collapsible section with its own header markup.
+ * @deprecated Use {@link CwExpandable} instead.
  */
 declare function CwAccordionContainer(CwelltAccordionContainerProps: React$1.PropsWithChildren<CwAccordionContainerProps>): React$1.JSX.Element;
 
@@ -1224,7 +1232,8 @@ interface CwExpandableProps extends Omit<HTMLProps<PropsWithChildren<HTMLDetails
     onClose?: (ev: MouseEvent) => void;
 }
 /**
- * An expandable element with briefing and children displayed when clicked
+ * An expandable element with briefing and children displayed when clicked.
+ * Preferably avoid using it, it needs a refactor.
  * @param briefing Title of the expandable
  * @param onToggle Function to run when expandable is toggled open/closed
  * @param onClose Function to run when expandable is closed
@@ -1456,6 +1465,7 @@ interface CwTableGroupedProps {
 }
 /**
  * A table with expandable row groups.
+ * Preferably avoid using it, it needs a refactor.
  * @param props The data to display
  * @example
  * const sampleTableData: CwTableGroupedData = {
@@ -1563,6 +1573,10 @@ interface CwInputProps {
     required?: boolean;
     error?: boolean;
 }
+/**
+ * Legacy text input with its own label markup, predating the design system.
+ * @deprecated Use {@link CwInputText} instead.
+ */
 declare function CwInput(CwInputProps: React__default.PropsWithChildren<CwInputProps>): React__default.JSX.Element;
 
 interface CwInputFeedback {
@@ -1659,7 +1673,7 @@ interface CwDigitProps extends Omit<HTMLProps<HTMLInputElement>, "className" | "
  */
 declare function CwDigit(props: CwDigitProps): React$1.JSX.Element;
 
-interface ColorPickerProps {
+interface CwColorPickerProps {
     initialColor: string;
     onChange: (color: string, rgb?: {
         r: number;
@@ -1672,7 +1686,7 @@ interface ColorPickerProps {
     }) => void;
     previewText?: string;
 }
-declare const CwColorPicker: React__default.FC<ColorPickerProps>;
+declare const CwColorPicker: React__default.FC<CwColorPickerProps>;
 
 interface CwInputLayoutProps {
     direction?: "row" | "column";
@@ -1716,8 +1730,8 @@ interface CwInputColorProps {
 declare const CwInputColor: React__default.FC<CwInputColorProps>;
 
 interface CwInputTextProps extends Omit<HTMLProps<HTMLInputElement>, never> {
-    /** Props to define alignment and size; undefined == column
-     * @example alignProps={{direction:"row"}} */
+    /** Props to define alignment and size; undefined == row
+     * @example alignProps={{flexDirection:"column"}} */
     alignProps?: CwAlignProps;
     /** Props of the button; undefined == no button
      * @example buttonProps={{children:"Ok"}} */
@@ -1726,7 +1740,7 @@ interface CwInputTextProps extends Omit<HTMLProps<HTMLInputElement>, never> {
      * @example labelProps={{children:"Your name please:"}} */
     labelProps?: CwLabelProps;
     /** Props of the icon; undefined == no icon
-     * @example iconProps={{iconId:"phone"}} */
+     * @deprecated The leading icon is being retired from the text input; do not use in new code. */
     iconProps?: CwIconProps;
     /** Feedback messages shown below the input; accepts a single message or an array for multiple
      * @example feedback={{ type: "danger", message: "This field is required" }}
@@ -1747,7 +1761,6 @@ interface CwInputTextProps extends Omit<HTMLProps<HTMLInputElement>, never> {
  * @example
  * ```tsx
  * <CwInputText
- *   iconProps={{ id: "home" }}
  *   labelProps={{ children: "Name", width: "100px" }}
  *   buttonProps={{ children: "Ok", onclick:()=>{alert("hi")} }}
  *   feedback={{ type: "danger", message: "This field is required" }}
@@ -1806,7 +1819,7 @@ interface CwInputNumberProps {
 }
 declare function CwInputNumber(CwInputNumberProps: React__default.PropsWithChildren<CwInputNumberProps>): React__default.JSX.Element;
 
-interface CwTextAreaProps extends Omit<DetailedHTMLProps<TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement>, "className"> {
+interface CwTextAreaProps extends DetailedHTMLProps<TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement> {
     /** Can it be resized? */
     resize?: CSS.Property.Resize;
     /** Props to define alignment and size; undefined == column
@@ -1930,6 +1943,10 @@ interface CwInputDateTextProps extends Omit<React__default.HTMLProps<HTMLInputEl
  * />
  * ```
  */
+/**
+ * Text date input with a native picker fallback, predating the calendar pickers.
+ * @deprecated Use {@link CwDatePickerTemporal} (or {@link CwDatePicker} at a JS Date boundary) instead.
+ */
 declare function CwInputDateText(props: CwInputDateTextProps): React__default.JSX.Element;
 
 interface CwInputImageLabels {
@@ -2385,6 +2402,10 @@ interface CwDropdownFilterProps {
     isNested?: boolean;
     IdContent?: string;
 }
+/**
+ * Legacy action menu with a fixed item shape and caller-owned open state.
+ * @deprecated Use {@link CwPopoverButton} with your own content instead.
+ */
 declare function CwDropdownFilter(props: React$1.PropsWithChildren<CwDropdownFilterProps>): React$1.JSX.Element;
 
 interface CwPopoverButtonProps extends Omit<CwButtonProps, "onClick" | "children"> {
@@ -3019,7 +3040,7 @@ interface CwAnchoredMenuProps extends React__default.PropsWithChildren {
 }
 declare const CwAnchoredMenu: React__default.FC<CwAnchoredMenuProps>;
 
-interface ContextMenuProps extends React__default.PropsWithChildren {
+interface CwContextMenuProps extends React__default.PropsWithChildren {
     options: string[];
     offset?: {
         x: number;
@@ -3027,7 +3048,7 @@ interface ContextMenuProps extends React__default.PropsWithChildren {
     };
     onSelect: (option: string) => void;
 }
-declare const CwContextMenu: React__default.FC<ContextMenuProps>;
+declare const CwContextMenu: React__default.FC<CwContextMenuProps>;
 
 interface CwButtonSplitAction {
     key: string;