From da076aa48e705092420a185d860b05b33fd5fe28 Mon Sep 17 00:00:00 2001
From: Henrik Giesel <hengiesel@gmail.com>
Date: Thu, 27 May 2021 13:55:13 +0200
Subject: [PATCH] Generalize ButtonToolbarItem to SectionItem

---
 ts/components/ButtonToolbar.svelte            | 15 ++++++-------
 ...nToolbarItem.svelte => SectionItem.svelte} | 12 +++++-----
 ts/components/buttons.ts                      |  8 ++-----
 ts/components/contextKeys.ts                  |  2 +-
 ts/components/registration.ts                 | 14 ++++++++----
 ts/deckoptions/ConfigSelector.svelte          | 10 ++++-----
 ts/editor/EditorToolbar.svelte                | 22 +++++++++----------
 ts/editor/FormatBlockButtons.svelte           | 10 ++++-----
 8 files changed, 46 insertions(+), 47 deletions(-)
 rename ts/components/{ButtonToolbarItem.svelte => SectionItem.svelte} (68%)

diff --git a/ts/components/ButtonToolbar.svelte b/ts/components/ButtonToolbar.svelte
index f1685cfb0..19ce423bd 100644
--- a/ts/components/ButtonToolbar.svelte
+++ b/ts/components/ButtonToolbar.svelte
@@ -5,12 +5,11 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 <script lang="typescript">
     import { setContext } from "svelte";
     import { writable } from "svelte/store";
-    import ButtonToolbarItem from "./ButtonToolbarItem.svelte";
-    import type { ButtonGroupRegistration } from "./buttons";
-    import { buttonToolbarKey } from "./contextKeys";
+    import SectionItem from "./SectionItem.svelte";
+    import { sectionKey } from "./contextKeys";
     import type { Identifier } from "./identifier";
     import { insert, add } from "./identifier";
-    import type { SvelteComponent } from "./registration";
+    import type { SvelteComponent, Registration } from "./registration";
     import { makeInterface } from "./registration";
 
     export let id: string | undefined = undefined;
@@ -30,7 +29,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 
     $: style = buttonSize + buttonWrap;
 
