rename about -> showAboutDialog

paranext · Sep 10, 2024 · d137dd2 · d137dd2
1 parent 16baf1d
commit d137dd2
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/extensions/src/platform-scripture/src/main.ts b/extensions/src/platform-scripture/src/main.ts
@@ -143,8 +143,8 @@ export async function activate(context: ExecutionActivationContext) {
     '%webView_configureChecks_title%',
   );
 
-  const openAboutTabPromise = papi.commands.registerCommand('platform.about', async () =>
-    papi.dialogs.about(),
+  const showAboutDialogPromise = papi.commands.registerCommand('platform.about', async () =>
+    papi.dialogs.showAboutDialog(),
   );
 
   const includeProjectsCommandPromise = papi.commands.registerCommand(
@@ -224,7 +224,7 @@ export async function activate(context: ExecutionActivationContext) {
   await checkAggregatorService.initialize();
 
   context.registrations.add(
-    await openAboutTabPromise,
+    await showAboutDialogPromise,
     await scriptureExtenderPdpefPromise,
     await includeProjectsCommandPromise,
     await includeProjectsValidatorPromise,

diff --git a/lib/papi-dts/papi.d.ts b/lib/papi-dts/papi.d.ts
@@ -4996,7 +4996,7 @@ declare module 'shared/services/dialog.service-model' {
      * @param options Various options for configuring the dialog that shows
      * @returns Returns the user's selected project id or `undefined` if the user cancels
      */
-    about(options?: AboutDialogOptions): Promise<string | undefined>;
+    showAboutDialog(options?: AboutDialogOptions): Promise<string | undefined>;
   }
   /** Prefix on requests that indicates that the request is related to dialog operations */
   export const CATEGORY_DIALOG = 'dialog';

diff --git a/src/renderer/components/dialogs/about-dialog.component.tsx b/src/renderer/components/dialogs/about-dialog.component.tsx
@@ -8,7 +8,7 @@ export const TAB_TYPE_ABOUT = 'about';
 
 const STRING_KEYS: LocalizeKey[] = ['%product_name%'];
 
-function AboutPanel() {
+function AboutDialog() {
   const [{ '%product_name%': productName }] = useLocalizedStrings(STRING_KEYS);
 
   return (
@@ -31,7 +31,7 @@ const ABOUT_DIALOG: DialogDefinition<typeof ABOUT_DIALOG_TYPE> = Object.freeze({
     width: 500,
     height: 500,
   },
-  Component: AboutPanel,
+  Component: AboutDialog,
 });
 
 export default ABOUT_DIALOG;
diff --git a/src/renderer/services/dialog.service-host.ts b/src/renderer/services/dialog.service-host.ts
@@ -235,7 +235,7 @@ async function showDialog<DialogTabType extends DialogTabTypes>(
 }
 
 // on the dialogService - see `dialog.service-model.ts` for JSDoc
-async function about(
+async function showAboutDialog(
   options?: DialogTypes[typeof ABOUT_DIALOG.tabType]['options'],
 ): Promise<DialogTypes[typeof SELECT_PROJECT_DIALOG.tabType]['responseType'] | undefined> {
   return showDialog(ABOUT_DIALOG.tabType, options);
@@ -250,7 +250,7 @@ async function selectProject(
 
 const dialogService: DialogService = {
   showDialog,
-  about,
+  showAboutDialog,
   selectProject,
 };
 

diff --git a/src/shared/services/dialog.service-model.ts b/src/shared/services/dialog.service-model.ts
@@ -36,7 +36,7 @@ export interface DialogService {
    * @param options Various options for configuring the dialog that shows
    * @returns Returns the user's selected project id or `undefined` if the user cancels
    */
-  about(options?: AboutDialogOptions): Promise<string | undefined>;
+  showAboutDialog(options?: AboutDialogOptions): Promise<string | undefined>;
 }
 
 /** Prefix on requests that indicates that the request is related to dialog operations */

diff --git a/src/shared/services/dialog.service.ts b/src/shared/services/dialog.service.ts
@@ -17,7 +17,7 @@ const dialogService: DialogService = {
     await initialize();
     return networkService.request(serializeRequestType(CATEGORY_DIALOG, 'showDialog'), ...args);
   },
-  about: async (...args) => {
+  showAboutDialog: async (...args) => {
     await initialize();
     return networkService.request(serializeRequestType(CATEGORY_DIALOG, 'about'), ...args);
   },