@turnix-co/konva-editor 3.0.1 → 3.0.3

package/dist/index.d.ts

@@ -13,6 +13,10 @@ type CanvasProps = {
     onSelectionChange?: (selectedId: string | null) => void;
     onTextEditingReady?: (startEditingFn: (textId: string) => void) => void;
     onDirectDrawingCanvasReady?: (canvasRef: React$1.RefObject<HTMLCanvasElement | null>) => void;
+    /** Context menu configuration - controls right-click menu behavior */
+    contextMenuConfig?: {
+        enabled: boolean;
+    };
 };
 declare const Canvas: React$1.FC<CanvasProps>;
 
@@ -416,12 +420,17 @@ type SlideHistory = {
     past: Slide[];
     future: Slide[];
 };
+type PresentationMetadata = {
+    title: string;
+    description: string;
+};
 type CanvasState = {
     slides: Slide[];
     currentSlideId: string;
     history: Record<string, SlideHistory>;
     isSketchMode: boolean;
     editingTextId: string | null;
+    presentationMetadata: PresentationMetadata;
 };
 declare const createEmptySlide: (name?: string) => Slide;
 declare const addSlide: _reduxjs_toolkit.ActionCreatorWithoutPayload<"canvas/addSlide">;
@@ -597,6 +606,12 @@ declare const saveToHistory: _reduxjs_toolkit.ActionCreatorWithoutPayload<"canva
 declare const toggleSketchMode: _reduxjs_toolkit.ActionCreatorWithoutPayload<"canvas/toggleSketchMode">;
 declare const setSketchMode: _reduxjs_toolkit.ActionCreatorWithOptionalPayload<boolean, "canvas/setSketchMode">;
 declare const setEditingTextId: _reduxjs_toolkit.ActionCreatorWithOptionalPayload<string, "canvas/setEditingTextId">;
+declare const setPresentationTitle: _reduxjs_toolkit.ActionCreatorWithOptionalPayload<string, "canvas/setPresentationTitle">;
+declare const setPresentationDescription: _reduxjs_toolkit.ActionCreatorWithOptionalPayload<string, "canvas/setPresentationDescription">;
+declare const loadPresentationMetadata$1: _reduxjs_toolkit.ActionCreatorWithOptionalPayload<{
+    title: string;
+    description: string;
+}, "canvas/loadPresentationMetadata">;
 
 declare const selectCurrentSlideId: (state: {
     canvas: CanvasState;
@@ -613,6 +628,9 @@ declare const selectCanAddSlide: (state: {
 declare const selectSlideById: (slideId: string) => (state: {
     canvas: CanvasState;
 }) => Slide;
+declare const selectPresentationMetadata: (state: {
+    canvas: CanvasState;
+}) => PresentationMetadata;
 
 interface PublishProgress {
     current: number;
@@ -626,38 +644,29 @@ interface PublishResponse {
     url?: string;
 }
 interface PublishButtonProps {
-    onPublish?: (slides: Slide[], onProgress?: (progress: PublishProgress) => void) => Promise<PublishResponse>;
+    onPublish?: (slides: Slide[], metadata: PresentationMetadata, onProgress?: (progress: PublishProgress) => void) => Promise<PublishResponse>;
     label?: string;
     className?: string;
 }
 declare const PublishButton: React$1.FC<PublishButtonProps>;
 
 type TopNavBarProps = {
-    /** Title displayed in the header */
     title?: string;
-    /** Auto-save status message */
     autoSaveMessage?: string;
-    /** Callback when back button is clicked */
     onBack?: () => void;
-    /** Callback when settings button is clicked */
     onSettings?: () => void;
-    /** Callback when user/profile button is clicked */
     onProfile?: () => void;
-    /** Function to publish slides (passed to PublishButton) */
     onPublish?: PublishButtonProps['onPublish'];
-    /** Whether to show the publish button */
+    onTitleChange?: (newTitle: string) => void;
+    onDescriptionChange?: (newDescription: string) => void;
     showPublishButton?: boolean;
-    /** Whether to show the settings button */
     showSettingsButton?: boolean;
-    /** Whether to show the profile button */
     showProfileButton?: boolean;
-    /** Whether to show the back button */
     showBackButton?: boolean;
-    /** Custom class name for the container */
+    editableTitle?: boolean;
+    editableDescription?: boolean;
     className?: string;
-    /** Custom content to render on the right side (replaces default buttons) */
     rightContent?: React$1.ReactNode;
-    /** Custom content to render on the left side (replaces default content) */
     leftContent?: React$1.ReactNode;
 };
 declare const TopNavBar: React$1.FC<TopNavBarProps>;
@@ -729,6 +738,7 @@ declare const store: _reduxjs_toolkit.EnhancedStore<{
         }>;
         isSketchMode: boolean;
         editingTextId: string | null;
+        presentationMetadata: PresentationMetadata;
     };
 }, redux.UnknownAction, _reduxjs_toolkit.Tuple<[redux.StoreEnhancer<{
     dispatch: redux_thunk.ThunkDispatch<{
@@ -742,6 +752,7 @@ declare const store: _reduxjs_toolkit.EnhancedStore<{
             }>;
             isSketchMode: boolean;
             editingTextId: string | null;
+            presentationMetadata: PresentationMetadata;
         };
     }, undefined, redux.UnknownAction>;
 }>, redux.StoreEnhancer]>>;
@@ -884,11 +895,14 @@ declare const useDispatch: () => redux_thunk.ThunkDispatch<{
         }>;
         isSketchMode: boolean;
         editingTextId: string | null;
+        presentationMetadata: PresentationMetadata;
     };
 }, undefined, redux.UnknownAction> & redux.Dispatch<redux.UnknownAction>;
 declare const useSelector: <T>(selector: (state: RootState) => T) => T;
 
