@trimble-oss/moduswebcomponents
Version:
Modus Web Components is a modern, accessible UI library built with Stencil JS that provides reusable web components following Trimble's Modus design system. This updated version focuses on improved flexibility, enhanced theming options, comprehensive cust
1,551 lines • 291 kB
TypeScript
/* eslint-disable */
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
import { IAppMenuItem } from "./components/modus-wc-app-menu/modus-wc-app-menu";
import { AppName, AutocompleteTypes, DaisySize, Density, IAutocompleteItem, IAutocompleteNoResults, IFileDropzoneFeedback, IInputFeedbackProp, LogoName, ModusSize, Orientation, PopoverPlacement, SelectionMode, TextFieldTypes, TypographyHierarchy, TypographySize, TypographyWeight, WeekStartDay } from "./components/types";
import { IAvatarImageLoadError } from "./components/modus-wc-avatar/modus-wc-avatar";
import { IBottomSheetHeader, TBottomSheetDisplayMode } from "./components/modus-wc-bottom-sheet/modus-wc-bottom-sheet";
import { IBreadcrumb } from "./components/modus-wc-breadcrumbs/modus-wc-breadcrumbs";
import { ICollapseOptions } from "./components/modus-wc-collapse/modus-wc-collapse";
import { IInputFeedbackLevel } from "./components/modus-wc-input-feedback/modus-wc-input-feedback";
import { LoaderColor, LoaderVariant } from "./components/modus-wc-loader/modus-wc-loader";
import { INavbarTextOverrides, INavbarUserCard, INavbarVisibility } from "./components/modus-wc-navbar/modus-wc-navbar";
import { IAriaLabelValues, IPageChange } from "./components/modus-wc-pagination/modus-wc-pagination";
import { IProfileMenuProps, ISubMenu } from "./components/modus-wc-profile-menu/modus-wc-profile-menu";
import { IRatingChange, ModusWcRatingVariant } from "./components/modus-wc-rating/modus-wc-rating";
import { ISelectOption } from "./components/modus-wc-select/modus-wc-select";
import { IStepperItem } from "./components/modus-wc-stepper/modus-wc-stepper";
import { IPaginationChangeEventDetail, ITableColumn } from "./components/modus-wc-table/modus-wc-table";
import { SortingState } from "@tanstack/table-core";
import { ITab } from "./components/modus-wc-tabs/modus-wc-tabs";
import { IThemeConfig } from "./providers/theme/theme.types";
import { ToastPosition } from "./components/modus-wc-toast/modus-wc-toast";
export { IAppMenuItem } from "./components/modus-wc-app-menu/modus-wc-app-menu";
export { AppName, AutocompleteTypes, DaisySize, Density, IAutocompleteItem, IAutocompleteNoResults, IFileDropzoneFeedback, IInputFeedbackProp, LogoName, ModusSize, Orientation, PopoverPlacement, SelectionMode, TextFieldTypes, TypographyHierarchy, TypographySize, TypographyWeight, WeekStartDay } from "./components/types";
export { IAvatarImageLoadError } from "./components/modus-wc-avatar/modus-wc-avatar";
export { IBottomSheetHeader, TBottomSheetDisplayMode } from "./components/modus-wc-bottom-sheet/modus-wc-bottom-sheet";
export { IBreadcrumb } from "./components/modus-wc-breadcrumbs/modus-wc-breadcrumbs";
export { ICollapseOptions } from "./components/modus-wc-collapse/modus-wc-collapse";
export { IInputFeedbackLevel } from "./components/modus-wc-input-feedback/modus-wc-input-feedback";
export { LoaderColor, LoaderVariant } from "./components/modus-wc-loader/modus-wc-loader";
export { INavbarTextOverrides, INavbarUserCard, INavbarVisibility } from "./components/modus-wc-navbar/modus-wc-navbar";
export { IAriaLabelValues, IPageChange } from "./components/modus-wc-pagination/modus-wc-pagination";
export { IProfileMenuProps, ISubMenu } from "./components/modus-wc-profile-menu/modus-wc-profile-menu";
export { IRatingChange, ModusWcRatingVariant } from "./components/modus-wc-rating/modus-wc-rating";
export { ISelectOption } from "./components/modus-wc-select/modus-wc-select";
export { IStepperItem } from "./components/modus-wc-stepper/modus-wc-stepper";
export { IPaginationChangeEventDetail, ITableColumn } from "./components/modus-wc-table/modus-wc-table";
export { SortingState } from "@tanstack/table-core";
export { ITab } from "./components/modus-wc-tabs/modus-wc-tabs";
export { IThemeConfig } from "./providers/theme/theme.types";
export { ToastPosition } from "./components/modus-wc-toast/modus-wc-toast";
export namespace Components {
/**
* A customizable accordion component used for showing and hiding related groups of content.
* The component supports a `<slot>` called 'content' for injecting `<modus-wc-collapse>` elements. See [Collapse](/docs/components-collapse--docs) docs for additional info.
*/
interface ModusWcAccordion {
/**
* Custom CSS class to apply to the inner div.
* @default ''
*/
"customClass"?: string;
}
/**
* A customizable alert component used to inform the user about important events.
* The component supports `<slot>` elements for injecting custom content and buttons.
*/
interface ModusWcAlert {
/**
* The description of the alert.
*/
"alertDescription"?: string;
/**
* The title of the alert.
*/
"alertTitle": string;
/**
* Custom CSS class to apply to the outer div element.
* @default ''
*/
"customClass"?: string;
/**
* Time taken to dismiss the alert in milliseconds
*/
"delay"?: number;
/**
* Whether to disable the icon
* @default false
*/
"disableIcon"?: boolean;
/**
* Whether the alert has a dismiss button
* @default false
*/
"dismissible"?: boolean;
/**
* The Modus icon to render.
*/
"icon"?: string;
/**
* The variant of the alert.
* @default 'info'
*/
"variant"?: 'error' | 'info' | 'neutral' | 'success' | 'warning';
}
interface ModusWcAppMenu {
/**
* The apps to display in the menu.
* @default []
*/
"apps"?: IAppMenuItem[];
/**
* custom class to apply to the menu
* @default ''
*/
"customClass"?: string;
/**
* The layout of the menu.
* @default 'list'
*/
"layout"?: 'list' | 'grid';
}
/**
* A customizable autocomplete component used to create searchable text inputs.
* The component supports a `<slot>` for injecting custom content.
*/
interface ModusWcAutocomplete {
/**
* Hint for form autofill feature.
*/
"autoComplete"?: AutocompleteTypes;
/**
* Indicates that the autocomplete should have a border.
* @default true
*/
"bordered"?: boolean;
/**
* Clear the input value and reset items
*/
"clearInput": () => Promise<void>;
/**
* Programmatically close the menu
*/
"closeMenu": () => Promise<void>;
/**
* Custom blur handler - if provided, overrides default blur behavior
*/
"customBlur"?: (event: FocusEvent) => void;
/**
* Custom CSS class to apply to host element.
* @default ''
*/
"customClass"?: string;
/**
* Custom input change handler - if provided, overrides default search filtering
*/
"customInputChange"?: (value: string) => void;
/**
* Custom item selection handler - if provided, overrides default selection logic
*/
"customItemSelect"?: (item: IAutocompleteItem) => void;
/**
* Custom key down handler - if provided, overrides default keyboard navigation
*/
"customKeyDown"?: (event: KeyboardEvent) => void;
/**
* The debounce timeout in milliseconds. Set to 0 to disable debouncing.
* @default 300
*/
"debounceMs"?: number;
/**
* Whether the form control is disabled.
* @default false
*/
"disabled"?: boolean;
/**
* Feedback state for the input field.
*/
"feedback"?: IInputFeedbackProp;
/**
* Programmatically set focus to input
*/
"focusInput": () => Promise<void>;
/**
* Show the clear button within the input field.
* @default false
*/
"includeClear"?: boolean;
/**
* Show the search icon within the input field.
* @default false
*/
"includeSearch"?: boolean;
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* Determine the control's relative ordering for sequential focus navigation (typically with the Tab key).
*/
"inputTabIndex"?: number;
/**
* The items to display in the menu. Creating a new array of items will ensure proper component re-render.
* @default []
*/
"items"?: IAutocompleteItem[];
/**
* The text to display within the label.
*/
"label"?: string;
/**
* Whether the menu should remain open after an item is selected.
* @default false
*/
"leaveMenuOpen"?: boolean;
/**
* Maximum number of chips to display. When exceeded, shows expand/collapse button. Set to -1 to disable limit.
* @default -1
*/
"maxChips"?: number;
/**
* The minimum number of characters required to render the menu.
* @default 0
*/
"minChars": number;
/**
* Minimum width for the text input in pixels. When chips would make input smaller, container height increases instead.
* @default 10
*/
"minInputWidth"?: number;
/**
* Whether the input allows multiple items to be selected.
* @default false
*/
"multiSelect"?: boolean;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
*/
"name"?: string;
/**
* The content to display when no results are found.
* @default { ariaLabel: 'No results found', label: 'No results found', subLabel: 'Check spelling or try a different keyword', }
*/
"noResults"?: IAutocompleteNoResults;
/**
* Programmatically open the menu
*/
"openMenu": () => Promise<void>;
/**
* Text that appears in the form control when it has no value set.
* @default ''
*/
"placeholder"?: string;
/**
* Whether the value is editable.
* @default false
*/
"readOnly"?: boolean;
/**
* A value is required for the form to be submittable.
* @default false
*/
"required"?: boolean;
/**
* Programmatically select an item
*/
"selectItem": (item: IAutocompleteItem | null) => Promise<void>;
/**
* Whether to show the menu whenever the input has focus, regardless of input value.
* @default false
*/
"showMenuOnFocus"?: boolean;
/**
* A spinner that appears when set to true
* @default false
*/
"showSpinner"?: boolean;
/**
* The size of the autocomplete (input and menu).
* @default 'md'
*/
"size"?: ModusSize;
/**
* Programmatically toggle the menu open/closed
*/
"toggleMenu": () => Promise<void>;
/**
* The value of the control.
* @default ''
*/
"value": string;
}
/**
* A customizable avatar component used to create avatars with different images or user initials.
* When no image is provided, the component can display initials (up to 3 characters) from the initials prop.
* The component will extract the first letter of each word in the initials string.
*/
interface ModusWcAvatar {
/**
* The image alt attribute for accessibility.
*/
"alt": string;
/**
* Custom CSS class to apply to the inner div.
* @default ''
*/
"customClass"?: string;
/**
* The location of the image.
* @default ''
*/
"imgSrc": string;
/**
* The initials to display when no image is provided.
* @default ''
*/
"initials"?: string;
/**
* The shape of the avatar.
* @default 'circle'
*/
"shape"?: 'circle' | 'square';
/**
* The size of the avatar.
* @default 'md'
*/
"size"?: DaisySize | 'xl';
}
/**
* A customizable badge component used to create badges with different sizes, types, and colors.
* The component supports a `<slot>` for injecting content within the badge.
*/
interface ModusWcBadge {
/**
* The color variant of the badge.
* @default 'primary'
*/
"color": | 'primary'
| 'secondary'
| 'tertiary'
| 'high-contrast'
| 'success'
| 'warning'
| 'danger';
/**
* Custom CSS class to apply to the span element.
* @default ''
*/
"customClass": string;
/**
* The size of the badge.
* @default 'md'
*/
"size": ModusSize;
/**
* The variant of the badge.
* @default 'filled'
*/
"variant": 'counter' | 'filled' | 'outlined' | 'text';
}
interface ModusWcBottomSheet {
/**
* Custom CSS class to apply to the outer div.
* @default ''
*/
"customClass"?: string;
/**
* Resting display mode: 'minimized', 'default', or 'expanded'. Drag/keyboard interactions do not overwrite this prop.
* @default 'default'
*/
"displayMode"?: TBottomSheetDisplayMode;
/**
* Fraction (0-1) of the sheet height it must be dragged, in either direction, before it steps one level.
* @default 0.4
*/
"dragStepThreshold"?: number;
/**
* Configuration for the built-in header layout. Do not set this prop if you intend to use the 'header' slot.
*/
"header"?: IBottomSheetHeader;
/**
* Controls whether the bottom sheet is visible.
* @default false
*/
"visible"?: boolean;
}
/**
* A customizable breadcrumbs component used to help users navigate through a website.
*/
interface ModusWcBreadcrumbs {
/**
* Custom CSS class to apply to the inner div.
* @default ''
*/
"customClass"?: string;
/**
* The breadcrumbs to render.
* @default []
*/
"items": IBreadcrumb[];
/**
* The size of the breadcrumbs.
* @default 'md'
*/
"size"?: ModusSize;
}
/**
* A customizable button component used to create buttons with different sizes, variants, and types.
* The component supports a `<slot>` for injecting content within the button, similar to a native HTML button.
*/
interface ModusWcButton {
/**
* The color variant of the button.
* @default 'primary'
*/
"color": | 'primary'
| 'secondary'
| 'tertiary'
| 'warning'
| 'danger'
| 'neutral';
/**
* Custom CSS class to apply to the button element.
* @default ''
*/
"customClass"?: string;
/**
* If true, the button will be disabled.
* @default false
*/
"disabled"?: boolean;
/**
* If true, the button will take the full width of its container.
* @default false
*/
"fullWidth"?: boolean;
/**
* If true, the button will be in a pressed state (for toggle buttons).
* @default false
*/
"pressed"?: boolean;
/**
* The shape of the button.
* @default 'rectangle'
*/
"shape": 'circle' | 'ellipse' | 'rectangle' | 'square';
/**
* The size of the button.
* @default 'md'
*/
"size": DaisySize | 'xl';
/**
* The type of the button.
* @default 'button'
*/
"type": 'button' | 'submit' | 'reset';
/**
* The variant of the button.
* @default 'filled'
*/
"variant": 'borderless' | 'filled' | 'outlined';
}
/**
* A customizable buttongroup component that groups multiple Modus buttons together.
* The component supports a `<slot>` for injecting content within the buttongroup.
*/
interface ModusWcButtonGroup {
/**
* Color to apply to all buttons within the button group
*/
"color"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'warning'
| 'danger'
| 'neutral';
/**
* Disables all buttons within the button group
* @default false
*/
"disabled"?: boolean;
/**
* Orientation of the button group: horizontal or vertical
* @default 'horizontal'
*/
"orientation"?: Orientation;
/**
* Selection type for button group
* @default 'default'
*/
"selectionType"?: 'default' | 'single' | 'multiple';
/**
* Style variant to apply to all buttons within the button group
* @default 'outlined'
*/
"variant": 'borderless' | 'filled' | 'outlined';
}
/**
* A customizable card component used to group and display content in a way that is easily readable.
* This component supports multiple `<slot>` elements including 'header' for images or custom content, 'title', 'subtitle', a default slot for main content, 'actions' for buttons or interactive elements, and 'footer'.
*/
interface ModusWcCard {
/**
* Makes any \<figure> in the 'header' slot cover the background
* @default false
*/
"backgroundFigure"?: boolean;
/**
* Adds a hard border to the card
* @default false
*/
"bordered"?: boolean;
/**
* Custom CSS class to apply
* @default ''
*/
"customClass"?: string;
/**
* Determines how the card is laid out
* @default 'vertical'
*/
"layout"?: 'vertical' | 'horizontal';
/**
* Determines the interior padding size
* @default 'compact'
*/
"padding"?: 'compact' | 'comfortable';
}
/**
* A customizable checkbox component
*/
interface ModusWcCheckbox {
/**
* Custom CSS class to apply to the inner div.
* @default ''
*/
"customClass"?: string;
/**
* The disabled state of the checkbox.
* @default false
*/
"disabled"?: boolean;
/**
* The indeterminate state of the checkbox.
* @default false
*/
"indeterminate": boolean;
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* The tabindex of the input.
*/
"inputTabIndex"?: number;
/**
* The text to display within the label.
*/
"label"?: string;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
* @default ''
*/
"name"?: string;
/**
* A value is required for the form to be submittable.
* @default false
*/
"required"?: boolean;
/**
* The size of the input.
* @default 'md'
*/
"size"?: ModusSize;
/**
* The value of the checkbox.
* @default false
*/
"value": boolean;
}
/**
* A customizable chip component used to display information in a compact area
* The component supports a `<slot>` for injecting custom content such as avatar and icons.
*/
interface ModusWcChip {
/**
* Active state of chip.
* @default false
*/
"active"?: boolean;
/**
* Custom CSS class to apply to the inner div.
* @default ''
*/
"customClass"?: string;
/**
* Whether the chip is disabled.
* @default false
*/
"disabled"?: boolean;
/**
* Whether the chip has an error.
* @default false
*/
"hasError"?: boolean;
/**
* The label to display in the chip.
* @default ''
*/
"label"?: string;
/**
* Whether the chip height can grow and its content can wrap across multiple lines.
* @default false
*/
"multiline"?: boolean;
/**
* The shape of the chip: 'rectangle' (default) or 'circle'.
* @default 'rectangle'
*/
"shape"?: 'rectangle' | 'circle';
/**
* Whether to show the close icon on right side of the chip.
* @default false
*/
"showRemove"?: boolean;
/**
* The size of the chip.
* @default 'md'
*/
"size"?: ModusSize;
/**
* The variant of the chip.
* @default 'filled'
*/
"variant"?: 'filled' | 'outline';
}
/**
* A customizable collapse component used for showing and hiding content.
* The component supports a 'header' and 'content' `<slot>` for injecting custom HTML.
*/
interface ModusWcCollapse {
/**
* When true, renders a border-bottom on the collapse component.
* @default false
*/
"bordered"?: boolean;
/**
* Controls chevron placement.
* @default 'right'
*/
"chevronPosition"?: 'left' | 'right';
/**
* A unique identifier used to set the id attributes of various elements.
*/
"collapseId"?: string;
/**
* Custom CSS class to apply to the outer div.
* @default ''
*/
"customClass"?: string;
/**
* Controls whether the collapse is expanded or not.
* @default false
*/
"expanded"?: boolean;
/**
* Configuration options for rendering the pre-laid out collapse component. Do not set this prop if you intend to use the 'header' slot.
*/
"options"?: ICollapseOptions;
}
/**
* A customizable date picker component used to create date inputs.
* Adheres to WCAG 2.2 standards.
*/
interface ModusWcDate {
/**
* Indicates that the input should have a border.
* @default true
*/
"bordered"?: boolean;
/**
* Custom CSS class to apply to the input.
* @default ''
*/
"customClass"?: string;
/**
* Whether the form control is disabled.
* @default false
*/
"disabled"?: boolean;
/**
* Feedback to render below the input.
*/
"feedback"?: IInputFeedbackProp;
/**
* The date format for display and input.
*/
"format"?: | 'yyyy-mm-dd'
| 'dd-mm-yyyy'
| 'mm-dd-yyyy'
| 'yyyy/mm/dd'
| 'dd/mm/yyyy'
| 'mm/dd/yyyy'
| 'MMM DD, YYYY';
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* Determine the control's relative ordering for sequential focus navigation (typically with the Tab key).
*/
"inputTabIndex"?: number;
/**
* The text to display within the label.
*/
"label"?: string;
/**
* Maximum date value. Must match the `format` prop pattern (or the locale-derived format when unset) or ISO 8601 (`YYYY-MM-DD`).
*/
"max"?: string;
/**
* Minimum date value. Must match the `format` prop pattern (or the locale-derived format when unset) or ISO 8601 (`YYYY-MM-DD`).
*/
"min"?: string;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
*/
"name"?: string;
/**
* Whether the value is editable.
* @default false
*/
"readOnly"?: boolean;
/**
* A value is required or must be checked for the form to be submittable.
* @default false
*/
"required"?: boolean;
/**
* Displays ISO 8601 week numbers in the calendar. Week numbers are calculated with Monday as the first day of the week.
* @default false
*/
"showWeekNumbers"?: boolean;
/**
* The size of the input.
* @default 'md'
*/
"size"?: ModusSize;
/**
* The value of the control.
* @default ''
*/
"value": string;
/**
* The first day of the week for the calendar display
* @default 'sunday'
*/
"weekStartDay"?: WeekStartDay;
}
/**
* A customizable divider component used to separate content horizontally or vertically
*/
interface ModusWcDivider {
/**
* The color of the divider line.
* @default 'tertiary'
*/
"color"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'high-contrast'
| 'success'
| 'warning'
| 'danger';
/**
* The content to display in the divider.
* @default ''
*/
"content"?: string;
/**
* Custom CSS class to apply to the divider element.
* @default ''
*/
"customClass"?: string;
/**
* The orientation of the divider. This is in reference to how content will be rendered around the divider.
* @default 'vertical'
*/
"orientation"?: Orientation;
/**
* The position of the divider.
* @default 'center'
*/
"position"?: 'center' | 'end' | 'start';
/**
* Whether the divider is responsive or not.
* @default true
*/
"responsive"?: boolean;
}
/**
* A customizable dropdown menu component used to render a button and toggleable menu.
* The component supports a 'button' and 'menu' `<slot>` for injecting custom HTML content.
*/
interface ModusWcDropdownMenu {
/**
* The aria-label for the dropdown button.
*/
"buttonAriaLabel"?: string;
/**
* The color variant of the button.
* @default 'primary'
*/
"buttonColor"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'warning'
| 'danger';
/**
* The shape of the button.
* @default 'rectangle'
*/
"buttonShape"?: 'circle' | 'ellipse' | 'rectangle' | 'square';
/**
* The size of the button.
* @default 'md'
*/
"buttonSize"?: DaisySize | 'xl';
/**
* The variant of the button.
* @default 'filled'
*/
"buttonVariant"?: 'borderless' | 'filled' | 'outlined';
/**
* Custom CSS class to apply to the host element.
* @default ''
*/
"customClass"?: string;
/**
* If true, the button will be disabled.
* @default false
*/
"disabled"?: boolean;
/**
* Indicates that the menu should have a border.
* @default true
*/
"menuBordered"?: boolean;
/**
* Distance between the button and menu in pixels.
* @default 10
*/
"menuOffset"?: number;
/**
* The placement of the menu relative to the button.
* @default 'bottom-start'
*/
"menuPlacement"?: PopoverPlacement;
/**
* The size of the menu.
* @default 'md'
*/
"menuSize"?: ModusSize;
/**
* The positioning strategy for the menu. Use 'fixed' when the dropdown is inside a clipping ancestor (e.g. overflow:hidden) so the menu escapes to the viewport coordinate space.
* @default 'absolute'
*/
"menuStrategy"?: 'absolute' | 'fixed';
/**
* Indicates that the menu is visible.
* @default false
*/
"menuVisible": boolean;
}
/**
* File dropzone component that allows users to drag and drop files for upload.
* The component supports a `<slot>` called 'dropzone' for adding custom content such as progress indicators or additional instructions within the dropzone area.
*/
interface ModusWcFileDropzone {
/**
* Accepted file types (e.g. '.jpg,.png' or 'image/*')
*/
"acceptFileTypes"?: string;
/**
* Custom CSS class to apply to the file dropzone element
* @default ''
*/
"customClass"?: string;
/**
* Disable the file input
*/
"disabled"?: boolean;
/**
* External feedback to display info, success, or error state with optional custom icon and message
*/
"feedback"?: IFileDropzoneFeedback;
/**
* Custom instructions shown when files are dragged over the dropzone
*/
"fileDraggedOverInstructions"?: string;
/**
* Include state icon for default, validation, upload, and feedback states
* @default true
*/
"includeStateIcon"?: boolean;
/**
* Custom instructions shown as the default dropzone message
*/
"instructions"?: string;
/**
* Custom error message displayed when an invalid file type is selected
*/
"invalidFileTypeMessage"?: string;
/**
* Maximum number of files allowed, will show error if exceeded
*/
"maxFileCount"?: number;
/**
* Maximum allowed length of filename, will show error if exceeded
*/
"maxFileNameLength"?: number;
/**
* Maximum total file size in bytes allowed, will show error if exceeded
*/
"maxTotalFileSizeBytes"?: number;
/**
* Allow multiple file selection
*/
"multiple"?: boolean;
/**
* Reset the dropzone to its initial state, clearing all error and success states
*/
"reset": () => Promise<void>;
/**
* Success message displayed when files are uploaded successfully
*/
"successMessage"?: string;
}
/**
* A draggable handle component for resizing adjacent elements
*/
interface ModusWcHandle {
/**
* The color of the button.
* @default 'tertiary'
*/
"buttonColor"?: | 'primary'
| 'secondary'
| 'tertiary'
| 'warning'
| 'danger';
/**
* The size of the button.
* @default 'md'
*/
"buttonSize"?: DaisySize | 'xl';
/**
* The variant of the button.
* @default 'filled'
*/
"buttonVariant"?: 'borderless' | 'filled' | 'outlined';
/**
* Custom CSS class to apply to the handle element.
* @default ''
*/
"customClass"?: string;
/**
* The initial split percentage for the left/top panel (1-100). The right/bottom panel gets the remaining percentage.
* @default 50
*/
"defaultSplit"?: number;
/**
* The density/spacing of the handle container (compact: 8px, comfortable: 12px, relaxed: 16px).
* @default 'comfortable'
*/
"density"?: 'compact' | 'comfortable' | 'relaxed';
/**
* The left target element to resize (CSS selector or HTMLElement)
*/
"leftTarget"?: string | HTMLElement;
/**
* The orientation of the handle.
* @default 'horizontal'
*/
"orientation"?: Orientation;
/**
* The right target element to resize (CSS selector or HTMLElement)
*/
"rightTarget"?: string | HTMLElement;
/**
* The size of the handle.
* @default 'default'
*/
"size"?: 'default' | 'lg' | 'xl' | '2xl';
/**
* The type of handle to display.
* @default 'bar'
*/
"type"?: 'bar' | 'button';
}
/**
* A customizable icon component used to render Modus icons.
* <b>This component requires Modus icons to be installed in the host application. See [Modus Icon Usage](/docs/documentation-modus-icon-usage--docs) for steps.</b>
*/
interface ModusWcIcon {
/**
* Custom CSS class to apply to the i element.
* @default ''
*/
"customClass"?: string;
/**
* Indicates that the icon is decorative. When true, sets aria-hidden to hide the icon from screen readers.
* @default true
*/
"decorative"?: boolean;
/**
* The icon name, should match the CSS class in the icon font.
*/
"name": string;
/**
* The icon size, can be "sm", "md", "lg" (a custom size can be specified in CSS). This adjusts the font size for the icon.
* @default 'md'
*/
"size"?: DaisySize;
/**
* The icon variant, can be "outlined" or "solid".
*/
"variant"?: 'outlined' | 'solid';
}
/**
* A customizable feedback component used to provide additional context related to form input interactions.
* <b>To use a custom icon, this component requires Modus icons to be installed in the host application. See [Modus Icon Usage](/docs/documentation-modus-icon-usage--docs) for steps.</b>
*/
interface ModusWcInputFeedback {
/**
* Custom CSS class to apply to the outer div element.
* @default ''
*/
"customClass"?: string;
/**
* The Modus icon to use instead of the pre-defined icons.
* @default ''
*/
"icon"?: string;
/**
* The level informs which icon and color that will be rendered.
*/
"level": IInputFeedbackLevel;
/**
* The message.
* @default ''
*/
"message"?: string;
/**
* The size of the feedback component.
* @default 'md'
*/
"size"?: ModusSize;
}
/**
* A customizable input label component.
* The component supports a `<slot>` for injecting additional custom content inside the label, such as icons or formatted text.
*/
interface ModusWcInputLabel {
/**
* Additional classes for custom styling.
* @default ''
*/
"customClass"?: string;
/**
* The `for` attribute of the label, matching the `id` of the associated input.
*/
"forId"?: string;
/**
* The text to display within the label.
*/
"labelText"?: string;
/**
* Whether the label indicates a required field.
* @default false
*/
"required"?: boolean;
/**
* The size of the label.
* @default 'md'
*/
"size"?: ModusSize;
/**
* The text rendered beneath the label.
*/
"subLabelText"?: string;
}
/**
* A customizable link component used to navigate to URLs.
*/
interface ModusWcLink {
/**
* The color of the link.
* @default 'primary'
*/
"color": | 'primary'
| 'secondary'
| 'tertiary'
| 'inherit'
| 'success'
| 'info'
| 'warning'
| 'danger';
/**
* Custom CSS class to apply to the link element.
* @default ''
*/
"customClass"?: string;
/**
* The URL to navigate to when the link is activated.
*/
"href"?: string;
/**
* The relationship attribute for the link.
*/
"rel"?: string;
/**
* The browsing context for the link.
*/
"target"?: string;
/**
* The underline behavior of the link.
* @default 'always'
*/
"underline": 'always' | 'hover' | 'none';
}
/**
* A customizable loader component used to indicate the loading of content
*/
interface ModusWcLoader {
/**
* The color of the loader.
* @default 'primary'
*/
"color": LoaderColor;
/**
* Custom CSS class to apply to the loader element.
* @default ''
*/
"customClass"?: string;
/**
* The size of the loader.
* @default 'md'
*/
"size": DaisySize;
/**
* The variant of the loader.
* @default 'spinner'
*/
"variant": LoaderVariant;
}
/**
* A component for displaying Trimble product logos with support for both fixed and scalable sizing.
* Provides consistent branding across applications with various product logo options.
* Logo colors automatically adapt to the active Modus theme via CSS variables.
*/
interface ModusWcLogo {
/**
* The alt text for accessibility. If not provided, defaults to the logo name.
*/
"alt"?: string;
/**
* Custom CSS class to apply to the logo container.
* @default ''
*/
"customClass"?: string;
/**
* Show emblem version (icon only) instead of full logo
* @default false
*/
"emblem"?: boolean;
/**
* The name of the logo to display. Accepts values like 'trimble', 'viewpoint_field_view', etc.
*/
"name": LogoName;
}
/**
* A customizable menu component used to display a list of li elements vertically or horizontally.
* The component supports a `<slot>` for injecting custom li elements inside the ul element.
*/
interface ModusWcMenu {
/**
* Indicates that the menu should have a border.
*/
"bordered"?: boolean;
/**
* Custom CSS class to apply to the ul element.
* @default ''
*/
"customClass"?: string;
/**
* Indicates that this menu is a submenu (dropdown).
*/
"isSubMenu"?: boolean;
/**
* The orientation of the menu.
* @default 'vertical'
*/
"orientation"?: Orientation;
/**
* The selection mode of the menu.
* @default 'single'
*/
"selectionMode"?: SelectionMode;
/**
* The size of the menu.
* @default 'md'
*/
"size"?: ModusSize;
}
/**
* A customizable menu item component used to display the item portion of a menu.
* This component supports a 'start-icon' `<slot>` that allows for custom icons to be placed at the beginning of the item.
*/
interface ModusWcMenuItem {
"bordered"?: boolean;
/**
* If true, renders a checkbox at the start of the menu item.
*/
"checkbox"?: boolean;
/**
* Public method to collapse the submenu if it's expanded
*/
"collapseSubmenu": () => Promise<void>;
/**
* Custom CSS class to apply to the li element.
* @default ''
*/
"customClass"?: string;
/**
* The disabled state of the menu item.
*/
"disabled"?: boolean;
/**
* The focused state of the menu item.
*/
"focused"?: boolean;
/**
* Whether this menu item has a collapsible submenu. When true, the item will show a caret and handle toggle behavior.
*/
"hasSubmenu"?: boolean;
/**
* The text rendered in the menu item.
* @default ''
*/
"label": string;
/**
* The selected state of the menu item.
*/
"selected"?: boolean;
/**
* The size of the menu item.
* @default 'md'
*/
"size"?: ModusSize;
/**
* The text rendered beneath the label.
*/
"subLabel"?: string;
/**
* The tooltip text to display when hovering over the menu item.
*/
"tooltipContent"?: string;
/**
* The position of the tooltip relative to the menu item.
* @default 'auto'
*/
"tooltipPosition"?: 'auto' | 'top' | 'right' | 'bottom' | 'left';
/**
* The unique identifying value of the menu item.
* @default ''
*/
"value": string;
}
/**
* A customizable modal component used to display content in a dialog.
* This component supports 'header', 'content', and 'footer' `<slot>` elements for inserting custom HTML.
*/
interface ModusWcModal {
/**
* The modal's backdrop. Specify 'static' for a backdrop that doesn't close the modal when clicked outside the modal content.
* @default 'default'
*/
"backdrop"?: 'default' | 'static';
/**
* Custom CSS class to apply
* @default ''
*/
"customClass"?: string;
/**
* Specifies whether the modal should be displayed full-screen
* @default false
*/
"fullscreen"?: boolean;
/**
* The ID of the inner dialog element
*/
"modalId": string;
/**
* Specifies the position of the modal
* @default 'center'
*/
"position"?: 'bottom' | 'center' | 'top';
/**
* Specifies whether to show the close icon button at the top right of modal
* @default true
*/
"showClose"?: boolean;
/**
* Specifies whether to show the fullscreen toggle icon button
* @default false
*/
"showFullscreenToggle"?: boolean;
}
/**
* A customizable navbar component used for top level navigation of all Trimble applications.
*/
interface ModusWcNavbar {
/**
* The open state of the apps menu.
* @default false
*/
"appsMenuOpen"?: boolean;
/**
* Applies condensed layout and styling.
* @default false
*/
"condensed"?: boolean;
/**
* The open state of the condensed menu.
* @default false
*/
"condensedMenuOpen"?: boolean;
/**
* Custom CSS class to apply to the host element.
* @default ''
*/
"customClass"?: string;
/**
* The name of the logo to display. Supports any valid 'logo-name' from the 'modus-wc-logo' component. Defaults to 'trimble'.
* @default 'trimble'
*/
"logoName"?: LogoName;
/**
* The open state of the main menu.
* @default false
*/
"mainMenuOpen"?: boolean;
/**
* The open state of the notifications menu.
* @default false
*/
"notificationsMenuOpen"?: boolean;
/**
* Debounce time in milliseconds for search input changes. Default is 300ms.
* @default 300
*/
"searchDebounceMs"?: number;
/**
* The open state of the search input.
* @default false
*/
"searchInputOpen"?: boolean;
/**
* Text replacements for the navbar.
*/
"textOverrides"?: INavbarTextOverrides;
/**
* User information used to render the user card.
*/
"userCard": INavbarUserCard;
/**
* The open state of the user menu.
* @default false
*/
"userMenuOpen"?: boolean;
/**
* The visibility of individual navbar buttons. Default is user profile visible, others hidden.
* @default { ai: false, apps: false, help: false, logo: true, mainMenu: false, notifications: false, search: false, searchInput: false, user: true, }
*/
"visibility"?: INavbarVisibility;
}
/**
* A customizable input component used to create number inputs with types
*/
interface ModusWcNumberInput {
/**
* Hint for form autofill feature.
*/
"autoComplete"?: 'on' | 'off';
/**
* Indicates that the input should have a border.
* @default true
*/
"bordered"?: boolean;
/**
* The currency symbol to display.
* @default ''
*/
"currencySymbol"?: string;
/**
* Custom CSS class to apply to the input.
* @default ''
*/
"customClass"?: string;
/**
* Whether the form control is disabled.
* @default false
*/
"disabled"?: boolean;
/**
* Feedback to render below the input.
*/
"feedback"?: IInputFeedbackProp;
/**
* The ID of the input element.
*/
"inputId"?: string;
/**
* Determine the control's relative ordering for sequential focus navigation (typically with the Tab key).
*/
"inputTabIndex"?: number;
/**
* The text to display within the label.
*/
"label"?: string;
/**
* The input's maximum value.
*/
"max"?: number;
/**
* The input's minimum value.
*/
"min"?: number;
/**
* Name of the form control. Submitted with the form as part of a name/value pair.
*/
"name"?: string;
/**
* Text that appears in the form control when it has no value set.
* @default ''
*/
"placeholder"?: string;
/**
* Whether the value is editable.
* @default false
*/
"readOnly"?: boolean;
/**
* A value is required for the form to be submittable.
* @default false
*/
"required"?: boolean;
/**
* The size of the input.
* @default 'md'
*/
"size"?: ModusSize;
/**
* The granularity that the value adheres to.
*/
"step"?: number;
/**
* Type of form control.
* @default 'number'
*/
"type"?: 'number' | 'range';
/**
* The value of the control.
* @default ''
*/
"value": string;
}
/**
* Pagination component to navigate through pages of content
*/
interface ModusWcPagination {
/**
* Aria label values for pagination buttons
*/
"ariaLabelValues"?: IAriaLabelValues;
/**
* Total number of pages
* @default 1
*/
"count": number;
/**
* Custom CSS class to apply
* @default ''
*/
"customClass"?: string;
/**
* The next page button text. If not set, an icon control will be used.
*/
"nextButtonText"?: string;
/**
* The current page number
* @default 1
*/
"page": number;
/**
* The previous page button text. If not set, an icon control will be used.
*/
"prevButtonText"?: string;
/**
* Size of the pagination buttons
* @default 'md'
*/
"size": ModusSize;
}
/**
* A customizable panel component used to organize content in a structured layout.
* This component provides 'header', 'body', and 'footer' `<slot>` elements for inserting custom HTML.
*/
interface ModusWcPanel {
/**
* Custom CSS class to apply to the outer div.
* @default ''
*/
"customClass"?: string;
/**
* Enable floating mode with elevated shadow.
* @default false
*/
"floating"?: boolean;
/**
* Height of the panel in pixels.
* @default '700px'
*/
"height"?: string;
/**
* Width of the panel in pixels.
* @default '350px'
*/
"width"?: string;
}
interface ModusWcProfileMenu {
/**
* Configuration for the first menu including title and items
*/
"menuOne"?: ISubMenu;
/**
* Configuration for the second menu including title and items
*/
"menuTwo"?: ISubMenu;
/**
* Profile menu properties containing user information
*/
"profileProps": IProfileMenuProps;
}
/**
* A customizable progress component used to show the progress of a task or show the pa