web / UseEditorStateReturn
Interface: UseEditorStateReturn ​
Defined in: composables/useEditorState/types.ts:7
Description ​
Return type for useEditorState composable Provides semantic state checks and feature flags for editor functionality
Properties ​
device ​
device:
Ref<PreviewDevice>
Defined in: composables/useEditorState/types.ts:34
Currently simulated device in editor preview
isEditMode ​
isEditMode:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:12
Whether we are in edit mode (can modify blocks, shows editor UI, uses fake data)
isInEditor ​
isInEditor:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:10
Whether we are in the editor environment (true in both edit and preview modes)
isInEditorClient ​
isInEditorClient:
Ref<boolean>
Defined in: composables/useEditorState/types.ts:30
Client-side only editor check (guaranteed to be set post-hydration)
isLiveMode ​
isLiveMode:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:16
Whether we are in live/production mode (no editor features)
isMobilePreview ​
isMobilePreview:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:36
Whether the preview is simulating a mobile or tablet device
isPreviewMode ​
isPreviewMode:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:14
Whether we are in preview mode (viewing changes without editing)
previewWidth ​
previewWidth:
ComputedRef<string>
Defined in: composables/useEditorState/types.ts:38
Preview frame width (e.g. '375px' for mobile, '100%' for desktop)
shouldEnableEditorFeatures ​
shouldEnableEditorFeatures:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:26
Whether to enable editor features (drag-drop, zoom controls, etc.)
shouldHideZeroValues ​
shouldHideZeroValues:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:24
Whether to hide zero/empty values in displays
shouldShowEditorUI ​
shouldShowEditorUI:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:20
Whether to show editor UI elements (toolbars, overlays, etc.)
shouldUseFakeData ​
shouldUseFakeData:
ComputedRef<boolean>
Defined in: composables/useEditorState/types.ts:22
Whether to use fake/example data instead of real API data