@commercetools/nimbus 0.0.13-rc1 → 0.0.14-rc1

package/dist/constants.d.ts

@@ -0,0 +1,129 @@
+export declare const BASIC_FORMATTING: readonly ["strikethrough", "code"];
+
+export declare type BasicFormattingType = (typeof BASIC_FORMATTING)[number];
+
+export declare const BLOCK_TAGS: {
+    readonly blockquote: "block-quote";
+    readonly p: "paragraph";
+    readonly pre: "code";
+    readonly h1: "heading-one";
+    readonly h2: "heading-two";
+    readonly h3: "heading-three";
+    readonly h4: "heading-four";
+    readonly h5: "heading-five";
+    readonly ul: "bulleted-list";
+    readonly ol: "numbered-list";
+    readonly li: "list-item";
+    readonly a: "link";
+};
+
+export declare type BlockTagKey = keyof typeof BLOCK_TAGS;
+
+export declare type BlockTagValue = (typeof BLOCK_TAGS)[BlockTagKey];
+
+export declare type BlockType = (typeof blockTypes)[number] | "paragraph";
+
+/**
+ * Available block types for text style detection
+ *
+ * Used by:
+ * - hooks/useToolbarState.ts: Detects currently active block type in editor
+ * - Excludes "paragraph" as it's the default/fallback type
+ */
+export declare const blockTypes: readonly ["heading-one", "heading-two", "heading-three", "heading-four", "heading-five", "block-quote"];
+
+export declare const EDITOR_DEFAULTS: {
+    readonly placeholder: "Start typing...";
+    readonly isDisabled: false;
+    readonly isReadOnly: false;
+    readonly autoFocus: false;
+};
+
+export declare const FORMATTING_OPTIONS: {
+    readonly STRIKETHROUGH: "strikethrough";
+    readonly CODE: "code";
+    readonly SUPERSCRIPT: "superscript";
+    readonly SUBSCRIPT: "subscript";
+};
+
+export declare type FormattingType = (typeof FORMATTING_OPTIONS)[keyof typeof FORMATTING_OPTIONS];
+
+export declare type HotkeyKey = keyof HotkeyType;
+
+/**
+ * Constants for the rich text editor component
+ *
+ * This file consolidates all the configuration constants used by the rich text editor.
+ * Previously split across multiple files, now consolidated for better maintainability.
+ */
+export declare const HOTKEYS: {
+    readonly "mod+b": "bold";
+    readonly "mod+i": "italic";
+    readonly "mod+u": "underline";
+    readonly "mod+`": "code";
+};
+
+export declare type HotkeyType = typeof HOTKEYS;
+
+export declare type HotkeyValue = HotkeyType[HotkeyKey];
+
+export declare const MARK_TAGS: {
+    readonly strong: "bold";
+    readonly b: "bold";
+    readonly em: "italic";
+    readonly i: "italic";
+    readonly u: "underline";
+    readonly code: "code";
+    readonly sup: "superscript";
+    readonly sub: "subscript";
+    readonly del: "strikethrough";
+    readonly s: "strikethrough";
+};
+
+export declare type MarkTagKey = keyof typeof MARK_TAGS;
+
+export declare type MarkTagValue = (typeof MARK_TAGS)[MarkTagKey];
+
+export declare const MUTUALLY_EXCLUSIVE_GROUPS: {
+    readonly script: readonly ["superscript", "subscript"];
+};
+
+export declare const SCRIPT_FORMATTING: readonly ["superscript", "subscript"];
+
+export declare type ScriptFormattingType = (typeof SCRIPT_FORMATTING)[number];
+
+/**
+ * Text style definitions for rich text editor block formatting
+ *
+ * Used by:
+ * - components/rich-text-toolbar.tsx: Renders text style dropdown menu with these options
+ * - hooks/useToolbarState.ts: Manages current text style state and selection logic
+ * - utils/text-style-utils.ts: Helper functions for text style operations
+ * - utils/validation-utils.ts: Validates if block types are supported
+ *
+ * Purpose:
+ * - Centralizes all available text styles and their visual properties
+ * - Maps block type IDs to user-friendly labels and Chakra UI styling props
+ * - Ensures consistent styling across the editor and UI controls
+ */
+export declare interface TextStyleDefinition {
+    id: string;
+    label: string;
+    props: {
+        textStyle: string;
+        fontWeight: string;
+    };
+}
+
+export declare const textStyles: TextStyleDefinition[];
+
+export { }
+
+
+declare module "slate" {
+    interface CustomTypes {
+        Editor: BaseEditor & ReactEditor & HistoryEditor;
+        Element: CustomElement;
+        Text: CustomText;
+    }
+}