-    function makeRegistration(): ButtonGroupRegistration {
+    function makeRegistration(): Registration {
         const detach = writable(false);
         return { detach };
     }
@@ -38,7 +37,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     const { registerComponent, dynamicItems, getDynamicInterface } =
         makeInterface(makeRegistration);
 
-    setContext(buttonToolbarKey, registerComponent);
+    setContext(sectionKey, registerComponent);
 
     export let api: Record<string, unknown> | undefined = undefined;
     let buttonToolbarRef: HTMLDivElement;
@@ -81,9 +80,9 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 >
     <slot />
     {#each $dynamicItems as item}
-        <ButtonToolbarItem id={item[0].id} registration={item[1]}>
+        <SectionItem id={item[0].id} registration={item[1]}>
             <svelte:component this={item[0].component} {...item[0].props} />
-        </ButtonToolbarItem>
+        </SectionItem>
     {/each}
 </div>
 
diff --git a/ts/components/ButtonToolbarItem.svelte b/ts/components/SectionItem.svelte
similarity index 68%
rename from ts/components/ButtonToolbarItem.svelte
rename to ts/components/SectionItem.svelte
index 5d77dd16a..09e086f3a 100644
--- a/ts/components/ButtonToolbarItem.svelte
+++ b/ts/components/SectionItem.svelte
@@ -5,23 +5,21 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 <script lang="typescript">
     import Detachable from "components/Detachable.svelte";
 
-    import type { ButtonGroupRegistration } from "./buttons";
-    import type { Register } from "./registration";
+    import type { Register, Registration } from "./registration";
 
     import { getContext, hasContext } from "svelte";
-    import { buttonToolbarKey } from "./contextKeys";
+    import { sectionKey } from "./contextKeys";
 
     export let id: string | undefined = undefined;
-    export let registration: ButtonGroupRegistration | undefined = undefined;
+    export let registration: Registration | undefined = undefined;
 
     let detached: boolean;
 
     if (registration) {
         const { detach } = registration;
         detach.subscribe((value: boolean) => (detached = value));
-    } else if (hasContext(buttonToolbarKey)) {
-        const registerComponent =
-            getContext<Register<ButtonGroupRegistration>>(buttonToolbarKey);
+    } else if (hasContext(sectionKey)) {
+        const registerComponent = getContext<Register<Registration>>(sectionKey);
         const { detach } = registerComponent();
         detach.subscribe((value: boolean) => (detached = value));
     } else {
diff --git a/ts/components/buttons.ts b/ts/components/buttons.ts
index abe6ee34e..cd64bb1ca 100644
--- a/ts/components/buttons.ts
+++ b/ts/components/buttons.ts
@@ -1,6 +1,7 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 import type { Writable } from "svelte/store";
+import type { Registration } from "./registration";
 
 export enum ButtonPosition {
     Standalone,
@@ -9,11 +10,6 @@ export enum ButtonPosition {
     Rightmost,
 }
 
-export interface ButtonRegistration {
-    detach: Writable<boolean>;
+export interface ButtonRegistration extends Registration {
     position: Writable<ButtonPosition>;
 }
-
-export interface ButtonGroupRegistration {
-    detach: Writable<boolean>;
-}
diff --git a/ts/components/contextKeys.ts b/ts/components/contextKeys.ts
index 008569399..c2dd979c6 100644
--- a/ts/components/contextKeys.ts
+++ b/ts/components/contextKeys.ts
@@ -3,7 +3,7 @@
 export const nightModeKey = Symbol("nightMode");
 export const disabledKey = Symbol("disabled");
 
-export const buttonToolbarKey = Symbol("buttonToolbar");
+export const sectionKey = Symbol("section");
 export const buttonGroupKey = Symbol("buttonGroup");
 export const dropdownKey = Symbol("dropdown");
 export const modalsKey = Symbol("modals");
diff --git a/ts/components/registration.ts b/ts/components/registration.ts
index 06f03c009..bf3b3dfac 100644
--- a/ts/components/registration.ts
+++ b/ts/components/registration.ts
@@ -1,7 +1,7 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 import type { SvelteComponentTyped } from "svelte/internal";
-import type { Readable } from "svelte/store";
+import type { Writable, Readable } from "svelte/store";
 import { writable } from "svelte/store";
 import type { Identifier } from "./identifier";
 import { find } from "./identifier";
@@ -12,9 +12,13 @@ export interface SvelteComponent {
     props: Record<string, unknown> | undefined;
 }
 
-export type Register<T> = (index?: number, registration?: T) => T;
+export interface Registration {
+    detach: Writable<boolean>;
+}
 
-export interface RegistrationAPI<T> {
+export type Register<T extends Registration> = (index?: number, registration?: T) => T;
+
+export interface RegistrationAPI<T extends Registration> {
     registerComponent: Register<T>;
     items: Readable<T[]>;
     dynamicItems: Readable<[SvelteComponent, T][]>;
@@ -36,7 +40,9 @@ export function nodeIsElement(node: Node): node is Element {
     return node.nodeType === Node.ELEMENT_NODE;
 }
 
-export function makeInterface<T>(makeRegistration: () => T): RegistrationAPI<T> {
+export function makeInterface<T extends Registration>(
+    makeRegistration: () => T
+): RegistrationAPI<T> {
     const registrations: T[] = [];
     const items = writable(registrations);
 
diff --git a/ts/deckoptions/ConfigSelector.svelte b/ts/deckoptions/ConfigSelector.svelte
index 524717d49..4927f1067 100644
--- a/ts/deckoptions/ConfigSelector.svelte
+++ b/ts/deckoptions/ConfigSelector.svelte
@@ -12,7 +12,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     import TextInputModal from "./TextInputModal.svelte";
     import StickyBar from "components/StickyBar.svelte";
     import ButtonToolbar from "components/ButtonToolbar.svelte";
-    import ButtonToolbarItem from "components/ButtonToolbarItem.svelte";
+    import SectionItem from "components/SectionItem.svelte";
     import ButtonGroup from "components/ButtonGroup.svelte";
     import ButtonGroupItem from "components/ButtonGroupItem.svelte";
 
@@ -89,7 +89,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 
 <StickyBar>
     <ButtonToolbar class="justify-content-between" size={2.3} wrap={false}>
-        <ButtonToolbarItem>
+        <SectionItem>
             <ButtonGroup class="flex-grow-1">
                 <ButtonGroupItem>
                     <SelectButton class="flex-grow-1" on:change={blur}>
@@ -104,15 +104,15 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
                     </SelectButton>
                 </ButtonGroupItem>
             </ButtonGroup>
-        </ButtonToolbarItem>
+        </SectionItem>
 
-        <ButtonToolbarItem>
+        <SectionItem>
             <SaveButton
                 {state}
                 on:add={promptToAdd}
                 on:clone={promptToClone}
                 on:rename={promptToRename}
             />
-        </ButtonToolbarItem>
+        </SectionItem>
     </ButtonToolbar>
 </StickyBar>
diff --git a/ts/editor/EditorToolbar.svelte b/ts/editor/EditorToolbar.svelte
index 946b4e545..d87d02c59 100644
--- a/ts/editor/EditorToolbar.svelte
+++ b/ts/editor/EditorToolbar.svelte
@@ -33,7 +33,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     import { isApplePlatform } from "lib/platform";
     import StickyBar from "components/StickyBar.svelte";
     import ButtonToolbar from "components/ButtonToolbar.svelte";
-    import ButtonToolbarItem from "components/ButtonToolbarItem.svelte";
+    import SectionItem from "components/SectionItem.svelte";
 
     import NoteTypeButtons from "./NoteTypeButtons.svelte";
     import FormatInlineButtons from "./FormatInlineButtons.svelte";
@@ -54,24 +54,24 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 
 <StickyBar>
     <ButtonToolbar {size} {wrap} api={toolbar}>
-        <ButtonToolbarItem id="notetype">
+        <SectionItem id="notetype">
             <NoteTypeButtons api={notetypeButtons} />
-        </ButtonToolbarItem>
+        </SectionItem>
 
-        <ButtonToolbarItem id="inlineFormatting">
+        <SectionItem id="inlineFormatting">
             <FormatInlineButtons api={formatInlineButtons} />
-        </ButtonToolbarItem>
+        </SectionItem>
 
-        <ButtonToolbarItem id="blockFormatting">
+        <SectionItem id="blockFormatting">
             <FormatBlockButtons api={formatBlockButtons} />
-        </ButtonToolbarItem>
+        </SectionItem>
 
-        <ButtonToolbarItem id="color">
+        <SectionItem id="color">
             <ColorButtons api={colorButtons} />
-        </ButtonToolbarItem>
+        </SectionItem>
 
-        <ButtonToolbarItem id="template">
+        <SectionItem id="template">
             <TemplateButtons api={templateButtons} />
-        </ButtonToolbarItem>
+        </SectionItem>
     </ButtonToolbar>
 </StickyBar>
diff --git a/ts/editor/FormatBlockButtons.svelte b/ts/editor/FormatBlockButtons.svelte
index f1d4376ea..cacb7abf8 100644
--- a/ts/editor/FormatBlockButtons.svelte
+++ b/ts/editor/FormatBlockButtons.svelte
@@ -10,7 +10,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     import ButtonGroupItem from "components/ButtonGroupItem.svelte";
     import IconButton from "components/IconButton.svelte";
     import ButtonDropdown from "components/ButtonDropdown.svelte";
-    import ButtonToolbarItem from "components/ButtonToolbarItem.svelte";
+    import SectionItem from "components/SectionItem.svelte";
     import WithDropdownMenu from "components/WithDropdownMenu.svelte";
     import OnlyEditable from "./OnlyEditable.svelte";
     import CommandIconButton from "./CommandIconButton.svelte";
@@ -71,7 +71,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
             </OnlyEditable>
 
             <ButtonDropdown id={menuId}>
-                <ButtonToolbarItem id="justify">
+                <SectionItem id="justify">
                     <ButtonGroup>
                         <ButtonGroupItem>
                             <CommandIconButton
@@ -109,9 +109,9 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
                             >
                         </ButtonGroupItem>
                     </ButtonGroup>
-                </ButtonToolbarItem>
+                </SectionItem>
 
-                <ButtonToolbarItem id="indentation">
+                <SectionItem id="indentation">
                     <ButtonGroup>
                         <ButtonGroupItem>
                             <OnlyEditable let:disabled>
@@ -137,7 +137,7 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
                             </OnlyEditable>
                         </ButtonGroupItem>
                     </ButtonGroup>
-                </ButtonToolbarItem>
+                </SectionItem>
             </ButtonDropdown>
         </WithDropdownMenu>
     </ButtonGroupItem>