diff --git a/extensions/src/platform-scripture/src/main.ts b/extensions/src/platform-scripture/src/main.ts index 165f8dc845..5a18e3b933 100644 --- 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) { repeatedWordsInventoryWebViewType, ); - 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( @@ -208,7 +208,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 index b194a0400d..8bcf893211 100644 --- a/lib/papi-dts/papi.d.ts +++ b/lib/papi-dts/papi.d.ts @@ -4784,7 +4784,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; + showAboutDialog(options?: AboutDialogOptions): Promise; } /** 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 index 0b0bba5826..0b82edc4d2 100644 --- 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 = 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 index c841b5ff41..414f36794d 100644 --- a/src/renderer/services/dialog.service-host.ts +++ b/src/renderer/services/dialog.service-host.ts @@ -235,7 +235,7 @@ async function showDialog( } // on the dialogService - see `dialog.service-model.ts` for JSDoc -async function about( +async function showAboutDialog( options?: DialogTypes[typeof ABOUT_DIALOG.tabType]['options'], ): Promise { 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 index c5b915bb88..70b49b5ede 100644 --- 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; + showAboutDialog(options?: AboutDialogOptions): Promise; } /** 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 index 4c4cfbb76d..561297446d 100644 --- 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); },