@platform-blocks/ui 0.1.1

package/lib/hooks/index.d.ts

@@ -0,0 +1,6 @@
+export { useHotkeys, useGlobalHotkeys, useEscapeKey, useToggleColorScheme, useSpotlightToggle, globalHotkeys, type HotkeyItem, type KeyboardModifiers, } from './useHotkeys';
+export { useClipboard, type UseClipboardOptions, type UseClipboardReturnValue } from './useClipboard';
+export { useScrollSpy, type ScrollSpyOptions, type UseScrollSpyItem } from './useScrollSpy';
+export { useHaptics, type UseHapticsOptions, type UseHapticsReturn } from './useHaptics';
+export { useMaskedInput, type UseMaskedInputOptions, type UseMaskedInputReturn } from './useMaskedInput';
+export { useTitleRegistration, type UseTitleRegistrationOptions } from './useTitleRegistration';

package/lib/hooks/useClipboard.d.ts

@@ -0,0 +1,20 @@
+export interface UseClipboardOptions {
+    /** Time in ms after which the copied state will reset, 2000 by default */
+    timeout?: number;
+}
+export interface UseClipboardReturnValue {
+    /** Function to copy value to clipboard */
+    copy: (value: any) => Promise<void> | void;
+    /** Function to reset copied state and error */
+    reset: () => void;
+    /** Error if copying failed */
+    error: Error | null;
+    /** Boolean indicating if the value was copied successfully */
+    copied: boolean;
+    /** The last copied value (stringified) */
+    lastValue: string | null;
+    /** True if clipboard API not available */
+    unsupported: boolean;
+}
+export declare function useClipboard(options?: UseClipboardOptions): UseClipboardReturnValue;
+export default useClipboard;

package/lib/hooks/useHaptics.d.ts

@@ -0,0 +1,22 @@
+export interface UseHapticsOptions {
+    /** Whether haptics are disabled */
+    disabled?: boolean;
+    /** Minimum ms between triggers to avoid flood. */
+    throttleMs?: number;
+}
+export interface UseHapticsReturn {
+    /** Light impact when press starts */
+    impactPressIn: () => void;
+    /** A second impact on release (slightly heavier) */
+    impactPressOut: () => void;
+    /** Convenience for success events (e.g., toast show) */
+    notifySuccess: () => void;
+    /** Convenience for warning events */
+    notifyWarning: () => void;
+    /** Convenience for error events */
+    notifyError: () => void;
+    /** Haptic feedback for selection changes */
+    selection: () => void;
+}
+export declare function useHaptics(opts?: UseHapticsOptions): UseHapticsReturn;
+export default useHaptics;

package/lib/hooks/useHotkeys.d.ts

@@ -0,0 +1,42 @@
+export type KeyboardModifiers = {
+    /** Whether the Alt key is pressed */
+    alt?: boolean;
+    /** Whether the Ctrl key is pressed */
+    ctrl?: boolean;
+    /** Whether the Meta (Cmd) key is pressed */
+    meta?: boolean;
+    /** Whether the Shift key is pressed */
+    shift?: boolean;
+};
+export type HotkeyItem = [
+    /** key combination like 'mod+k', 'escape', 'ctrl+j' */
+    string,
+    /** handler function */
+    (event: KeyboardEvent) => void,
+    /** optional modifiers override */
+    KeyboardModifiers?,
+    /** optional description */
+    string[]?
+];
+export declare function useHotkeys(hotkeys: HotkeyItem[], dependencies?: React.DependencyList): void;
+declare class GlobalHotkeyManager {
+    private hotkeys;
+    private isListening;
+    private currentAppState;
+    private appStateSubscription?;
+    private visibilityCleanup?;
+    constructor();
+    register(id: string, hotkey: HotkeyItem): void;
+    unregister(id: string): void;
+    private handleAppStateChange;
+    private isForeground;
+    private syncListening;
+    private handleKeyDown;
+    dispose(): void;
+}
+export declare const globalHotkeys: GlobalHotkeyManager;
+export declare function useGlobalHotkeys(id: string, hotkey: HotkeyItem): void;
+export declare function useEscapeKey(handler: () => void, enabled?: boolean): void;
+export declare function useToggleColorScheme(handler: () => void, enabled?: boolean): void;
+export declare function useSpotlightToggle(handler: () => void, enabled?: boolean): void;
+export {};

