canopycms 0.2.0 → 0.3.1

package/dist/editor/EntryNavigator.d.ts

@@ -9,8 +9,10 @@ export interface EntryNavItem {
     title?: string;
     /** Matched by the filter; the last segment of `path` when absent. */
     slug?: string;
-    /** The row's second line: the entry's type, or "Missing" (`entryStatusLabel`). */
+    /** The entry's type, or "Missing" (`entryStatusLabel`): its second line, with `route`. */
     status?: string;
+    /** The entry's route (`buildPreviewRoute`); its second line omits it when `noPage` or `missing`. */
+    route?: string;
     /** The entry's file is gone: its second line is error text. */
     missing?: boolean;
     /** The entry has no page on the site, so its menu changes its slug rather than its URL. */
@@ -75,16 +77,49 @@ export interface EntryNavigatorProps {
     readOnlyReason?: string;
     /** Entry paths with unsaved changes; each shows a dot, and so does every collection holding one. */
     dirtyPaths?: ReadonlySet<string>;
-    /**
-     * A collection to bring into view: any filter clears, its ancestors and itself expand, and its
-     * row takes focus. `seq` makes a repeat ask for the same collection a new one.
-     */
-    revealCollection?: {
+    /** A row to bring into view, or (`changed`) the unsaved entries; `onRevealed` once done. */
+    reveal?: ContentPanelReveal;
+    /** The reveal is done, or its row is not in the tree. */
+    onRevealed?: () => void;
+    /** The All / Changed control shows only with this; Changed lists the entries in `dirtyPaths`. */
+    onChangedOnlyChange?: (changedOnly: boolean) => void;
+    changedOnly?: boolean;
+    /** Entries with unsaved changes, counting drafts whose entries the tree doesn't list yet. */
+    unsavedCount?: number;
+    /** The named unsaved entries; Changed offers any the tree has no row for beneath it. */
+    unsavedEntries?: ReadonlyArray<{
         path: string;
-        seq: number;
+        label: string;
+    }>;
+    /** The branch's entry list failed to load, so Changed can't name what is unsaved. */
+    entryListFailed?: boolean;
+    /** The bar's "Not available" row: an empty tree says so, with `onSwitchBranch`, not "No content". */
+    branchNotAvailable?: boolean;
+    onSwitchBranch?: () => void;
+    /** Takes Enter's first match in the filter in place of `onSelect`. */
+    onFilterEnter?: (path: string) => void;
+    /** Escape in the empty filter. Without it, Escape there does nothing here. */
+    onFilterEscape?: () => void;
+    onRowMenuOpen?: () => void;
+    filterRef?: React.Ref<HTMLInputElement>;
+    /** The shortcut that focuses the filter, as the platform writes it ("⌘P") and for `aria-keyshortcuts`. */
+    filterShortcut?: {
+        label: string;
+        keys: string;
     };
-    /** The reveal is done, or its collection is not in the tree. */
-    onRevealed?: () => void;
 }
+/**
+ * A collection or entry reveal clears the query, switches Changed back to All, expands the row's
+ * ancestors (and a collection itself) and focuses the row. A `changed` reveal clears the query
+ * only, for Changed set alongside it. `seq` makes a repeat ask a new one.
+ */
+export type ContentPanelReveal = {
+    kind: 'collection' | 'entry';
+    path: string;
+    seq: number;
+} | {
+    kind: 'changed';
+    seq: number;
+};
 export declare const EntryNavigator: React.FC<EntryNavigatorProps>;
 export default EntryNavigator;