useIsInPlaceEditingActive()

Unlike Scrivito.isInPlaceEditingActive which only reflects the global editing state, this hook is context-aware: Its result also depends on the editable area and on whether editing has been switched off for the surrounding components via Scrivito.InPlaceEditingOff (or forced on as page content via Scrivito.InPlaceEditAsPageContent). It must be called from within a Scrivito component (page, widget, or layout component).

Returns

Boolean — true if in-place editing is globally active and enabled for the calling component; otherwise false. In particular, it returns false if editing is globally off, if called inside Scrivito.InPlaceEditingOff, if the editable area is page content but the hook is called from the layout component, or if the editable area is layout content but the hook is called from the page component.