@eigenpal/docx-editor-react/dialogs
Modal dialogs for hyperlinks, find/replace, paste-special, page setup, and keyboard shortcuts. Pair with the hooks under @eigenpal/docx-editor-react/hooks when wiring custom UI.
Functions (26)
createBookmarkLinkDatafunctionSource ↗
Create HyperlinkData for an internal bookmark
declare function createBookmarkLinkData(bookmark: string, displayText?: string): HyperlinkData;createHyperlinkDatafunctionSource ↗
Create HyperlinkData from a URL string
declare function createHyperlinkData(url: string, displayText?: string): HyperlinkData;emailToMailtofunctionSource ↗
Convert email address to mailto: link
declare function emailToMailto(email: string): string;extractBookmarksForDialogfunctionSource ↗
Extract bookmarks from document for the dialog
declare function extractBookmarksForDialog(bookmarks: {
name: string;
id: number;
}[]): BookmarkOption[];FindReplaceDialogfunctionSource ↗
FindReplaceDialog component - Modal for finding and replacing text
declare function FindReplaceDialog(input: FindReplaceDialogProps): React__default.ReactElement | null;formatShortcutKeysfunctionSource ↗
Format key combination for current platform
declare function formatKeys(keys: string): string;getAllCategoriesfunctionSource ↗
Get all categories
declare function getAllCategories(): ShortcutCategory[];getAllPasteOptionsfunctionSource ↗
Get all paste option definitions
declare function getAllPasteOptions(): PasteOptionDef[];getCategoryLabelfunctionSource ↗
Get category label translation key
declare function getCategoryLabel(category: ShortcutCategory): string;getCommonShortcutsfunctionSource ↗
Get common/frequently used shortcuts
declare function getCommonShortcuts(): KeyboardShortcut[];getDefaultPasteOptionfunctionSource ↗
Get default paste option
declare function getDefaultPasteOption(): PasteOption;getDefaultShortcutsfunctionSource ↗
Get all default shortcuts
declare function getDefaultShortcuts(): KeyboardShortcut[];getDisplayTextfunctionSource ↗
Get display text from HyperlinkData, falling back to URL/bookmark
declare function getDisplayText(data: HyperlinkData): string;getPasteOptionfunctionSource ↗
Get paste option definition by id
declare function getPasteOption(id: PasteOption): PasteOptionDef | undefined;getShortcutsByCategoryfunctionSource ↗
Get shortcuts by category
declare function getShortcutsByCategory(category: ShortcutCategory): KeyboardShortcut[];getUrlTypefunctionSource ↗
Detect URL type from string
declare function getUrlType(url: string): 'web' | 'email' | 'phone' | 'ftp' | 'unknown';HyperlinkDialogfunctionSource ↗
HyperlinkDialog component - Modal for inserting/editing hyperlinks
declare function HyperlinkDialog(input: HyperlinkDialogProps): React__default.ReactElement | null;isBookmarkHyperlinkDatafunctionSource ↗
Check if HyperlinkData is for an internal bookmark
declare function isBookmarkHyperlinkData(data: HyperlinkData): boolean;isExternalHyperlinkDatafunctionSource ↗
Check if HyperlinkData is for an external URL
declare function isExternalHyperlinkData(data: HyperlinkData): boolean;isPasteSpecialShortcutfunctionSource ↗
Check if paste special shortcut
declare function isPasteSpecialShortcut(event: KeyboardEvent): boolean;isValidUrlfunctionSource ↗
Validate a URL string Supports http, https, mailto, tel, ftp protocols
declare function isValidUrl(url: string): boolean;normalizeUrlfunctionSource ↗
Normalize a URL by adding protocol if needed
declare function normalizeUrl(url: string): string;PageSetupDialogfunctionSource ↗
declare function PageSetupDialog(input: PageSetupDialogProps): React__default.ReactElement | null;phoneToTelfunctionSource ↗
Convert phone number to tel: link
declare function phoneToTel(phone: string): string;useKeyboardShortcutsDialogfunctionSource ↗
Hook to manage keyboard shortcuts dialog
declare function useKeyboardShortcutsDialog(options?: UseKeyboardShortcutsDialogOptions): UseKeyboardShortcutsDialogReturn;usePasteSpecialfunctionSource ↗
Hook to manage paste special dialog
declare function usePasteSpecial(options?: UsePasteSpecialOptions): UsePasteSpecialReturn;Interfaces (12)
BookmarkOptioninterfaceSource ↗
Bookmark option for internal link selection
interface BookmarkOption| Member | Type | Summary |
|---|---|---|
| label? | string | Optional display label |
| name | string | Bookmark name/ID |
FindReplaceDialogPropsinterfaceSource ↗
Props for the FindReplaceDialog component
interface FindReplaceDialogProps| Member | Type | Summary |
|---|---|---|
| className? | string | Additional CSS class |
| currentResult? | FindResult | null | Current match result (from external state) |
| initialSearchText? | string | Initial search text (e.g., from selected text) |
| isOpen | boolean | Whether the dialog is open |
| onClearHighlights? | () => void | Callback to clear highlights |
| onClose | () => void | Callback when dialog is closed |
| onFind | (searchText: string, options: FindOptions) => FindResult | null | Callback when searching for text |
| onFindNext | () => FindMatch | null | Callback when navigating to next match |
| onFindPrevious | () => FindMatch | null | Callback when navigating to previous match |
| onHighlightMatches? | (matches: FindMatch[]) => void | Callback to highlight matches in document |
| onReplace | (replaceText: string) => boolean | Callback when replacing current match |
| onReplaceAll | (searchText: string, replaceText: string, options: FindOptions) => number | Callback when replacing all matches |
| replaceMode? | boolean | Whether to start in replace mode |
| style? | CSSProperties | Additional inline styles |
HyperlinkDatainterfaceSource ↗
Hyperlink data structure for dialog
interface HyperlinkData| Member | Type | Summary |
|---|---|---|
| bookmark? | string | Internal bookmark name |
| displayText? | string | Display text for the link |
| tooltip? | string | Tooltip text |
| url? | string | URL for external link |
HyperlinkDialogPropsinterfaceSource ↗
Props for the HyperlinkDialog component
interface HyperlinkDialogProps| Member | Type | Summary |
|---|---|---|
| bookmarks? | BookmarkOption[] | Available bookmarks for internal links |
| className? | string | Additional CSS class |
| initialData? | HyperlinkData | Initial data for editing existing hyperlink |
| isEditing? | boolean | Whether we're editing an existing hyperlink |
| isOpen | boolean | Whether the dialog is open |
| onClose | () => void | Callback when dialog is closed |
| onRemove? | () => void | Callback when hyperlink is removed |
| onSubmit | (data: HyperlinkData) => void | Callback when hyperlink is inserted/updated |
| selectedText? | string | Currently selected text (used as default display text) |
| style? | CSSProperties | Additional inline styles |
KeyboardShortcutinterfaceSource ↗
Keyboard shortcut definition
interface KeyboardShortcut| Member | Type | Summary |
|---|---|---|
| altKeys? | string | Alternative key combination |
| category | ShortcutCategory | Category for grouping |
| common? | boolean | Whether this is a common/frequently used shortcut |
| description | string | Description of what the shortcut does |
| descriptionKey? | TranslationKey | Translation key for description (used internally) |
| id | string | Unique identifier |
| keys | string | Primary key combination (e.g., 'Ctrl+C') |
| name | string | Display name |
| nameKey? | TranslationKey | Translation key for display name (used internally) |
KeyboardShortcutsDialogPropsinterfaceSource ↗
Dialog props
interface KeyboardShortcutsDialogProps| Member | Type | Summary |
|---|---|---|
| className? | string | Additional className |
| customShortcuts? | KeyboardShortcut[] | Custom shortcuts (merged with defaults) |
| isOpen | boolean | Whether the dialog is open |
| onClose | () => void | Close callback |
| showSearch? | boolean | Whether to show search |
PageSetupDialogPropsinterfaceSource ↗
Page Setup Dialog
Modal for editing page layout properties: - Page size (Letter, A4, Legal, etc.) - Orientation (portrait/landscape) - Margins (top, bottom, left, right) in inches
interface PageSetupDialogProps| Member | Type | Summary |
|---|---|---|
| currentProps? | SectionProperties | |
| isOpen | boolean | |
| onApply | (props: Partial<SectionProperties>) => void | |
| onClose | () => void |
PasteSpecialDialogPropsinterfaceSource ↗
Paste special dialog props
interface PasteSpecialDialogProps| Member | Type | Summary |
|---|---|---|
| className? | string | Additional className |
| isOpen | boolean | Whether the dialog is open |
| onClose | () => void | Callback when dialog is closed |
| onPaste | (content: ParsedClipboardContent, asPlainText: boolean) => void | Callback when paste is confirmed |
| position? | {
x: number;
y: number;
} | Optional custom position |
UseKeyboardShortcutsDialogOptionsinterfaceSource ↗
Hook options
interface UseKeyboardShortcutsDialogOptions| Member | Type | Summary |
|---|---|---|
| enabled? | boolean | Whether the dialog can be opened with Ctrl+? or F1 |
| openShortcut? | string | Custom open shortcut (default: Ctrl+/) |
UseKeyboardShortcutsDialogReturninterfaceSource ↗
Hook return value
interface UseKeyboardShortcutsDialogReturn| Member | Type | Summary |
|---|---|---|
| close | () => void | Close the dialog |
| handleKeyDown | (event: KeyboardEvent) => void | Keyboard event handler |
| isOpen | boolean | Whether dialog is open |
| open | () => void | Open the dialog |
| toggle | () => void | Toggle the dialog |
UsePasteSpecialOptionsinterfaceSource ↗
Options for usePasteSpecial hook
interface UsePasteSpecialOptions| Member | Type | Summary |
|---|---|---|
| enabled? | boolean | Whether paste operations are enabled |
| onPaste? | (content: ParsedClipboardContent, asPlainText: boolean) => void | Callback when paste is confirmed |
UsePasteSpecialReturninterfaceSource ↗
Hook return value for paste special
interface UsePasteSpecialReturn| Member | Type | Summary |
|---|---|---|
| closeDialog | () => void | Close the dialog |
| handleKeyDown | (event: KeyboardEvent) => boolean | Handle keyboard shortcut (Ctrl+Shift+V) |
| isOpen | boolean | Whether the dialog is open |
| openDialog | () => void | Open the paste special dialog |
| pasteAsPlainText | () => Promise<void> | Paste as plain text directly |
Type aliases (2)
PasteOptiontypeSource ↗
Paste option type
type PasteOption = 'formatted' | 'plainText';ShortcutCategorytypeSource ↗
Shortcut category
type ShortcutCategory = 'editing' | 'formatting' | 'navigation' | 'clipboard' | 'selection' | 'view' | 'file' | 'other';Variables (2)
KeyboardShortcutsDialogconstSource ↗
KeyboardShortcutsDialog: React__default.FC<KeyboardShortcutsDialogProps>PasteSpecialDialogconstSource ↗
PasteSpecialDialog: React__default.FC<PasteSpecialDialogProps>