pixel-react 1.22.4 → 1.22.5

package/lib/index.d.ts

@@ -6142,7 +6142,7 @@ interface TableProps {
 
 declare const StepLandingTable: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<TableProps & React__default.RefAttributes<any>>>;
 
-interface RichTextEditorProps {
+interface RichTextEditorProps$1 {
     convertedContent: string;
     label?: string;
     setConvertedContent: (content: string) => void;
@@ -6161,7 +6161,177 @@ interface RichTextEditorProps {
     onFocus?: (event?: React.FocusEvent<HTMLTextAreaElement>) => void;
 }
 
-declare const TextEditor: FC<RichTextEditorProps>;
+declare const TextEditor: FC<RichTextEditorProps$1>;
+
+type RichTextToolbarOption = 'bold' | 'italic' | 'underline' | 'strike' | 'heading1' | 'heading2' | 'heading3' | 'bulletList' | 'orderedList' | 'blockquote' | 'code' | 'codeBlock' | 'link' | 'image' | 'attachment' | 'undo' | 'redo' | 'clear';
+/**
+ * Uploads an image and resolves with its http(s) URL
+ */
+type RichTextImageUpload = (file: File) => Promise<string>;
+/**
+ * Uploads an attached file and resolves with its http(s) URL
+ */
+type RichTextFileUpload = (file: File) => Promise<string>;
+/**
+ * Why an attached file was not inserted:
+ * - `'type'`: it doesn't match `fileAttachmentAccept`
+ * - `'size'`: it is larger than `maxFileSize`
+ * - `'upload'`: the upload failed or resolved with an unsafe URL
+ */
+type RichTextFileAttachmentError = 'type' | 'size' | 'upload';
+/**
+ * Format of the editor `value` and of the content passed to `onChange`, `onFocus` and `onBlur`
+ */
+type RichTextOutputFormat = 'html' | 'text';
+interface RichTextDynamicValue {
+    /**
+     * Text shown in the suggestion list
+     */
+    label: string;
+    /**
+     * Identifier stored on the token as `data-id` and shown as `{{value}}`
+     */
+    value: string;
+}
+interface RichTextEditorProps {
+    /**
+     * Content of the editor, in the format set by `outputFormat`
+     */
+    value?: string;
+    /**
+     * Format of `value` and of the content passed to `onChange`, `onFocus` and `onBlur`.
+     * - `'html'`: the editor HTML, with formatting
+     * - `'text'`: plain text, one line per block. Formatting, links and images are
+     *   dropped and dynamic values are written as `{{value}}`
+     * @default 'html'
+     */
+    outputFormat?: RichTextOutputFormat;
+    /**
+     * Called with the editor content (see `outputFormat`) and its text character count
+     * whenever the content changes
+     */
+    onChange?: (value: string, charCount: number) => void;
+    /**
+     * Called with the text character count on mount and whenever it changes
+     * (including external `value` updates). Use it to run min/max length
+     * validation in the parent form and pass the result back via `error`/`helperText`
+     */
+    onCharCountChange?: (charCount: number) => void;
+    /**
+     * Label shown above the editor
+     */
+    label?: string;
+    /**
+     * Shows a required asterisk next to the label
+     */
+    required?: boolean;
+    /**
+     * Placeholder shown when the editor is empty
+     */
+    placeholder?: string;
+    /**
+     * Makes the editor non-editable and hides the toolbar
+     */
+    readOnly?: boolean;
+    /**
+     * Hides the toolbar while keeping the editor editable
+     */
+    toolbarHidden?: boolean;
+    /**
+     * Toolbar buttons to show, in order. Defaults to all options
+     */
+    toolbarOptions?: RichTextToolbarOption[];
+    /**
+     * Values offered when the user types `dynamicValueTrigger`. Picking one inserts it
+     * as a token: `<span data-type="dynamicValue" data-id="{value}" data-label="{label}">`.
+     * The feature is disabled (typing the trigger does nothing) when this is empty or omitted
+     */
+    dynamicValues?: RichTextDynamicValue[];
+    /**
+     * Called with the dynamic values present in the content (document order, no duplicates)
+     * on mount and whenever they change, including external `value` updates
+     */
+    onDynamicValuesChange?: (dynamicValues: RichTextDynamicValue[]) => void;
+    /**
+     * Character that opens the dynamic value list
+     * @default '<'
+     */
+    dynamicValueTrigger?: string;
+    /**
+     * Enables inserting images via the toolbar `image` button, paste and drop.
+     * When false, the `image` toolbar option is hidden and pasted/dropped images are ignored
+     * @default false
+     */
+    allowImageUpload?: boolean;
+    /**
+     * Uploads images picked, pasted or dropped into the editor and resolves with their URL.
+     * When omitted, images are embedded in the HTML as base64 data URLs
+     */
+    onImageUpload?: RichTextImageUpload;
+    /**
+     * Enables attaching local files via the toolbar `attachment` button, and via
+     * paste and drop for files that aren't inserted as images. Each file is inserted
+     * as a download chip:
+     * `<a data-type="fileAttachment" href="{url}" data-name="{name}" data-size="{bytes}" download>`.
+     * When false, the `attachment` toolbar option is hidden
+     * @default false
+     */
+    allowFileAttachment?: boolean;
+    /**
+     * Uploads attached files and resolves with their URL. When omitted, files are
+     * embedded in the HTML as base64 data URLs, which only works for images
+     */
+    onFileUpload?: RichTextFileUpload;
+    /**
+     * File types that can be attached, in `accept` attribute syntax
+     * (e.g. `'image/*'`, `'.pdf,.docx'`)
+     * @default 'image/*'
+     */
+    fileAttachmentAccept?: string;
+    /**
+     * Maximum size of an attached file, in bytes
+     */
+    maxFileSize?: number;
+    /**
+     * Called for each attached file that was not inserted, with the reason
+     */
+    onFileAttachmentError?: (file: File, reason: RichTextFileAttachmentError) => void;
+    /**
+     * Applies error styling
+     */
+    error?: boolean;
+    /**
+     * Text shown below the editor (error message when `error` is true)
+     */
+    helperText?: string;
+    /**
+     * Minimum height of the editable area
+     */
+    minHeight?: number | string;
+    /**
+     * Maximum height of the editable area, scrolls beyond this
+     */
+    maxHeight?: number | string;
+    /**
+     * Minimum number of text characters. Shows an error after blur when the
+     * content is non-empty but shorter than this
+     */
+    minLength?: number;
+    /**
+     * Maximum number of text characters. Input beyond this is blocked and a
+     * `count/maxLength` counter is shown below the editor
+     */
+    maxLength?: number;
+    /**
+     * Focuses the editor on mount
+     */
+    autoFocus?: boolean;
+    onFocus?: (value: string) => void;
+    onBlur?: (value: string) => void;
+    className?: string;
+}
+
+declare const RichTextEditor: FC<RichTextEditorProps>;
 
 interface NoDataFoundProps {
     iconName: string;
@@ -6570,5 +6740,5 @@ interface DotLoaderProps {
 
 declare const DotLoader: ({ dotCount, label, labelFontSize, labelFontWeight, dotFontSize, dotFontWeight }: DotLoaderProps) => React$1.JSX.Element;
 
-export { AADHAAR_REGEX, ALPHABET_ONLY_REGEX, ALPHABET_WITH_SPACES_ONLY_REGEX, ALPHANUMERIC_PARENTHESIS_REGEX, ALPHANUMERIC_REGEX, ALPHANUMERIC_WITH_DOT_REGEX, ALPHANUMERIC_WITH_ROUND_BRACES_REGEX, ALPHA_NUM_EXTENDED_REGEX, ALPHA_NUM_REGEX, Accordion, AddContentButton, AddResourceButton, AiToggle, AllProjectsDropdown, AnimatedSetting, AppHeader, AttachMedia, AttachmentButton, AudioPlayer, AutoTruncateText, Avatar, BASE64_REGEX, BIG_END_WHITESPACE, BINARY_NUMBER_REGEX, BODY_TAG_TYPE_VALIDATION, BarChart, Card as Box, BrowserTabs, Button, CAMEL_CASE_REGEX, CERTIFICATES_NAME_REGEX, CHECK_CAMEL_CASE, CREDIT_CARD_REGEX, CURRENCY_GENERIC_REGEX, CardPanel, ChatModal, ChatModalAi, Checkbox, Chip, ChipWithCount, ChooseFile, Col, Comments, ConditionalDropdown, ConnectingBranch, Container, ContentCard, CreateVariableSlider, DATE_REGEX, DECIMAL_NUMBER_REGEX, DRIVING_LICENSE_REGEX, DYNAMIC_VALUE_PATTERN_REGEX, DYNAMIC_VALUE_TYPE_REGEX, DYNAMIC_VALUE_WITH_VALID_BRACKETS_REGEX, DYNAMIC_VALUE__PLACEHOLDER_REGEX, DashboardDonutChart, CustomDatePicker as DatePicker, DebugToolsPanel, DonutChart, DotLoader, DownloadClient, DragAndDrop, Drawer, Dropzone, ELEMENTS_TRAILING_SPACE_REGEX, ELEMENTS_WHITE_SPACE_REGEX, EMAIL_FORMAT_REGEX, EMAIL_REGEX, EMAIL_VALIDATION_REGEX, EXCEL_SPACING_REGEX, EXECUTION_ID_VALIDATION, EditLabel, EditTextField, Editor, ErrorBoundary, ExcelFile as Excel, ExpandableMenu, FILENAME_VALIDATION_REGEX, FILE_EXTENSION_REGEX, FILE_NAME_REGEX, FieldSet, FileDropzone, FilePreview, ForwardedForms as Form, formatString as FormatString, GSTIN_REGEX, HEXADECIMAL_NUMBER_REGEX, HEX_COLOR_REGEX, HSL_COLOR_REGEX, HTML_ATTRIBUTE_REGEX, HTML_FILE_TYPE_VALIDATION, HTML_TAG_REGEX, HighlightText, HistoryCard, INDIAN_CURRENCY_REGEX, INDIAN_PASSPORT_REGEX, INDIAN_PHONE_REGEX, INDIAN_PIN_CODE_REGEX, INTERNATIONAL_PHONE_REGEX, INVALID_EMAIL_REGEX, IPV4_REGEX, IPV6_REGEX, Icon, IconButton, IconRadialChart, IconRadioGroup, Input, InputWithDropdown, JAVASCRIPT_FILE_TYPE_VALIDATION, LINKEDIN_PROFILE_REGEX, LINK_VALIDATION_REGEX, LabelEditTextField, LayoutWithDrawer, LineChart, LineLoader, Link, Loader, MAC_ADDRESS_REGEX, MEMORY_VALIDATION_REGEX, MachineInputField, MediaPreview, MediaViewerModal as MediaViewerModel, MenuOption, MessageBox, MiniModal, MobileSkin, Modal, ModuleChip, MultiRadialChart, MultiSelect, NlpInput as NLPInput, NLP_DESCRIPTION_REGEX, NO_LEADING_TRAILING_SPACE_REGEX, NUMBERS_ONLY_REGEX, NUMBER_REGEX, NetworkErrorBoundary, NoDataAvailable, NoDataContent, NoResultFound, OsTree, OtpVerification, OverviewModal, PAN_CARD_REGEX, PARAMETER_ALPHANUMERIC_REGEX, PASSWORD_COMPLEX_REGEX, PASSWORD_SIMPLE_REGEX, PHONE_REGEX, POSTAL_CODE_REGEX, Paper, PhoneInputField, PieChart, PopUpModal, PrePostTable, ProcessedSourceSelector, ProgressBar, Prompt, PromptContainer, RGB_COLOR_REGEX, ROMAN_NUMERALS_REGEX, RadialChart, RadioButton, RadioGroup, Recaptcha, Row, SCRIPT_REGEX, SERVER_HOST_REGEX, SSN_REGEX, START_END_WHITESPACE_REGEX, STEP_GROUP_NAME_REGEX, ScoreGaugeChart, ScriptGenerationLoader, ScriptSwitchButton, Search, Select, SelectionSwitcher, SequentialConnectingBranch, SessionDropdown, SessionManager, StackedBarChart, StateDropdown, StatusBadge, StatusButton, StatusCard, StatusIndicator, StepLandingTable, StepResultStats, StorageUsageBar, SwitchButton, TIME_REGEX, TWITTER_HANDLE_REGEX, Table, TreeTable as TableTree, TableTreeFn, TableWithAccordion, Tabs, TabsWithSilder, Textarea as TextArea, TextEditor, ThemeProvider, Toaster, Toastify, Toggle, ToggleSwitch, Tooltip, TooltipService, TruncatedTooltip, Typography, UNIT_REGEX, URL_REGEX, USERNAME_REGEX, USERNAME_SPECIAL_REGEX, US_ZIP_CODE_REGEX, UUID_REGEX, VALID_NAME_PATTERN, VEHICLE_REGISTRATION_REGEX, VariableDropdown, VariableInput, VariableSuggestionInputDropDown, WHITESPACE_REGEX, WeightageTable, XML_FILE_TYPE_VALIDATION, ZoomControl, addPrePostStepGroup, addStepGroup, autoScrollToTableLastRow, capitalize, checkEmpty, checkMicrophoneAccess, cleanAllTooltips, clearStore, compareArrays, compareObjects, computeTreeCountsAndFormatNodes, convertFormDataToObject, convertToBytes, convertToGB, convertToISO, copyToClipboard, debounce, deleteStoreValue, ffid, findAndInsert, formatDate, formatResponseDate, getEncryptedData, getExtension, getExtensionWithPeriod, getFiltersFromUrl, getNavigateToKey, getSequentialPayload, getStoreValue, getTopVisibleNodeKey, getTreeDetails, handleTimeZoneChange, handleTreeExpandAllCollapseAll, handleTreeNodeExpandCollapse, handleTreeNodeSect, handleUnCheckAllTreeNodesWithUpdates, hasDuplicateFile, isEmptyObject, isTextTruncated, nlpInputDelay, passesFilters, rearrangeDragItem, restoreSelectedFilters, saveFileFromBlob, scrollToView, setStoreValue, throttle, toCamelCase, toast, toggleShowHideEntity, truncateText, updateSearchTree, updateTreeState, useBeforeUnload, useClickOutside, useDeviceType, useFileDropzone, useKeyboardActions, useTheme, useTriggerControl, validateFileContent };
-export type { RootNode$1 as RootNode, TreeNodeProps, WeightageCellRenderProps, WeightageColumnLabels, WeightageGroup, WeightageRow, WeightageTableProps };
+export { AADHAAR_REGEX, ALPHABET_ONLY_REGEX, ALPHABET_WITH_SPACES_ONLY_REGEX, ALPHANUMERIC_PARENTHESIS_REGEX, ALPHANUMERIC_REGEX, ALPHANUMERIC_WITH_DOT_REGEX, ALPHANUMERIC_WITH_ROUND_BRACES_REGEX, ALPHA_NUM_EXTENDED_REGEX, ALPHA_NUM_REGEX, Accordion, AddContentButton, AddResourceButton, AiToggle, AllProjectsDropdown, AnimatedSetting, AppHeader, AttachMedia, AttachmentButton, AudioPlayer, AutoTruncateText, Avatar, BASE64_REGEX, BIG_END_WHITESPACE, BINARY_NUMBER_REGEX, BODY_TAG_TYPE_VALIDATION, BarChart, Card as Box, BrowserTabs, Button, CAMEL_CASE_REGEX, CERTIFICATES_NAME_REGEX, CHECK_CAMEL_CASE, CREDIT_CARD_REGEX, CURRENCY_GENERIC_REGEX, CardPanel, ChatModal, ChatModalAi, Checkbox, Chip, ChipWithCount, ChooseFile, Col, Comments, ConditionalDropdown, ConnectingBranch, Container, ContentCard, CreateVariableSlider, DATE_REGEX, DECIMAL_NUMBER_REGEX, DRIVING_LICENSE_REGEX, DYNAMIC_VALUE_PATTERN_REGEX, DYNAMIC_VALUE_TYPE_REGEX, DYNAMIC_VALUE_WITH_VALID_BRACKETS_REGEX, DYNAMIC_VALUE__PLACEHOLDER_REGEX, DashboardDonutChart, CustomDatePicker as DatePicker, DebugToolsPanel, DonutChart, DotLoader, DownloadClient, DragAndDrop, Drawer, Dropzone, ELEMENTS_TRAILING_SPACE_REGEX, ELEMENTS_WHITE_SPACE_REGEX, EMAIL_FORMAT_REGEX, EMAIL_REGEX, EMAIL_VALIDATION_REGEX, EXCEL_SPACING_REGEX, EXECUTION_ID_VALIDATION, EditLabel, EditTextField, Editor, ErrorBoundary, ExcelFile as Excel, ExpandableMenu, FILENAME_VALIDATION_REGEX, FILE_EXTENSION_REGEX, FILE_NAME_REGEX, FieldSet, FileDropzone, FilePreview, ForwardedForms as Form, formatString as FormatString, GSTIN_REGEX, HEXADECIMAL_NUMBER_REGEX, HEX_COLOR_REGEX, HSL_COLOR_REGEX, HTML_ATTRIBUTE_REGEX, HTML_FILE_TYPE_VALIDATION, HTML_TAG_REGEX, HighlightText, HistoryCard, INDIAN_CURRENCY_REGEX, INDIAN_PASSPORT_REGEX, INDIAN_PHONE_REGEX, INDIAN_PIN_CODE_REGEX, INTERNATIONAL_PHONE_REGEX, INVALID_EMAIL_REGEX, IPV4_REGEX, IPV6_REGEX, Icon, IconButton, IconRadialChart, IconRadioGroup, Input, InputWithDropdown, JAVASCRIPT_FILE_TYPE_VALIDATION, LINKEDIN_PROFILE_REGEX, LINK_VALIDATION_REGEX, LabelEditTextField, LayoutWithDrawer, LineChart, LineLoader, Link, Loader, MAC_ADDRESS_REGEX, MEMORY_VALIDATION_REGEX, MachineInputField, MediaPreview, MediaViewerModal as MediaViewerModel, MenuOption, MessageBox, MiniModal, MobileSkin, Modal, ModuleChip, MultiRadialChart, MultiSelect, NlpInput as NLPInput, NLP_DESCRIPTION_REGEX, NO_LEADING_TRAILING_SPACE_REGEX, NUMBERS_ONLY_REGEX, NUMBER_REGEX, NetworkErrorBoundary, NoDataAvailable, NoDataContent, NoResultFound, OsTree, OtpVerification, OverviewModal, PAN_CARD_REGEX, PARAMETER_ALPHANUMERIC_REGEX, PASSWORD_COMPLEX_REGEX, PASSWORD_SIMPLE_REGEX, PHONE_REGEX, POSTAL_CODE_REGEX, Paper, PhoneInputField, PieChart, PopUpModal, PrePostTable, ProcessedSourceSelector, ProgressBar, Prompt, PromptContainer, RGB_COLOR_REGEX, ROMAN_NUMERALS_REGEX, RadialChart, RadioButton, RadioGroup, Recaptcha, RichTextEditor, Row, SCRIPT_REGEX, SERVER_HOST_REGEX, SSN_REGEX, START_END_WHITESPACE_REGEX, STEP_GROUP_NAME_REGEX, ScoreGaugeChart, ScriptGenerationLoader, ScriptSwitchButton, Search, Select, SelectionSwitcher, SequentialConnectingBranch, SessionDropdown, SessionManager, StackedBarChart, StateDropdown, StatusBadge, StatusButton, StatusCard, StatusIndicator, StepLandingTable, StepResultStats, StorageUsageBar, SwitchButton, TIME_REGEX, TWITTER_HANDLE_REGEX, Table, TreeTable as TableTree, TableTreeFn, TableWithAccordion, Tabs, TabsWithSilder, Textarea as TextArea, TextEditor, ThemeProvider, Toaster, Toastify, Toggle, ToggleSwitch, Tooltip, TooltipService, TruncatedTooltip, Typography, UNIT_REGEX, URL_REGEX, USERNAME_REGEX, USERNAME_SPECIAL_REGEX, US_ZIP_CODE_REGEX, UUID_REGEX, VALID_NAME_PATTERN, VEHICLE_REGISTRATION_REGEX, VariableDropdown, VariableInput, VariableSuggestionInputDropDown, WHITESPACE_REGEX, WeightageTable, XML_FILE_TYPE_VALIDATION, ZoomControl, addPrePostStepGroup, addStepGroup, autoScrollToTableLastRow, capitalize, checkEmpty, checkMicrophoneAccess, cleanAllTooltips, clearStore, compareArrays, compareObjects, computeTreeCountsAndFormatNodes, convertFormDataToObject, convertToBytes, convertToGB, convertToISO, copyToClipboard, debounce, deleteStoreValue, ffid, findAndInsert, formatDate, formatResponseDate, getEncryptedData, getExtension, getExtensionWithPeriod, getFiltersFromUrl, getNavigateToKey, getSequentialPayload, getStoreValue, getTopVisibleNodeKey, getTreeDetails, handleTimeZoneChange, handleTreeExpandAllCollapseAll, handleTreeNodeExpandCollapse, handleTreeNodeSect, handleUnCheckAllTreeNodesWithUpdates, hasDuplicateFile, isEmptyObject, isTextTruncated, nlpInputDelay, passesFilters, rearrangeDragItem, restoreSelectedFilters, saveFileFromBlob, scrollToView, setStoreValue, throttle, toCamelCase, toast, toggleShowHideEntity, truncateText, updateSearchTree, updateTreeState, useBeforeUnload, useClickOutside, useDeviceType, useFileDropzone, useKeyboardActions, useTheme, useTriggerControl, validateFileContent };
+export type { RichTextDynamicValue, RichTextEditorProps, RichTextFileAttachmentError, RichTextFileUpload, RichTextImageUpload, RichTextOutputFormat, RichTextToolbarOption, RootNode$1 as RootNode, TreeNodeProps, WeightageCellRenderProps, WeightageColumnLabels, WeightageGroup, WeightageRow, WeightageTableProps };