@themarioga/grid-editor 9.0.0-beta.2 → 9.0.0-beta.4

package/src/less/grideditor.less

@@ -1040,6 +1040,66 @@ html.ge-sidebar-open {
         }
     }
 
+    /* An offcanvas is rendered unfolded and in place too: a plain block with
+       its body as an ordinary region, whichever edge it comes from on the
+       page. Bootstrap fixes it to the window, hides it and shifts it out
+       until its own JS adds .show, which the editor never asks for, so what
+       it sets is undone here. The responsive classes hide the header and
+       the body's padding from their breakpoint up, where the panel is
+       content: the title still has to be there to edit */
+    @ge-offcanvases: offcanvas, offcanvas-sm, offcanvas-md, offcanvas-lg, offcanvas-xl, offcanvas-xxl;
+
+    .ge-container-offcanvas {
+        each(@ge-offcanvases, {
+            .@{value} {
+                position: static;
+                z-index: auto;
+                visibility: visible;
+                width: auto;
+                height: auto;
+                max-width: none;
+                max-height: none;
+                margin: @editGutter 0;
+                transform: none;
+                transition: none;
+                display: flex;
+                flex-direction: column;
+                background-color: var(--bs-offcanvas-bg) !important;
+                border: var(--bs-offcanvas-border-width) solid var(--bs-offcanvas-border-color);
+
+                .offcanvas-header {
+                    display: flex;
+                }
+                .offcanvas-body {
+                    display: block;
+                    flex-grow: 1;
+                    padding: var(--bs-offcanvas-padding-y) var(--bs-offcanvas-padding-x);
+                    overflow: visible;
+                }
+            }
+        });
+
+        /* d-*-none on the trigger is for the page: the editor needs it to select the container */
+        > .ge-offcanvas-trigger {
+            display: inline-block !important;
+            margin-bottom: @editGutter;
+        }
+
+        /* Folded away, for a page with several offcanvases on it */
+        &.ge-offcanvas-collapsed {
+            each(@ge-offcanvases, {
+                .@{value} {
+                    display: none;
+                }
+            });
+        }
+    }
+
+    /* A trigger pointing at an offcanvas that is not there any more */
+    .ge-offcanvas-orphan {
+        outline: 2px dashed #d9534f;
+    }
+
     /* A trigger pointing at a popup that is not there any more */
     .ge-popup-orphan {
         outline: 2px dashed #d9534f;

package/types/grideditor.d.ts

@@ -111,6 +111,35 @@ export interface CarouselOptions {
 /** createContainer('carousel', …): the options, and how many slides. */
 export interface CreateCarouselOptions extends Placement, CarouselOptions {}
 
+/**
+ * The offcanvas plugin's options, the ones an offcanvas made new has, as the
+ * offcanvas setting gives them and createContainer overrides them: where it
+ * comes from, its backdrop, whether the page scrolls behind it, Esc, the
+ * breakpoint from which it is content and not a panel, and the dark theme.
+ */
+export interface OffcanvasOptions {
+    /** The edge it slides in from. Default `'start'`. */
+    placement?: 'start' | 'end' | 'top' | 'bottom';
+    /** A backdrop behind it: `true`, `false`, or `'static'`, which does not close it on a click. Default true. */
+    backdrop?: boolean | 'static';
+    /** The page can scroll while it is open. Default false. */
+    scroll?: boolean;
+    /** Esc closes it. Default true. */
+    keyboard?: boolean;
+    /** From this breakpoint up it is content in the page, and its trigger is hidden; null is a panel at every size. Default null. */
+    responsive?: 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | null;
+    /** `data-bs-theme="dark"`. Default false. */
+    dark?: boolean;
+}
+
+/** createContainer('offcanvas', …): the options, its title and its trigger. */
+export interface CreateOffcanvasOptions extends Placement, OffcanvasOptions {
+    title?: string;
+    /** false makes none, for a trigger the page writes itself. Default true. */
+    trigger?: boolean;
+    trigger_label?: string;
+}
+
 /** The inline-style plugin's settings. */
 export interface InlineStyleOptions {
     /** Every section is on unless it is turned off here. */
@@ -175,11 +204,15 @@ export interface GridEditorOptions {
     tabs?: TabsOptions;
     /** The carousel plugin: the options of the carousels made new. */
     carousel?: CarouselOptions;
+    /** The offcanvas plugin: the options of the offcanvases made new. */
+    offcanvas?: OffcanvasOptions;
     elements?: { enabled?: boolean | 'auto'; selector?: string; auto?: boolean; types?: ElementType[] };
     /** The autosave plugin: what is edited, kept in the browser's storage as it changes. */
     autosave?: AutosaveOptions;
     /** The clipboard plugin. `shortcuts`: Ctrl+C and Ctrl+V on the node selected or the target; default active_target. */
     clipboard?: { shortcuts?: boolean };
+    /** The history plugin: undo and redo. */
+    history?: HistoryOptions;
     custom_filter?: CustomFilter | CustomFilter[] | '';
     valid_col_sizes?: ColumnSize[];
     valid_col_offsets?: number[];
@@ -222,6 +255,18 @@ export interface AutosaveOptions {
     maxAge?: number | null;
 }
 
+/** The history plugin's options. */
+export interface HistoryOptions {
+    /** Ctrl+Z, and Ctrl+Y or Ctrl+Shift+Z (⌘ on a Mac). Default true. */
+    shortcuts?: boolean;
+    /** The undo and redo buttons on the right of the toolbar. Default true. */
+    buttons?: boolean;
+    /** The steps that can be undone. Default 50. */
+    max?: number;
+    /** Milliseconds after the last change that make a step. Default 500. */
+    delay?: number;
+}
+
 /** A draft the autosave plugin kept. */
 export interface AutosaveDraft {
     html: string;
@@ -252,6 +297,19 @@ export interface AutosaveErrorPayload {
     error: unknown;
 }
 
+export interface HistoryPayload {
+    canvas: HTMLElement;
+    /** The markup the canvas went to. */
+    html: string;
+    source: 'shortcut' | 'tool' | 'api';
+}
+
+export interface HistoryChangePayload {
+    canvas: HTMLElement;
+    canUndo: boolean;
+    canRedo: boolean;
+}
+
 /** Where a node was, or went: its parent and its index among the blocks there. */
 export interface Position {
     parent: HTMLElement;
@@ -320,6 +378,10 @@ export interface PopupOrphanPayload extends Payload {
     missing: string;
 }
 
+export interface OffcanvasOrphanPayload extends Payload {
+    missing: string;
+}
+
 export interface ViewChangePayload {
     canvas: HTMLElement;
     breakpoint: View;
@@ -379,12 +441,16 @@ export interface GridEditorEventMap {
     'grideditor:after-edit-html': EditHtmlPayload;
     'grideditor:after-copy': Payload;
     'grideditor:popup-orphan': PopupOrphanPayload;
+    'grideditor:offcanvas-orphan': OffcanvasOrphanPayload;
     'grideditor:view-change': ViewChangePayload;
     'grideditor:target-change': TargetChangePayload;
     'grideditor:selection-change': SelectionChangePayload;
     'grideditor:after-autosave': AutosavePayload;
     'grideditor:after-restore-draft': RestoreDraftPayload;
     'grideditor:autosave-error': AutosaveErrorPayload;
+    'grideditor:after-undo': HistoryPayload;
+    'grideditor:after-redo': HistoryPayload;
+    'grideditor:history-change': HistoryChangePayload;
 }
 
 /** An event the editor dispatches on its canvas: a CustomEvent whose detail is the payload. */
@@ -507,6 +573,7 @@ export declare class GridEditor {
     createSection(options?: CreateSectionOptions): HTMLElement | null;
     createContainer(type: 'tabs', options?: CreateTabsOptions): HTMLElement | null;
     createContainer(type: 'carousel', options?: CreateCarouselOptions): HTMLElement | null;
+    createContainer(type: 'offcanvas', options?: CreateOffcanvasOptions): HTMLElement | null;
     createContainer(type: string, options?: Placement & Record<string, unknown>): HTMLElement | null;
     addTab(container: Target, options?: PaneOptions): HTMLElement | null;
     addAccordionItem(container: Target, options?: PaneOptions): HTMLElement | null;
@@ -523,6 +590,14 @@ export declare class GridEditor {
     saveDraft?(): boolean;
     getDraft?(): AutosaveDraft | null;
     clearDraft?(): boolean;
+    /** The history plugin's, when it is loaded: true when it went to another step. */
+    undo?(): boolean;
+    redo?(): boolean;
+    /** Whether there is a step to go back to, a change not yet a step counting. */
+    canUndo?(): boolean;
+    canRedo?(): boolean;
+    /** What there is now becomes the first step, with nothing before or after it. */
+    clearHistory?(): boolean;
 }
 
 export default GridEditor;