@cwellt_software/cwellt-reactjs-lib 1.4.15 → 1.5.0

package/dist/index.d.ts

@@ -282,7 +282,7 @@ type ZoomImageItem = {
  */
 declare function CwImageZoom(image: ZoomImageItem): React$1.JSX.Element;
 
-interface CwIconProps extends Omit<HTMLProps<HTMLSpanElement>, "className" | "size"> {
+interface CwIconProps extends Omit<HTMLProps<HTMLSpanElement>, "size"> {
     /** Icon identifier */
     iconId: string;
     /** Color variant **/
@@ -305,50 +305,38 @@ interface CwLoadingProps {
     size?: LoadingSize;
     /** Position of the icon */
     iconPosition?: IconPosition;
-    /** Custom icon class (default: 'cwi-plane-solid') */
+    /** Custom icon class. Falls back to the global default (configureCwLoading); with none, a neutral ring is shown. */
     iconName?: string;
     /** Custom animation (default: 'spin') */
     animation?: string;
 }
 /**
- * CwLoading
+ * CwLoading — a spinner with optional text that dims the wrapped content while loading.
  *
- * A versatile loading component that shows a spinner with optional text
- * and disables the wrapped content while in loading state.
+ * Icon resolves as `iconName` prop → `getCwLoadingDefaults().icon` → none (neutral ring).
  *
  * @example
- * // Basic usage
  * <CwLoading isLoading={isSubmitting}>
  *   <form>...</form>
  * </CwLoading>
- *
- * // With custom text and size
- * <CwLoading
- *   isLoading={isLoading}
- *   text="Please wait..."
- *   size="large"
- * >
- *   <UserProfile />
- * </CwLoading>
  */
 declare function CwLoading({ isLoading, text, size, iconPosition, iconName, animation, children }: React__default.PropsWithChildren<CwLoadingProps>): React__default.JSX.Element;
 
-interface CwLoadingSmallProps {
-    isLoading?: boolean;
+/**
+ * Global, module-level defaults for CwLoading (singleton, no provider).
+ * An app sets these once at init; every CwLoading reads them at render time.
+ */
+interface CwLoadingDefaults {
+    /** Icon class applied when a CwLoading has no explicit `iconName` (e.g. 'cwi-plane-solid'). */
+    icon?: string;
 }
 /**
- * @deprecated since may 2025. Use <CwLoading size="small"> instead.
- *
- * This component will be removed in a future release.
- *
- * @example
- * // Instead of:
- * <CwLoadingSmall />
- *
- * // Use:
- * <CwLoading size="small" />
+ * Register global CwLoading defaults. Call once at app init, before the first render.
+ * Merges into any previously configured defaults.
  */
-declare function CwLoadingSmall(CwelltLoadingAppointements: React$1.PropsWithChildren<CwLoadingSmallProps>): React$1.JSX.Element;
+declare function configureCwLoading(next: CwLoadingDefaults): void;
+/** Read the currently configured CwLoading defaults. */
+declare function getCwLoadingDefaults(): CwLoadingDefaults;
 
 type TooltipPosition = "top" | "bottom" | "left" | "right";
 interface CwGenericTooltipProps {
@@ -1373,22 +1361,6 @@ interface CwTableGroupedProps {
  */
 declare const CwTableGrouped: FC<CwTableGroupedProps>;
 
-interface ConfigDM {
-    ID: number;
-    Description: string;
-    Value: string;
-    Bindata: string;
-}
-interface CwFileUploadProps {
-    accept: string;
-    acceptString: string;
-    sizeString?: string;
-    file?: ConfigDM;
-    onChange: (file: File) => void;
-    onSaveHexContent: (hexContent: string) => void;
-}
-declare function CwFileUpload(fileUploadProps: React__default.PropsWithChildren<CwFileUploadProps>): React__default.JSX.Element;
-
 interface CwFileUploadMultipleLabels {
     uploadDisabled: string;
     clickToUpload: string;
@@ -1397,6 +1369,7 @@ interface CwFileUploadMultipleLabels {
     allTypesAccepted: string;
     changeFile: string;
     clearAll: string;
+    upload: string;
     addMoreFiles: string;
     filesSelected: (count: number) => string;
     fileTooLarge: (name: string, maxSize: number) => string;
@@ -1412,10 +1385,14 @@ interface CwFileUploadMultipleProps {
     allowedTypes?: string[];
     onSelect?: (files: FileList | null) => void;
     onError?: (error: string) => void;
+    onConfirm?: (files: FileList) => void;
+    confirmLabel?: string;
+    confirmDisabled?: boolean;
     className?: string;
     disabled?: boolean;
     hideClearAll?: boolean;
     initialFileName?: string;
+    statusText?: string;
     labels?: Partial<CwFileUploadMultipleLabels>;
 }
 declare function CwFileUploadMultiple(fileUploadProps: React__default.PropsWithChildren<CwFileUploadMultipleProps>): React__default.JSX.Element;
@@ -1786,9 +1763,22 @@ interface CwInputDateTextProps extends Omit<React__default.HTMLProps<HTMLInputEl
  */
 declare function CwInputDateText(props: CwInputDateTextProps): React__default.JSX.Element;
 
-interface CwInputImageProps extends Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "className" | "type" | "onChange"> {
+interface CwInputImageLabels {
+    dropImageHere: string;
+    paste: string;
+    browse: string;
+    acceptedFormats: (formats: string) => string;
+    clipboardError: string;
+    invalidType: (formats: string) => string;
+    readError: string;
+}
+interface CwInputImageProps extends Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "className" | "type" | "onChange" | "onError" | "size"> {
     allowedImageFormats?: string[];
-    onChange?: (image: string | null) => void;
+    onChange?: (dataUrl: string | null, file?: File) => void;
+    onError?: (error: string) => void;
+    labels?: Partial<CwInputImageLabels>;
+    /** Scales the dropzone and drives the size of the Paste/Browse buttons. Unset = default (medium) size. */
+    size?: "small" | "medium" | "large";
 }
 declare function CwInputImage(props: CwInputImageProps): React$1.JSX.Element;
 
@@ -2505,6 +2495,99 @@ type TreeViewProps<T> = {
 };
 declare function CwTreeView<T>({ data, onSelect, allowParentSelection, selectedId: initialSelectedId }: TreeViewProps<T>): React$1.JSX.Element;
 
+interface CwNavItem {
+    /** Stable id, also the React key */
+    id: string;
+    /** Resolved display text — the consumer owns i18n / tenant naming */
+    label: string;
+    /** Link target for leaves; groups may omit it */
+    href?: string;
+    /** Resolved secondary text — not rendered by the menu, but searched alongside label and href */
+    description?: string;
+    /** CW icon name */
+    icon?: string;
+    /** Non-empty children make this item a collapsible group */
+    children?: CwNavItem[];
+}
+/** Remaining props land on the <nav> — `data-*` (CBT walkthrough targets), `aria-*`, `data-testid`. */
+interface CwNavMenuProps extends Omit<HTMLAttributes<HTMLElement>, "children"> {
+    /** Already permission-filtered and ordered by the consumer */
+    items: CwNavItem[];
+    /** Renders placeholder rows instead of the tree */
+    loading?: boolean;
+    /**
+     * Router-agnostic active detection; nothing is highlighted when omitted. Injected because the
+     * library cannot depend on a router (WinOps: react-router-dom 6.28, Improve: a different one,
+     * playground: none) — the consumer answers "is this the current page?", the component owns the
+     * highlight. Revisitable: if the apps ever converge on one router, this could move inside.
+     */
+    isActive?: (item: CwNavItem) => boolean;
+    /** Inject a router link component; defaults to a plain <a href> */
+    renderLink?: (item: CwNavItem, children: ReactNode) => ReactNode;
+    /**
+     * Show a trailing chevron on **top-level** group rows. Nested groups (level 2+) always show it
+     * and ignore this flag — don't normalise the two cases: a level-1 group is already marked by
+     * its heavier type and [open] background, while a nested group is otherwise indistinguishable
+     * from its sibling leaf links.
+     */
+    showExpandIndicator?: boolean;
+    /**
+     * Filters the tree through `filterNavItems`: a group survives when it or any descendant matches.
+     * Quoted `"phrases"` match the label; loose words match label + description + href. Blank or
+     * omitted means no filtering.
+     */
+    search?: string;
+    /** Shown only while a search is active and nothing matched — an empty `items` still renders nothing */
+    emptyMessage?: string;
+    /**
+     * Sorts the **top level** alphabetically; nested lists keep the consumer's order. Off by default.
+     * Level-1-only is deliberate: a long list of modules is hard to scan, while the pages inside one
+     * are ordered on purpose.
+     */
+    sortAlphabetically?: boolean;
+    /**
+     * Rows for the sticky favourites section above the tree. Omit it and no section renders. The
+     * library owns the disclosure and its look; the rows are yours, so their markup, secondary text
+     * and any `data-*` stay under your control.
+     */
+    favoritesSlot?: ReactNode;
+    /** Header for the favourites section. Pass your own translation. */
+    favoritesLabel?: string;
+    /** Attributes for the favourites `<details>` — `data-tour`, or `open` to override the default. */
+    favoritesProps?: HTMLAttributes<HTMLDetailsElement>;
+    /**
+     * Marks a leaf as favourited with a star. Indicator only — toggling stays with the consumer
+     * (a context menu on the link, for instance), so no row gains a control it didn't have.
+     */
+    isFavorite?: (item: CwNavItem) => boolean;
+    /**
+     * An app-provided section between the favourites and the tree — WinOps's external "Places" links,
+     * for instance. Kept out of `items` on purpose: it is a parallel list, so it is not filtered by
+     * `search` or reordered by `sortAlphabetically`.
+     *
+     * A `<details>` placed here is styled as a top-level section automatically.
+     */
+    beforeTreeSlot?: ReactNode;
+}
+/** Sizes only its own icons — content injected via `renderLink` is styled by the consumer. */
+declare function CwNavMenu({ items, loading, isActive, renderLink, showExpandIndicator, search, emptyMessage, sortAlphabetically, favoritesSlot, favoritesLabel, favoritesProps, isFavorite, beforeTreeSlot, className, ...navProps }: CwNavMenuProps): React$1.JSX.Element;
+
+/**
+ * Filters a nav tree by a search string, keeping a group whose descendants match.
+ *
+ * Supports `"quoted phrases"` (must appear in the label) alongside loose words (any field) — this is
+ * behaviour users are told about, so don't simplify it.
+ */
+declare function filterNavItems(items: CwNavItem[], search?: string): CwNavItem[];
+
+/**
+ * Sorts the top level alphabetically, leaving every nested list in the order the consumer gave.
+ *
+ * Deliberately level 1 only: this exists because a long list of modules is hard to scan, while the
+ * pages inside a module are ordered on purpose. Returns the input untouched when not sorting.
+ */
+declare function sortNavItems(items: CwNavItem[], alphabetically?: boolean): CwNavItem[];
+
 /** Props for {@link CwSearchInput}. */
 interface CwSearchInputProps extends HTMLProps<HTMLDivElement> {
     /** List of items to search through. Each item must be a `CwSelectList` instance. */
@@ -2527,6 +2610,8 @@ interface CwSearchInputProps extends HTMLProps<HTMLDivElement> {
     error?: boolean;
     /** Custom renderer for each suggestion item. Receives the matching `CwSelectList` entry. */
     renderOption?: (option: CwSelectList) => React__default.ReactNode;
+    /** Focuses the internal `<input>` on mount when `true`. */
+    autoFocus?: boolean;
 }
 /**
  * Text input with a live-filtered suggestion dropdown backed by a local `CwSelectList` array.
@@ -3904,5 +3989,5 @@ declare class OnClickContextMenu implements UiEvent {
     constructor(id: string, clickedMenu: string);
 }
 
-export { CblDragAndDrop$1 as CblDragAndDrop, 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, CwFileUpload, CwFileUploadMultiple, CwFindAirport, CwFindCrewmember, CwGenericTooltip, CwHeadingMain, CwHeadingSecond, CwIcon, CwImageArea, CwImageGallery, CwImageZoom, CwInput, CwInputColor, CwInputDateText, CwInputDatetime, CwInputImage, CwInputNumber, CwInputPhone, CwInputText, CwKeyValueList, CwLabel, CwLoading, CwLoadingSmall, CwMasterDetail, CwMessage, CwMessageManager, CwMessageType, CwModal, CwModalHover, CwModalReportFunctional, CwMultiFilter, CwMultiFilterTag, CwNote, CwOption, CwPopoverButton, CwRadioGroup, CwReportModal, CwScheduler, CwSearchAsync, CwSearchInput, CwSelect, CwSelectList, CwSelectListItems, CwSortableList, CwSortableTable, CwSuperScheduler, 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, Resource, Scheduler, SchedulerEvent, SuperScheduler, TooltipConstraintContext, UiEvent, Weekdays, cblEvent, eventIsVisible, filterVisibleEvents, getDefaultDivisions, getEventSizes, getPresetsByKeysTemporal, itemsToMultiFilterTags, 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, CwMasterDetailItem, CwMasterDetailProps, CwMessageProps, CwModalHoverProps, CwMultiFilterProps, CwMultiFilterTagProps, CwNoteProps, CwPopoverButtonProps, CwRadioGroupProps, CwReportModalFunctionalProps, CwSearchAsyncOption, CwSearchAsyncProps, CwSelectListProps, 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, cblEventCompProps, resourceCompProps2 };
+export { CblDragAndDrop$1 as CblDragAndDrop, 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, CwRadioGroup, CwReportModal, CwScheduler, CwSearchAsync, CwSearchInput, CwSelect, CwSelectList, CwSelectListItems, CwSortableList, CwSortableTable, CwSuperScheduler, 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, Resource, Scheduler, SchedulerEvent, SuperScheduler, TooltipConstraintContext, UiEvent, Weekdays, cblEvent, 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, CwRadioGroupProps, CwReportModalFunctionalProps, CwSearchAsyncOption, CwSearchAsyncProps, CwSelectListProps, 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, cblEventCompProps, resourceCompProps2 };