@cwellt_software/cwellt-reactjs-lib 1.5.2 → 1.5.4

package/dist/index.d.ts

@@ -74,14 +74,19 @@ interface CwLabelProps extends Omit<HTMLProps<PropsWithChildren<HTMLLabelElement
  */
 declare function CwLabel(props: CwLabelProps): React$1.JSX.Element;
 
-type ChipColorScheme = 'danger' | 'warning' | 'success' | 'info' | 'neutral' | 'custom';
-type ChipVariant = 'soft' | 'solid' | 'outline';
+type ChipColorScheme = 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'neutral' | 'custom';
+type ChipVariant = 'soft' | 'solid' | 'outline' | 'ghost';
 interface CwChipProps {
     /*** Text content of the chip **/
     label?: string;
-    /*** Predefined color scheme 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 colorScheme is 'custom') **/
+    /*** Custom color (only used when the color is 'custom') **/
     customColor?: string;
     /*** Visual variant of the chip **/
     variant?: ChipVariant;
@@ -99,15 +104,65 @@ interface CwChipProps {
 /**
 * CwChip - A simple chip/tag component for displaying labels or categories
 *
+* The colour comes from `color`; the older `colorScheme` spelling is deprecated but still
+* honoured, and `color` wins when both are passed.
+*
 * @example
-* <CwChip label="Active" colorScheme="success" />
-* <CwChip label="High Priority" colorScheme="danger" variant="solid" />
-* <CwChip label="Custom" colorScheme="custom" customColor="#8a2be2" />
-* <CwChip label="Outlined" colorScheme="info" variant="outline" />
+* <CwChip label="Active" color="success" />
+* <CwChip label="High Priority" color="danger" variant="solid" />
+* <CwChip label="Custom" color="custom" customColor="#8a2be2" />
+* <CwChip label="Outlined" color="info" variant="outline" />
 * <CwChip label="Removable" closable onClose={() => console.log('closed')} />
 **/
 declare const CwChip: React__default.FC<CwChipProps>;
 
+type BadgeColorScheme = 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'neutral';
+type BadgeVariant = 'soft' | 'solid';
+type BadgeSize = 'small' | 'medium' | 'large';
+interface CwBadgeProps {
+    /** Number shown inside the badge. Omit (with no `content`) to render a dot */
+    count?: number;
+    /** Text shown instead of a count, e.g. `"!"`. Wins over `count` */
+    content?: React__default.ReactNode;
+    /** Predefined color scheme, sharing CwChip's token pairs */
+    color?: BadgeColorScheme;
+    /** Visual variant: filled accent (`solid`) or the muted container tone (`soft`) */
+    variant?: BadgeVariant;
+    /** Circle diameter at one digit: `small` 1rem, `medium` 1.25rem, `large` 1.5rem */
+    size?: BadgeSize;
+    /** Render the badge when `count` is 0 (default true, matching today's counters) */
+    showZero?: boolean;
+    /** Replace the whole badge with a spinner; it always renders while loading */
+    loading?: boolean;
+    /** Highest value rendered as a number; anything above shows `"{max}+"` */
+    max?: number;
+    /** Accessible name. Needed for a dot or a spinner, which carry no text; without it a text-less
+     * badge is hidden from assistive technology */
+    label?: string;
+    /** Additional CSS class name */
+    className?: string;
+    /** Additional inline styles */
+    style?: React__default.CSSProperties;
+}
+/**
+ * CwBadge - the small coloured circle with a number, used for alert and notification counts.
+ *
+ * Always **in flow** (`inline-flex`); it never positions itself, so overlaying it on an icon
+ * button is the caller's job. One digit stays a circle, wider content such as `"99+"` grows into
+ * a pill. With neither `count` nor `content` it renders as a dot.
+ *
+ * Precedence: `loading` > `content` > `count` > dot. While loading the badge renders regardless
+ * of `showZero`, and the spinner replaces it - circle, background and padding come off.
+ *
+ * @example
+ * <CwBadge count={3} color="danger" />
+ * <CwBadge count={0} showZero={false} />
+ * <CwBadge count={128} max={99} color="warning" variant="soft" />
+ * <CwBadge color="warning" label="Unresolved findings" />
+ * <CwBadge count={0} loading />
+ */
+declare const CwBadge: React__default.FC<CwBadgeProps>;
+
 declare enum CwMessageType {
     ERROR = "close-circle",
     WARN = "warning",
@@ -388,6 +443,8 @@ interface CwProgressProps {
     monoValue?: boolean;
     /** Larger, bolder value label. */
     prominent?: boolean;
+    /** Extra classes on the outermost element, e.g. a layout utility like `cw-flex-grow`. */
+    className?: string;
 }
 /**
  * CwProgress - a determinate or indeterminate progress bar.
@@ -399,7 +456,7 @@ interface CwProgressProps {
  * <CwProgress value={62} label="Import" color="success" />
  * <CwProgress indeterminate label="Uploading" />
  */
-declare function CwProgress({ value, indeterminate, label, rightLabel, size, layout, color, monoValue, prominent }: CwProgressProps): React__default.JSX.Element;
+declare function CwProgress({ value, indeterminate, label, rightLabel, size, layout, color, monoValue, prominent, className }: CwProgressProps): React__default.JSX.Element;
 
 type TooltipPosition = "top" | "bottom" | "left" | "right";
 interface CwGenericTooltipProps {
@@ -1102,8 +1159,13 @@ interface Tab {
     content: React__default.ReactNode;
     icon?: React__default.ReactNode | string;
     iconClassName?: string;
+    /** Counter shown next to the title. Omit (with a `badgeColor`) for an attention dot */
     badge?: number | string;
-    badgeColor?: string;
+    /**
+     * Badge colour scheme, e.g. `"warning"`.
+     * @deprecated Passing a raw CSS colour is deprecated - use one of the scheme names instead.
+     */
+    badgeColor?: BadgeColorScheme | string;
 }
 interface CwTabsProps {
     id?: string;
@@ -1521,6 +1583,7 @@ interface CwInputFeedback {
  * @param className - Additional CSS classes
  * @param title - Built-in tooltip
  * @param tooltipPosition - Tooltip position: 'top', 'bottom' (default), 'left', 'right'
+ * @param badge - CwBadge props, overlaid on the top-right corner. Size defaults to 'small' on icon buttons, else the button's own size.
  * @param children - Custom button content (overrides text and icon rendering)
  *
  * @example
@@ -1532,6 +1595,7 @@ interface CwInputFeedback {
  * <CwButton text="Next" icon="chevron-right" iconPosition="right" />
  * <CwButton text="Export" icon="download" variant="ghost" />
  * <CwButton variant="icon" icon="pin" pressed={isPinned} onClick={togglePinned} title="Pin" />
+ * <CwButton variant="icon" icon="alert" title="Alerts" badge={{ count: 3, color: "danger" }} onClick={openAlerts} />
  * <CwButton className="custom-class">Custom content</CwButton>
  */
 
@@ -1544,6 +1608,8 @@ interface CwButtonProps extends React__default.ButtonHTMLAttributes<HTMLButtonEl
     pressed?: boolean;
     icon?: string;
     tooltipPosition?: 'top' | 'bottom' | 'left' | 'right';
+    /** Overlaid on the top-right corner. `size` defaults to 'small' on icon buttons, else the button's own `size`. */
+    badge?: CwBadgeProps;
 }
 declare const CwButton: React__default.ForwardRefExoticComponent<CwButtonProps & React__default.RefAttributes<HTMLButtonElement>>;
 
@@ -1565,6 +1631,12 @@ interface CwDigitProps extends Omit<HTMLProps<HTMLInputElement>, "className" | "
      * @example feedback={[{ type: "neutral", message: "Enter an amount" }, { type: "warning", message: "Value looks high" }]}
      */
     feedback?: CwInputFeedback | CwInputFeedback[];
+    /** Where the feedback block sits in row layout: "value" (default) lines it up under the input,
+     * "full" spans label and input from the left edge. Use "full" with a compact field
+     * (`data-size`), where the indent would strand the message far from a very short input.
+     * No effect in column layout, where both collapse to the same third line.
+     * @example feedbackPosition="full" */
+    feedbackPosition?: "value" | "full";
 }
 /**
  * Input for entering a string of number.
@@ -1937,7 +2009,22 @@ interface CwWeekdaySelectorProps {
     value?: string;
     onChange?: (value: string) => void;
     disabled?: boolean;
+    /** Props for the label; undefined == no label
+     * @example labelProps={{ text: "Operating days" }} */
+    labelProps?: CwLabelProps;
+    /** Label placement relative to the day strip: "row" (default, label beside) | "column" (label above).
+     * Honors align and gap. */
+    layout?: CwLayoutProps;
+    /** Messages shown below the day strip; accepts a single message or an array */
+    feedback?: CwInputFeedback | CwInputFeedback[];
+    /** BCP-47 tag driving the day letters and their tooltips (default "en-GB"): "es" renders
+     * LMXJVSD, "de" renders MDMDFSS. From a date-fns locale object, pass its `code`. */
+    locale?: string;
+    /** Additional CSS class name for the root element */
+    className?: string;
 }
+declare const CwWeekdaySelector: FC<CwWeekdaySelectorProps>;
+
 type Weekday = "M" | "T" | "W" | "R" | "F" | "S" | "U" | "m" | "t" | "w" | "r" | "f" | "s" | "u";
 /**
  * This class represents a week where days can be selected or unselected
@@ -1945,7 +2032,7 @@ type Weekday = "M" | "T" | "W" | "R" | "F" | "S" | "U" | "m" | "t" | "w" | "r" |
  * ```
  * Monday     = "M" | "m"
  * Tuesday    = "T" | "t"
- * Wendnesday = "W" | "w"
+ * Wednesday  = "W" | "w"
  * thuRsday   = "R" | "r"
  * Friday     = "F" | "f"
  * Saturday   = "S" | "s"
@@ -1957,11 +2044,11 @@ declare class Weekdays {
     private static readonly WEEKDAYS_STANDARD_ARRAY_EMPTY;
     private static readonly WEEKDAYS_STANDARD_STRING_FULL;
     private static readonly WEEKDAYS_STANDARD_STRING_EMPTY;
-    static readonly WEEKDAYS_TO_USA_LETTER_FORMAT: Map<string, string>;
     static readonly WEEKDAYS_TO_USA_SHORT_FORMAT: Map<string, string>;
     static readonly WEEKDAY_MAP: {
         [key: number]: Weekday;
     };
+    private static readonly DAY_NUMBER_BY_CODE;
     private days;
     constructor(days?: Weekday[] | string);
     includes(day: Weekday): boolean;
@@ -1971,7 +2058,7 @@ declare class Weekdays {
     toString(): string;
     toStringFormatted(limiters?: {
         startExistingDay: string;
-        endExsitingDay: string;
+        endExistingDay: string;
         startMissingDay: string;
         endMissingDay: string;
         separator: string;
@@ -1981,8 +2068,27 @@ declare class Weekdays {
     isFull(): boolean;
     static getFullWeek(): Weekday[];
     static getEmptyWeek(): Weekday[];
+    /** A week with nothing selected. */
+    static empty(): Weekdays;
+    /**
+     * Like {@link fromString}, but yields an empty week instead of throwing on anything invalid.
+     * For UI fed straight from a backend field that can arrive null, empty or partial.
+     */
+    static tryFromString(value: string | null | undefined): Weekdays;
+    /** Selected flags in MTWRFSU order (Monday first). */
+    toBooleans(): boolean[];
+    /** @param flags selected flags in MTWRFSU order; missing entries count as unselected */
+    static fromBooleans(flags: ReadonlyArray<boolean>): Weekdays;
+    /** 7-character mask in MTWRFSU order where "1" means selected, e.g. "1100100". */
+    toMask(): string;
+    /** @param mask 7-character mask in MTWRFSU order where "1" means selected; a shorter, empty or
+     *  missing mask counts the absent days as unselected */
+    static fromMask(mask: string | null | undefined): Weekdays;
+    /** Selected days as Date.getDay() numbers (0 = Sunday), in MTWRFSU order. */
+    toDayNumbers(): number[];
+    /** @param days Date.getDay() numbers (0 = Sunday) */
+    static fromDayNumbers(days: ReadonlyArray<number>): Weekdays;
 }
-declare const CwWeekdaySelector: FC<CwWeekdaySelectorProps>;
 
 interface CwCheckProps extends Omit<React__default.DetailedHTMLProps<React__default.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "type"> {
     /** Props for the label component */
@@ -2373,6 +2479,17 @@ interface CwMultiFilterProps {
     /** Additional CSS class for the container */
     className?: string;
     style?: React__default.CSSProperties;
+    /** `data-testid` on the root `<form>`, for e2e/Selenium anchoring. */
+    testId?: string;
+    /**
+     * Tag list shown when the panel opens.
+     * - `"all"` (default): the full list shows immediately.
+     * - `"afterCategoryOrSearch"`: the list opens empty until the user's first interaction (any
+     *   category button, ALL CATEGORIES included, or a search term), then stays visible until the
+     *   panel is closed and reopened. Category buttons stay visible throughout. Useful when one
+     *   category holds a directory large enough to overload the panel.
+     */
+    initialTagVisibility?: "all" | "afterCategoryOrSearch";
 }
 /**
  * A multiple filter selector, a MULTI-SELECT even. Allows users to select and filter items based on tags.
@@ -3880,5 +3997,5 @@ declare class OnClickContextMenu implements UiEvent {
     constructor(id: string, clickedMenu: string);
 }
 
-export { CwAccordionContainer, CwAlign, CwAnchoredMenu, CwBtnApprove, CwBtnCancel, CwBtnDelete, CwBtnEdit, CwBtnSave, CwButton, CwButtonSplit, CwButtonSwitch, CwCard, CwCardList, CwCheck, CwCheckbox, CwCheckboxGroup, CwChip, CwColorPicker, CwConfirmationPopup, CwContextMenu, CwDatePicker, CwDatePickerTemporal, CwDateRangePicker, CwDateRangePickerTemporal, CwDateTimePicker, CwDateTimePickerCompact, CwDateTimePickerTemporal, CwDialog, CwDigit, CwDisplayMessage, CwDropdown, CwDropdownFilter, CwExpandable, CwFileUploadMultiple, CwFindAirport, CwFindCrewmember, CwGenericTooltip, CwHeadingMain, CwHeadingSecond, CwIcon, CwImageArea, CwImageGallery, CwImageZoom, CwInput, CwInputColor, CwInputDateText, CwInputDatetime, CwInputImage, CwInputNumber, CwInputPhone, CwInputText, CwKeyValueList, CwLabel, CwLoading, CwMasterDetail, CwMessage, CwMessageManager, CwMessageType, CwModal, CwModalHover, CwModalReportFunctional, CwMultiFilter, CwMultiFilterTag, CwNavMenu, CwNote, CwOption, CwPopoverButton, CwProgress, CwRadioGroup, CwReportModal, CwSearchAsync, CwSearchInput, CwSelect, CwSelectList, CwSelectListItems, CwSkeleton, CwSortableList, CwSortableTable, CwTable, CwTableGrouped, CwTableServerSide, CwTabs, CwTagSelector, CwTextArea, CwTime, CwTimePicker, CwToggle, CwTooltipManager, CwTooltipNew, CwTreeView, CwWeekdaySelector, DefaultRowHeader, OnClearPinned, OnClickContextMenu, OnClickEvent, OnClickRowEvent, OnClickRowHeader, OnClickUtc, OnDoubleClickEvent, OnDoubleClickRowEvent, OnDragEvent, OnDropCtrlEvent, OnDropEvent, OnEndClickHeaderEvent, OnLeftDragStart, OnMultiClickEvent, OnPinRow, OnRangeClickEvent, OnRightClickEvent, OnRightClickRow, OnRightDragStart, OnStartClickHeaderEvent, OnUnpinRow, PRESET_LIBRARY_TEMPORAL, PinRowHeader, Scheduler, SchedulerEvent, SuperScheduler, TooltipConstraintContext, UiEvent, Weekdays, configureCwLoading, eventIsVisible, filterNavItems, filterVisibleEvents, getCwLoadingDefaults, getDefaultDivisions, getEventSizes, getPresetsByKeysTemporal, itemsToMultiFilterTags, sortNavItems, useCwMessage, useSortableList, useSortableTable, useTooltipConstraint };
-export type { BackgroundEventDm, CardChip, ChipColorScheme, ChipVariant, Column$1 as Column, ConfirmationPopupProps, CwAlignProps, CwButtonSplitAction, CwButtonSplitProps, CwButtonSwitchOption, CwButtonSwitchProps, CwCardListProps, CwCardProps, CwChipProps, CwDialogProps, CwDropdownOption, CwDropdownProps, CwExpandableProps, CwGroupLayoutProps, CwImageAreaMethods, CwImageAreaProps, CwInputDateTextProps, CwInputDatetimeProps, CwInputImageProps, CwInputNumberProps, CwInputPhoneProps, CwInputTextProps, CwInputTimeProps, CwKeyValueListProps, CwLabelProps, CwLayoutProps, CwLoadingDefaults, CwMasterDetailItem, CwMasterDetailProps, CwMessageProps, CwModalHoverProps, CwMultiFilterProps, CwMultiFilterTagProps, CwNavItem, CwNavMenuProps, CwNoteProps, CwPopoverButtonProps, CwProgressProps, CwRadioGroupProps, CwReportModalFunctionalProps, CwSearchAsyncOption, CwSearchAsyncProps, CwSelectListProps, CwSkeletonProps, CwSortableListProps, CwSortableTableProps, CwTableGroupedData, CwTableGroupedData_Group, CwTableGroupedData_Row, CwTableGroupedProps, CwTagSelectorOption, CwTagSelectorProps, CwTextAreaProps, CwTreeNode, DataItem, DateRangePresetTemporal, DateRangeValue, DateRangeValueTemporal, ICwMultiFilterTag, ImageItem, IndicatorRowDm, MenuOption, OnEvent, PinRowHeaderProps, RowHeaderDm, RowHeaderProps, SchedulerEventDm, SchedulerEventState, SchedulerRowProps, SchedulerState, ServerSideTableState, SortableColumn, SortableTableDragState, SuperSchedulerProps, Tab, UseSortableTableReturn, Weekday, ZoomImageItem };
+export { CwAccordionContainer, CwAlign, CwAnchoredMenu, CwBadge, CwBtnApprove, CwBtnCancel, CwBtnDelete, CwBtnEdit, CwBtnSave, CwButton, CwButtonSplit, CwButtonSwitch, CwCard, CwCardList, CwCheck, CwCheckbox, CwCheckboxGroup, CwChip, CwColorPicker, CwConfirmationPopup, CwContextMenu, CwDatePicker, CwDatePickerTemporal, CwDateRangePicker, CwDateRangePickerTemporal, CwDateTimePicker, CwDateTimePickerCompact, CwDateTimePickerTemporal, CwDialog, CwDigit, CwDisplayMessage, CwDropdown, CwDropdownFilter, CwExpandable, CwFileUploadMultiple, CwFindAirport, CwFindCrewmember, CwGenericTooltip, CwHeadingMain, CwHeadingSecond, CwIcon, CwImageArea, CwImageGallery, CwImageZoom, CwInput, CwInputColor, CwInputDateText, CwInputDatetime, CwInputImage, CwInputNumber, CwInputPhone, CwInputText, CwKeyValueList, CwLabel, CwLoading, CwMasterDetail, CwMessage, CwMessageManager, CwMessageType, CwModal, CwModalHover, CwModalReportFunctional, CwMultiFilter, CwMultiFilterTag, CwNavMenu, CwNote, CwOption, CwPopoverButton, CwProgress, CwRadioGroup, CwReportModal, CwSearchAsync, CwSearchInput, CwSelect, CwSelectList, CwSelectListItems, CwSkeleton, CwSortableList, CwSortableTable, CwTable, CwTableGrouped, CwTableServerSide, CwTabs, CwTagSelector, CwTextArea, CwTime, CwTimePicker, CwToggle, CwTooltipManager, CwTooltipNew, CwTreeView, CwWeekdaySelector, DefaultRowHeader, OnClearPinned, OnClickContextMenu, OnClickEvent, OnClickRowEvent, OnClickRowHeader, OnClickUtc, OnDoubleClickEvent, OnDoubleClickRowEvent, OnDragEvent, OnDropCtrlEvent, OnDropEvent, OnEndClickHeaderEvent, OnLeftDragStart, OnMultiClickEvent, OnPinRow, OnRangeClickEvent, OnRightClickEvent, OnRightClickRow, OnRightDragStart, OnStartClickHeaderEvent, OnUnpinRow, PRESET_LIBRARY_TEMPORAL, PinRowHeader, Scheduler, SchedulerEvent, SuperScheduler, TooltipConstraintContext, UiEvent, Weekdays, configureCwLoading, eventIsVisible, filterNavItems, filterVisibleEvents, getCwLoadingDefaults, getDefaultDivisions, getEventSizes, getPresetsByKeysTemporal, itemsToMultiFilterTags, sortNavItems, useCwMessage, useSortableList, useSortableTable, useTooltipConstraint };
+export type { BackgroundEventDm, BadgeColorScheme, BadgeSize, BadgeVariant, CardChip, ChipColorScheme, ChipVariant, Column$1 as Column, ConfirmationPopupProps, CwAlignProps, CwBadgeProps, CwButtonSplitAction, CwButtonSplitProps, CwButtonSwitchOption, CwButtonSwitchProps, CwCardListProps, CwCardProps, CwChipProps, CwDialogProps, CwDropdownOption, CwDropdownProps, CwExpandableProps, CwGroupLayoutProps, CwImageAreaMethods, CwImageAreaProps, CwInputDateTextProps, CwInputDatetimeProps, CwInputImageProps, CwInputNumberProps, CwInputPhoneProps, CwInputTextProps, CwInputTimeProps, CwKeyValueListProps, CwLabelProps, CwLayoutProps, CwLoadingDefaults, CwMasterDetailItem, CwMasterDetailProps, CwMessageProps, CwModalHoverProps, CwMultiFilterProps, CwMultiFilterTagProps, CwNavItem, CwNavMenuProps, CwNoteProps, CwPopoverButtonProps, CwProgressProps, CwRadioGroupProps, CwReportModalFunctionalProps, CwSearchAsyncOption, CwSearchAsyncProps, CwSelectListProps, CwSkeletonProps, CwSortableListProps, CwSortableTableProps, CwTableGroupedData, CwTableGroupedData_Group, CwTableGroupedData_Row, CwTableGroupedProps, CwTagSelectorOption, CwTagSelectorProps, CwTextAreaProps, CwTreeNode, DataItem, DateRangePresetTemporal, DateRangeValue, DateRangeValueTemporal, ICwMultiFilterTag, ImageItem, IndicatorRowDm, MenuOption, OnEvent, PinRowHeaderProps, RowHeaderDm, RowHeaderProps, SchedulerEventDm, SchedulerEventState, SchedulerRowProps, SchedulerState, ServerSideTableState, SortableColumn, SortableTableDragState, SuperSchedulerProps, Tab, UseSortableTableReturn, Weekday, ZoomImageItem };