package/lib/hooks/useMaskedInput.d.ts

@@ -0,0 +1,35 @@
+import { createMask, MaskDefinition, MaskResult } from '../utils/mask';
+export interface UseMaskedInputOptions {
+    /** The mask definition */
+    mask: MaskDefinition | ReturnType<typeof createMask>;
+    /** Initial value */
+    initialValue?: string;
+    /** Callback when value changes */
+    onValueChange?: (result: MaskResult) => void;
+    /** Callback when unmasked value changes */
+    onUnmaskedValueChange?: (unmaskedValue: string, result: MaskResult) => void;
+}
+export interface UseMaskedInputReturn {
+    /** Current masked value for display */
+    value: string;
+    /** Current unmasked value */
+    unmaskedValue: string;
+    /** Whether the mask is complete */
+    isComplete: boolean;
+    /** Handle text input changes */
+    handleChangeText: (text: string) => void;
+    /** Handle selection change (for cursor positioning) */
+    handleSelectionChange: (selection: {
+        start: number;
+        end: number;
+    }) => void;
+    /** Current cursor position */
+    cursorPosition: number;
+    /** Reset to initial value */
+    reset: () => void;
+    /** Set value programmatically */
+    setValue: (value: string) => void;
+    /** Set unmasked value programmatically */
+    setUnmaskedValue: (unmaskedValue: string) => void;
+}
+export declare function useMaskedInput(options: UseMaskedInputOptions): UseMaskedInputReturn;

package/lib/hooks/useScrollSpy.d.ts

@@ -0,0 +1,38 @@
+export interface ScrollSpyOptions {
+    /** CSS selector for the headings to track */
+    selector?: string;
+    /** Margin around the root element */
+    rootMargin?: string;
+    /** Container to search for headings */
+    container?: string | HTMLElement;
+    /** Function to get heading depth, defaults to h1=1, h2=2, etc. */
+    getDepth?: (el: Element) => number;
+    /** Function to get text value from element, defaults to textContent */
+    getValue?: (el: Element) => string;
+    /** Function to get ID from element, defaults to element ID or generated from text */
+    getId?: (el: Element) => string;
+    /** Disable automatic active ID updates from scroll events */
+    disableAutoUpdate?: boolean;
+}
+export interface TocItem {
+    /** Unique identifier for the heading */
+    id: string;
+    /** Text content of the heading */
+    value: string;
+    /** Heading depth, e.g. 1 for h1, 2 for h2, etc. */
+    depth: number;
+    /** Function to get the underlying DOM node, if available */
+    getNode?: () => HTMLElement | null;
+}
+export interface UseScrollSpyReturn {
+    /** Collected heading items */
+    items: TocItem[];
+    /** Currently active heading ID, or null if none */
+    activeId: string | null;
+    /** Set the active ID programmatically */
+    setActiveId: (id: string | null) => void;
+    /** Re-collect headings and re-initialize the observer */
+    reinitialize: () => void;
+}
+export declare function useScrollSpy(options?: ScrollSpyOptions, initialData?: TocItem[]): UseScrollSpyReturn;
+export type { TocItem as UseScrollSpyItem };

package/lib/hooks/useTitleRegistration.d.ts

@@ -0,0 +1,14 @@
+export interface UseTitleRegistrationOptions {
+    /** Text content of the title */
+    text: string;
+    /** Order for sorting titles, lower numbers appear first */
+    order: number;
+    /** Optional ID, if not provided it will be generated from text */
+    id?: string;
+    /** Whether to automatically register/unregister the title */
+    autoRegister?: boolean;
+}
+export declare const useTitleRegistration: (options: UseTitleRegistrationOptions) => {
+    elementRef: import("react").RefObject<any>;
+    id: string;
+};