-declare const useSlidesPersistence: () => void;
+declare const useSlidesPersistence: () => {
+    isLoading: boolean;
+};
 
 /**
  * Configuration options for loading initial slides
@@ -937,5 +951,7 @@ type SlidesPayload = {
 declare const loadFromIndexedDB: () => Promise<Slide[] | null>;
 declare const clearLocalData: () => Promise<void>;
 declare const loadCurrentSlideId: () => string | null;
+declare const savePresentationMetadata: (metadata: PresentationMetadata) => Promise<void>;
+declare const loadPresentationMetadata: () => Promise<PresentationMetadata | null>;
 
-export { type ActionType, type ActivityType, type AppDispatch, BASIC_EDITOR_TOOLBAR_CONFIG, BottomToolbar, type BottomToolbarProps, Canvas, type CanvasProps, type ContextMenuConfig, DEFAULT_CONTEXT_MENU_CONFIG, DEFAULT_TOOLBAR_CONFIG, EditorRoot, type EditorRootProps, type ExportOptions, type FillInTheBlanks, type FlashcardElement, type ImageElement, type InitialSlidesConfig, type Line$1 as Line, type LongAnswer, type MediaType, type MultipleChoice, type PhotoFrameElement, type PreparedImageElement, type PreparedPhotoFrameElement, type PreparedSlide, type PreparedVideoElement, PublishButton, type PublishButtonProps, type PublishPayload, type PublishProgress, type PublishResponse, type RootState, ScreenRecorder, type Shape, type ShapeType, type ShortAnswer, type Slide, SlideNavigation, type SlidesPayload, type TextElement, type ToolType, Toolbar, type ToolbarActionsConfig, type ToolbarConfig, type ToolbarProps, type ToolbarToolsConfig, TopNavBar, type TopNavBarProps, type TrueFalse, VIEWER_TOOLBAR_CONFIG, type VideoElement, addFillInTheBlanks, addFlashcard, addImage, addImageAnnotation, addLine, addLongAnswer, addMultipleChoice, addPhotoFrame, addPhotoFrameAnnotation, addShape, addShortAnswer, addSlide, addText, addTrueFalse, addVideo, arrayBufferToBase64, bringToFront, clearCanvas, clearImageAnnotations, clearLocalData, clearPhotoFrameAnnotations, createEmptySlide, deleteFillInTheBlanks, deleteFlashcard, deleteImage, deleteLineById, deleteLongAnswer, deleteMultipleChoice, deletePhotoFrame, deleteShape, deleteShortAnswer, deleteSlide, deleteText, deleteTrueFalse, deleteVideo, duplicateFillInTheBlanks, duplicateFlashcard, duplicateImage, duplicateLine, duplicateLongAnswer, duplicateMultipleChoice, duplicatePhotoFrame, duplicateShape, duplicateShortAnswer, duplicateSlide, duplicateText, duplicateTrueFalse, duplicateVideo, editFlashcard, editMultipleChoice, exportSlideAsBlob, exportSlideAsImage, finalizeDrawing, getCompressionStats, getSlideDataURL, loadCurrentSlideId, loadFromIndexedDB, loadSlides, mergeToolbarConfig, nextFlashcard, prepareFormData, prepareSlidesForPublishing, previousFlashcard, redo, removeLine, reorderSlides, saveToHistory, selectAllSlides, selectCanAddSlide, selectCurrentSlide, selectCurrentSlideId, selectSlideById, sendToBack, setActivityType, setAltText, setAudioData, setBackgroundColor, setCurrentSlide, setEditingActivity, setEditingTextId, setLines, setLink, setPenColor, setShowFlashcardForm, setShowMcqForm, setSketchMode, setStrokeWidth, setTool, simplifyFlatPoints, simplifyLine, simplifyLines, store, toggleImageDrawingMode, toggleLock, togglePhotoFrameDrawingMode, toggleSketchMode, toggleVideoPlaying, undo, updateElementOrder, updateFillInTheBlanks, updateFlashcard, updateImage, updateImageAnnotation, updateLastLine, updateLinePosition, updateLineTransform, updateLongAnswer, updateMultipleChoice, updatePhotoFrame, updatePhotoFrameAnnotation, updateShape, updateShortAnswer, updateSlideThumbnail, updateText, updateTrueFalse, updateVideo, useDispatch, useInitialSlides, useSelector, useSlidesPersistence };
+export { type ActionType, type ActivityType, type AppDispatch, BASIC_EDITOR_TOOLBAR_CONFIG, BottomToolbar, type BottomToolbarProps, Canvas, type CanvasProps, type ContextMenuConfig, DEFAULT_CONTEXT_MENU_CONFIG, DEFAULT_TOOLBAR_CONFIG, EditorRoot, type EditorRootProps, type ExportOptions, type FillInTheBlanks, type FlashcardElement, type ImageElement, type InitialSlidesConfig, type Line$1 as Line, type LongAnswer, type MediaType, type MultipleChoice, type PhotoFrameElement, type PreparedImageElement, type PreparedPhotoFrameElement, type PreparedSlide, type PreparedVideoElement, type PresentationMetadata, PublishButton, type PublishButtonProps, type PublishPayload, type PublishProgress, type PublishResponse, type RootState, ScreenRecorder, type Shape, type ShapeType, type ShortAnswer, type Slide, SlideNavigation, type SlidesPayload, type TextElement, type ToolType, Toolbar, type ToolbarActionsConfig, type ToolbarConfig, type ToolbarProps, type ToolbarToolsConfig, TopNavBar, type TopNavBarProps, type TrueFalse, VIEWER_TOOLBAR_CONFIG, type VideoElement, addFillInTheBlanks, addFlashcard, addImage, addImageAnnotation, addLine, addLongAnswer, addMultipleChoice, addPhotoFrame, addPhotoFrameAnnotation, addShape, addShortAnswer, addSlide, addText, addTrueFalse, addVideo, arrayBufferToBase64, bringToFront, clearCanvas, clearImageAnnotations, clearLocalData, clearPhotoFrameAnnotations, createEmptySlide, deleteFillInTheBlanks, deleteFlashcard, deleteImage, deleteLineById, deleteLongAnswer, deleteMultipleChoice, deletePhotoFrame, deleteShape, deleteShortAnswer, deleteSlide, deleteText, deleteTrueFalse, deleteVideo, duplicateFillInTheBlanks, duplicateFlashcard, duplicateImage, duplicateLine, duplicateLongAnswer, duplicateMultipleChoice, duplicatePhotoFrame, duplicateShape, duplicateShortAnswer, duplicateSlide, duplicateText, duplicateTrueFalse, duplicateVideo, editFlashcard, editMultipleChoice, exportSlideAsBlob, exportSlideAsImage, finalizeDrawing, getCompressionStats, getSlideDataURL, loadCurrentSlideId, loadFromIndexedDB, loadPresentationMetadata$1 as loadPresentationMetadata, loadPresentationMetadata as loadPresentationMetadataFromDB, loadSlides, mergeToolbarConfig, nextFlashcard, prepareFormData, prepareSlidesForPublishing, previousFlashcard, redo, removeLine, reorderSlides, savePresentationMetadata, saveToHistory, selectAllSlides, selectCanAddSlide, selectCurrentSlide, selectCurrentSlideId, selectPresentationMetadata, selectSlideById, sendToBack, setActivityType, setAltText, setAudioData, setBackgroundColor, setCurrentSlide, setEditingActivity, setEditingTextId, setLines, setLink, setPenColor, setPresentationDescription, setPresentationTitle, setShowFlashcardForm, setShowMcqForm, setSketchMode, setStrokeWidth, setTool, simplifyFlatPoints, simplifyLine, simplifyLines, store, toggleImageDrawingMode, toggleLock, togglePhotoFrameDrawingMode, toggleSketchMode, toggleVideoPlaying, undo, updateElementOrder, updateFillInTheBlanks, updateFlashcard, updateImage, updateImageAnnotation, updateLastLine, updateLinePosition, updateLineTransform, updateLongAnswer, updateMultipleChoice, updatePhotoFrame, updatePhotoFrameAnnotation, updateShape, updateShortAnswer, updateSlideThumbnail, updateText, updateTrueFalse, updateVideo, useDispatch, useInitialSlides, useSelector, useSlidesPersistence };