package/lib/index.d.ts

@@ -0,0 +1,220 @@
+export { PlatformBlocksProvider } from './core/theme/PlatformBlocksProvider';
+export { HapticsProvider, useHapticsSettings } from './core/haptics/HapticsProvider';
+export { useTheme } from './core/theme/ThemeProvider';
+export { ThemeModeProvider, useThemeMode, type ThemeModeConfig, type ColorSchemeMode } from './core/theme/ThemeModeProvider';
+export { createTheme } from './core/theme/utils';
+export { DEFAULT_THEME } from './core/theme/defaultTheme';
+export { DARK_THEME } from './core/theme/darkTheme';
+export { useColorScheme } from './core/theme/useColorScheme';
+export { I18nProvider, useI18n } from './core/i18n';
+export { OverlayProvider, useOverlay, useOverlayApi, useOverlays } from './core/providers/OverlayProvider';
+export { DirectionProvider, useDirection, useDirectionSafe } from './core/providers/DirectionProvider';
+export type { Direction, DirectionContextValue, DirectionProviderProps, StorageController } from './core/providers/DirectionProvider';
+export { AccessibilityProvider, useAccessibility } from './core/accessibility/context';
+export { SoundProvider, useSound, useHaptics, getAllSounds, getSoundsByCategory, createSound, DEFAULT_SOUND_IDS } from './core/sound';
+export type { SoundAsset, SoundOptions, HapticFeedbackOptions } from './core/sound';
+export { factory, polymorphicFactory } from './core/factory';
+export { TitleRegistryProvider, useTitleRegistry, useTitleRegistryOptional, type TitleItem } from './contexts';
+export { rem, px, getSize, getFontSize, getRadius, getShadow, getColor, debounce, throttle, measurePerformance, measureAsyncPerformance, calculateOverlayPosition, calculateOverlayPositionEnhanced, getViewport, measureElement, pointInRect, getScrollPosition, clearOverlayPositionCache, type Rect, type Viewport, type PositionResult, type PlacementType, type PositioningOptions, } from './core/utils';
+export { usePopoverPositioning, useTooltipPositioning, type UsePopoverPositioningOptions, type UsePopoverPositioningReturn, } from './core/hooks/usePopoverPositioning';
+export { useDropdownPositioning, type UseDropdownPositioningOptions, type UseDropdownPositioningReturn, } from './core/hooks/useDropdownPositioning';
+export { resolveSize, getIconSize, getHeight, getSpacing, getLineHeight, COMPONENT_SIZES, SIZE_SCALES, } from './core/theme/sizes';
+export { DEFAULT_BREAKPOINTS, resolveResponsiveProp } from './core/theme/breakpoints';
+export { useHotkeys, useGlobalHotkeys, useEscapeKey, useToggleColorScheme, useSpotlightToggle, globalHotkeys, } from './hooks';
+export { Container } from './components/Container';
+export { Flex } from './components/Flex';
+export { Grid, GridItem } from './components/Grid';
+export { Masonry } from './components/Masonry';
+export { AppShell, useAppShell, useAppShellApi, useAppShellLayout, AppShellHeader, AppShellNavbar, AppShellAside, AppShellFooter, AppShellBottomNav, AppShellMain, AppShellSection, BottomAppBar, StatusBarManager, useBreakpoint, useNavbarHover, resolveResponsiveValue, defineAppLayout, AppLayoutProvider, AppLayoutRenderer, useAppLayoutContext } from './components/AppShell';
+export { Row, Column } from './components/Layout';
+export { Text, H1, H2, H3, H4, H5, H6, P, Small, Strong, Bold, Italic, Emphasis, Underline, Code, Kbd, Mark, Cite, Sub, Sup } from './components/Text';
+export { ShimmerText } from './components/ShimmerText';
+export { Title, Heading1, Heading2, Heading3, Heading4, Heading5, Heading6 } from './components/Title';
+export { Markdown } from './components/Markdown';
+export { Button } from './components/Button';
+export { BrandButton } from './components/BrandButton';
+export { AppStoreButton, GooglePlayButton, AppleAppStoreButton, MacAppStoreButton, MicrosoftStoreButton, AmazonAppstoreButton, FDroidButton } from './components/AppStoreButton';
+export { AppStoreBadge, AppStoreDownloadBadge, GalaxyStoreDownloadBadge, GooglePlayDownloadBadge, HuaweiAppGalleryBadge, AmazonAppstoreBadge, MicrosoftStoreDownloadBadge, SpotifyListenBadge, ApplePodcastsListenBadge, YouTubeWatchBadge, YouTubeMusicListenBadge, AppleMusicListenBadge, AmazonMusicListenBadge, SoundCloudListenBadge, AmazonStoreBadge, AmazonPrimeVideoBadge, TwitchWatchBadge, GitHubViewBadge, DiscordJoinBadge, RedditJoinBadge, TikTokWatchBadge, ChromeWebStoreBadge, } from './components/AppStoreBadge';
+export { Input, PasswordInput, TextInputBase } from './components/Input';
+export { TextArea } from './components/TextArea';
+export { NumberInput } from './components/NumberInput';
+export { PinInput } from './components/PinInput';
+export { Checkbox } from './components/Checkbox';
+export { Radio, RadioGroup } from './components/Radio';
+export { Switch } from './components/Switch';
+export { ToggleButton, ToggleGroup } from './components/Toggle';
+export { ToggleBar } from './components/Toggle';
+export { SegmentedControl } from './components/SegmentedControl';
+export { Slider, RangeSlider } from './components/Slider';
+export { Search } from './components/Search';
+export { Select } from './components/Select';
+export { AutoComplete } from './components/AutoComplete';
+export { FileInput } from './components/FileInput';
+export { DatePicker, Calendar, MiniCalendar, Month, Day } from './components/DatePicker';
+export { MonthPicker } from './components/MonthPicker';
+export { YearPicker } from './components/YearPicker';
+export { DatePickerInput } from './components/DatePickerInput';
+export { MonthPickerInput } from './components/MonthPickerInput';
+export { YearPickerInput } from './components/YearPickerInput';
+export { TimePicker } from './components/TimePicker';
+export { TimePickerInput } from './components/TimePickerInput';
+export { PhoneInput } from './components/PhoneInput';
+export { ColorPicker } from './components/ColorPicker';
+export { ColorSwatch } from './components/ColorSwatch';
+export { EmojiPicker } from './components/EmojiPicker';
+export { RichTextEditor } from './components/RichTextEditor';
+export { Rating } from './components/Rating';
+export { Form, useFormContext, useOptionalFormContext } from './components/Form';
+export { Breadcrumbs } from './components/Breadcrumbs';
+export { Menu, MenuItem, MenuLabel, MenuDivider, MenuDropdown } from './components/Menu';
+export { MenuItemButton } from './components/MenuItemButton';
+export { Tabs } from './components/Tabs';
+export { Pagination } from './components/Pagination';
+export { Stepper } from './components/Stepper';
+export { Avatar, AvatarGroup } from './components/Avatar';
+export { Badge } from './components/Badge';
+export { Blockquote } from './components/Blockquote';
+export * from './components/Indicator';
+export { Block } from './components/Block';
+export { Card } from './components/Card';
+export { Chip } from './components/Chip';
+export { DataTable } from './components/DataTable';
+export { Disclaimer, ComponentWithDisclaimer, useDisclaimer, withDisclaimer, extractDisclaimerProps } from './components/Disclaimer';
+export { Table } from './components/Table';
+export { Timeline } from './components/Timeline';
+export { ListGroup, ListGroupItem, ListGroupDivider, ListGroupBody } from './components/ListGroup';
+export { TableOfContents } from './components/TableOfContents';
+export { Tree } from './components/Tree';
+export { Alert } from './components/Alert';
+export { Progress } from './components/Progress';
+export { Skeleton } from './components/Skeleton';
+export { Loader } from './components/Loader';
+export { Gauge } from './components/Gauge';
+export { NavigationProgress, navigationProgress } from './components/NavigationProgress';
+export { Toast, ToastProvider, useToast, useToastApi, toast, onToastsRequested } from './components/Toast';
+export { Dialog, DialogProvider, DialogRenderer, useDialog, useDialogApi, useDialogs, useSimpleDialog, onDialogsRequested } from './components/Dialog';
+export { Tooltip } from './components/Tooltip';
+export { Overlay } from './components/Overlay';
+export { LoadingOverlay } from './components/LoadingOverlay';
+export { HoverCard } from './components/HoverCard';
+export { ContextMenu } from './components/ContextMenu';
+export { Spotlight, SpotlightProvider, useSpotlightStore, spotlight, createSpotlightStore, useSpotlightStoreInstance, useDirectSpotlightState, directSpotlight, onSpotlightRequested } from './components/Spotlight';
+export { FloatingActions } from './components/FloatingActions';
+export { Can, CanWithConditions, Cannot, PermissionGate, withCan, withCannot } from './components/Can';
+export { PermissionProvider, usePermissions, useAbility } from './components/Can';
+export { AbilityCore, PermissionBuilder, RoleBuilder, PermissionPatterns, permissions, defineAbility, defineRoleAbility } from './components/Can';
+export { Icon } from './components';
+export { IconButton } from './components/IconButton';
+export { Image } from './components/Image';
+export { BrandIcon } from './components/BrandIcon';
+export { Carousel } from './components/Carousel';
+export { Gallery } from './components/Gallery';
+export { Lottie } from './components/Lottie';
+export { Video } from './components/Video';
+export { Waveform } from './components/Waveform';
+export { Divider } from './components/Divider';
+export { Space } from './components/Space';
+export { Link } from './components/Link';
+export { CodeBlock } from './components/CodeBlock';
+export { CopyButton } from './components/CopyButton/CopyButton';
+export { QRCode } from './components/QRCode';
+export { KeyCap } from './components/KeyCap';
+export { Spoiler } from './components/Spoiler';
+export { PressAnimation, withPressAnimation, AnimatedPressable } from './components/PressAnimation/PressAnimation';
+export { Accordion } from './components/Accordion';
+export type { PlatformBlocksTheme, PlatformBlocksThemeOverride } from './core/theme/types';
+export type { PlatformBlocksProviderProps } from './core/theme/PlatformBlocksProvider';
+export type { ColorScheme } from './core/theme/useColorScheme';
+export type { SizeValue } from './core/theme/sizes';
+export type { ResponsiveProp } from './core/theme/breakpoints';
+export type { HotkeyItem, KeyboardModifiers } from './hooks';
+export type { ButtonProps } from './components/Button';
+export type { BrandButtonProps } from './components/BrandButton';
+export type { AppStoreButtonProps } from './components/AppStoreButton';
+export type { AppStoreBadgeProps, AppStoreBadgeSize, SupportedLocale, BadgeConfig } from './components/AppStoreBadge';
+export type { TreeProps, TreeNode } from './components/Tree';
+export type { TextProps } from './components/Text';
+export type { ShimmerTextProps } from './components/ShimmerText';
+export type { OverlayProps } from './components/Overlay';
+export type { TitleProps } from './components/Title/types';
+export type { ContainerProps } from './components/Container';
+export type { FlexProps } from './components/Flex';
+export type { GridProps, GridItemProps } from './components/Grid';
+export type { MasonryProps, MasonryItem } from './components/Masonry';
+export type { InputProps, PasswordInputProps } from './components/Input';
+export type { NumberInputProps } from './components/NumberInput';
+export type { PinInputProps } from './components/PinInput';
+export type { CheckboxProps } from './components/Checkbox';
+export type { RadioProps, RadioGroupProps } from './components/Radio';
+export type { SwitchProps } from './components/Switch';
+export type { ToggleButtonProps, ToggleGroupProps } from './components/Toggle';
+export type { ToggleBarProps, ToggleBarOption } from './components/Toggle/ToggleBar';
+export type { SegmentedControlProps, SegmentedControlItem, SegmentedControlData } from './components/SegmentedControl';
+export type { SliderProps, RangeSliderProps } from './components/Slider';
+export type { SearchProps } from './components/Search';
+export type { SelectProps } from './components/Select';
+export type { AutoCompleteProps } from './components/AutoComplete';
+export type { FileInputProps, FileInputFile } from './components/FileInput';
+export type { DatePickerProps, CalendarProps, MiniCalendarProps } from './components/DatePicker';
+export type { MonthPickerProps } from './components/MonthPicker';
+export type { YearPickerProps } from './components/YearPicker';
+export type { DatePickerInputProps } from './components/DatePickerInput';
+export type { MonthPickerInputProps } from './components/MonthPickerInput';
+export type { YearPickerInputProps } from './components/YearPickerInput';
+export type { TimePickerProps, TimePickerValue } from './components/TimePicker/types';
+export type { TimePickerInputProps } from './components/TimePickerInput';
+export type { PhoneInputProps } from './components/PhoneInput';
+export type { ColorPickerProps } from './components/ColorPicker';
+export type { EmojiPickerProps } from './components/EmojiPicker';
+export type { RichTextEditorProps, RichTextEditorContent, RichTextEditorFormat, RichTextEditorSelection } from './components/RichTextEditor';
+export type { RatingProps } from './components/Rating';
+export type { FormProps } from './components/Form';
+export type { BreadcrumbsProps } from './components/Breadcrumbs';
+export type { MenuProps, MenuItemProps } from './components/Menu';
+export type { TabsProps, TabItem } from './components/Tabs';
+export type { PaginationProps } from './components/Pagination';
+export type { StepperProps } from './components/Stepper';
+export type { AvatarProps, AvatarGroupProps } from './components/Avatar';
+export type { BadgeProps } from './components/Badge';
+export type { IndicatorProps } from './components/Indicator';
+export type { CardProps } from './components/Card';
+export type { ChipProps } from './components/Chip';
+export type { DataTableProps, DataTableColumn, DataTableSort, DataTablePagination } from './components/DataTable';
+export type { DisclaimerProps, WithDisclaimerProps, ComponentWithDisclaimerProps, DisclaimerSupport } from './components/Disclaimer';
+export type { TableProps } from './components/Table';
+export type { TimelineProps } from './components/Timeline';
+export type { TableOfContentsProps } from './components/TableOfContents';
+export type { AlertProps } from './components/Alert';
+export type { ProgressProps } from './components/Progress';
+export type { SkeletonProps } from './components/Skeleton';
+export type { LoaderProps } from './components/Loader';
+export type { LoadingOverlayProps } from './components/LoadingOverlay';
+export type { GaugeProps } from './components/Gauge';
+export type { ToastProps } from './components/Toast';
+export type { DialogProps, DialogConfig, UseSimpleDialogOptions } from './components/Dialog';
+export type { TooltipProps } from './components/Tooltip';
+export type { HoverCardProps } from './components/HoverCard';
+export type { ContextMenuProps } from './components/ContextMenu';
+export type { SpotlightProps } from './components/Spotlight';
+export type { Action, Subject, Field, Conditions, PermissionRule, PermissionCheck, Ability, CanProps, CanWithConditionsProps, CannotProps, PermissionGateProps, PermissionContextValue, PermissionProviderProps, UsePermissionsOptions } from './components/Can';
+export type { BrandIconProps, BrandName } from './components/BrandIcon';
+export type { IconButtonProps } from './components/IconButton';
+export type { CarouselProps } from './components/Carousel';
+export type { GalleryProps, GalleryItem } from './components/Gallery';
+export type { LottieProps } from './components/Lottie';
+export type { WaveformProps } from './components/Waveform';
+export type { DividerProps } from './components/Divider';
+export type { SpaceProps } from './components/Space';
+export type { LinkProps } from './components/Link';
+export type { CodeBlockProps } from './components/CodeBlock';
+export type { CopyButtonProps } from './components/CopyButton/types';
+export type { QRCodeProps } from './components/QRCode';
+export type { KeyCapProps } from './components/KeyCap';
+export type { SpoilerProps } from './components/Spoiler';
+export type { FloatingActionsProps, FloatingActionItem } from './components/FloatingActions';
+export type { PressAnimationProps } from './components/PressAnimation/PressAnimation';
+export type { AccordionProps } from './components/Accordion';
+export type { MarkdownProps, MarkdownComponentMap } from './components/Markdown';
+export type { AppShellProps } from './components/AppShell';
+export type { AppShellBottomNavProps, BottomAppBarItem } from './components/AppShell';
+export type { AppLayoutBlueprint, AppLayoutRuntimeContext, AppLayoutRuntimeOverrides, LayoutEntry, LayoutComponentEntry, LayoutNavbarConfig, LayoutAsideConfig, LayoutFooterConfig, LayoutBottomNavConfig, LayoutMainConfig, LayoutOptions, LayoutSection, } from './components/AppShell';

package/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export { createMask, PHONE_MASKS, COMMON_MASKS, type MaskDefinition, type MaskResult } from './mask';

package/lib/utils/mask.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Advanced input masking utility inspired by react-imask
+ * Provides flexible pattern-based input formatting with proper cursor handling
+ */
+export interface MaskDefinition {
+    /** The mask pattern (e.g., '(000) 000-0000', '+1 000 000 0000') */
+    mask: string;
+    /** Placeholder character for unfilled positions */
+    placeholderChar?: string;
+    /** Whether to show the mask when input is empty */
+    showMask?: boolean;
+    /** Custom definitions for mask characters */
+    definitions?: Record<string, RegExp>;
+    /** Whether to allow incomplete input */
+    lazy?: boolean;
+}
+export interface MaskResult {
+    /** The masked/formatted value */
+    value: string;
+    /** The unmasked/raw value */
+    unmaskedValue: string;
+    /** Whether the mask is complete */
+    isComplete: boolean;
+    /** Current cursor position after formatting */
+    cursorPosition: number;
+}
+/**
+ * Creates a masking function for the given pattern
+ */
+export declare function createMask(definition: MaskDefinition): {
+    applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+    getDisplayValue: (value: string) => string;
+    processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+    pattern: {
+        char: string;
+        isFixed: boolean;
+        regex?: RegExp;
+    }[];
+    definition: MaskDefinition;
+};
+/**
+ * Phone number specific masking presets
+ */
+export declare const PHONE_MASKS: {
+    US: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+    US_WITH_COUNTRY: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+    UK: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+    INTERNATIONAL: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+};
+/**
+ * Other useful mask presets
+ */
+export declare const COMMON_MASKS: {
+    CREDIT_CARD: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+    DATE: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+    SSN: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+    ZIP_CODE: {
+        applyMask: (inputValue: string, previousValue?: string, cursorPos?: number) => MaskResult;
+        getDisplayValue: (value: string) => string;
+        processInput: (newValue: string, oldValue: string, selectionStart?: number) => MaskResult;
+        pattern: {
+            char: string;
+            isFixed: boolean;
+            regex?: RegExp;
+        }[];
+        definition: MaskDefinition;
+    };
+};