From f1a5e55b904124653ff84370349ff2ee0955607e Mon Sep 17 00:00:00 2001 From: Sebastian-ubs <141921979+Sebastian-ubs@users.noreply.github.com> Date: Thu, 19 Dec 2024 21:15:35 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20github-pages=20from=20@=20para?= =?UTF-8?q?next/paranext-core@eea56ee32e55d939b62a45b05b795cfc05aa44ab=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_client_services_rpc_client_.default.html | 18 ++++---- .../_main_services_rpc_server_.default.html | 14 +++--- ...vices_rpc_websocket_listener_.default.html | 18 ++++---- ...execution_token_model_.ExecutionToken.html | 6 +-- ..._renderer_web_socket_service_.default.html | 30 ++++++------- ...rer_xml_http_request_service_.default.html | 44 +++++++++---------- .../_shared_log_error_model_.default.html | 4 +- ..._model_.BaseProjectDataProviderEngine.html | 4 +- ...ider_engine_model_.DataProviderEngine.html | 4 +- ..._network_event_emitter_model_.default.html | 20 ++++----- ...eringProjectDataProviderEngineFactory.html | 12 ++--- ...gine_model_.ProjectDataProviderEngine.html | 4 +- ...eb_view_factory_model_.WebViewFactory.html | 12 ++--- ...t_settings_document_combiner_.default.html | 38 ++++++++-------- ...tings_document_combiner_base_.default.html | 34 +++++++------- ...s_node_file_system_service_.EntryType.html | 4 +- ...ared_data_rpc_model_.ConnectionStatus.html | 8 ++-- ...shared_global_this_model_.ProcessType.html | 4 +- ...vileges_model_.ElevatedPrivilegeNames.html | 4 +- ...ls_web_view_model_.WebViewContentType.html | 8 ++-- papi-dts/functions/__papi_backend_.fetch.html | 2 +- .../functions/__papi_frontend_.fetch.html | 2 +- ...s_web_socket_factory_.createWebSocket.html | 2 +- ...e_service_.buildExtensionPathFromName.html | 2 +- ...ion_storage_service_.setExtensionUris.html | 2 +- ...es_node_file_system_service_.copyFile.html | 2 +- ...s_node_file_system_service_.createDir.html | 2 +- ...s_node_file_system_service_.deleteDir.html | 2 +- ..._node_file_system_service_.deleteFile.html | 2 +- ...es_node_file_system_service_.getStats.html | 2 +- ...es_node_file_system_service_.moveFile.html | 2 +- ...ces_node_file_system_service_.readDir.html | 2 +- ...e_file_system_service_.readFileBinary.html | 2 +- ...ode_file_system_service_.readFileText.html | 2 +- ...vices_node_file_system_service_.touch.html | 2 +- ...s_node_file_system_service_.writeFile.html | 2 +- .../_node_utils_crypto_util_.createNonce.html | 2 +- .../_node_utils_crypto_util_.createUuid.html | 2 +- ...s_crypto_util_.generateHashFromBuffer.html | 2 +- .../_node_utils_util_.getAppDir.html | 2 +- .../_node_utils_util_.getPathFromUri.html | 2 +- ...ls_util_.isNoisyDevModeEnvVariableSet.html | 2 +- .../_node_utils_util_.joinUriPaths.html | 2 +- .../_node_utils_util_.resolveHtmlPath.html | 2 +- ...dialog_base_data_.hookUpDialogService.html | 2 +- ...rs_create_use_data_hook_util_.default.html | 2 +- ...use_network_object_hook_util_.default.html | 2 +- ...oks_papi_hooks_use_data_hook_.default.html | 2 +- ...hooks_use_data_provider_hook_.default.html | 2 +- ...use_data_provider_multi_hook_.default.html | 2 +- ...oks_use_dialog_callback_hook_.default.html | 4 +- ...s_use_localized_strings_hook_.default.html | 2 +- ..._hooks_use_project_data_hook_.default.html | 2 +- ...e_project_data_provider_hook_.default.html | 2 +- ...oks_use_project_setting_hook_.default.html | 2 +- ...se_scroll_group_scr_ref_hook_.default.html | 2 +- ..._papi_hooks_use_setting_hook_.default.html | 2 +- ...use_web_view_controller_hook_.default.html | 2 +- ...service_.blockWebSocketsToPapiNetwork.html | 2 +- ...oll_group_service_host_.getScrRefSync.html | 2 +- ...group_service_host_.onDidUpdateScrRef.html | 2 +- ...oll_group_service_host_.setScrRefSync.html | 2 +- ...service_host_.startScrollGroupService.html | 2 +- ...d_data_rpc_model_.createErrorResponse.html | 2 +- ..._shared_data_rpc_model_.createRequest.html | 2 +- ...data_rpc_model_.createSuccessResponse.html | 2 +- ...ed_data_rpc_model_.deserializeMessage.html | 2 +- ..._shared_data_rpc_model_.fixupResponse.html | 2 +- ...ared_data_rpc_model_.requestWithRetry.html | 2 +- ...ata_rpc_model_.sendPayloadToWebSocket.html | 2 +- ...tDataProviderDataTypeFromFunctionName.html | 2 +- ...els_openrpc_model_.createEmptyOpenRpc.html | 2 +- ...els_openrpc_model_.getEmptyMethodDocs.html | 2 +- ...e_model_.areProjectInterfacesIncluded.html | 2 +- ...oviderFactoryMetadataInfoMinimalMatch.html | 2 +- ....getPDPFactoryIdFromNetworkObjectName.html | 2 +- ....getPDPFactoryNetworkObjectNameFromId.html | 2 +- ...up_service_model_.internalGetMetadata.html | 2 +- ...tMetadataForProjectParametersToFilter.html | 2 +- ...nd_service_.createSendCommandFunction.html | 2 +- ...ices_command_service_.registerCommand.html | 2 +- ...services_command_service_.sendCommand.html | 2 +- ...ices_data_provider_service_.getByType.html | 2 +- ...rovider_service_.registerEngineByType.html | 2 +- ...ed_services_logger_service_.formatLog.html | 2 +- ...ect_service_.onDidCreateNetworkObject.html | 2 +- ...ct_service_.onDidDisposeNetworkObject.html | 2 +- ...twork_object_service_.overrideDispose.html | 2 +- ...rk_service_.createNetworkEventEmitter.html | 2 +- ...etwork_service_.createRequestFunction.html | 2 +- ...ices_network_service_.getNetworkEvent.html | 2 +- ..._services_network_service_.initialize.html | 2 +- ...twork_service_.registerRequestHandler.html | 2 +- ...red_services_network_service_.request.html | 2 +- ...ed_services_network_service_.shutdown.html | 2 +- ...es_project_data_provider_service_.get.html | 2 +- ...isterProjectDataProviderEngineFactory.html | 2 +- ...tingsContributionsByProjectInterfaces.html | 2 +- ...rpc_handler_factory_.createRpcHandler.html | 2 +- ...w_service_model_.getWebViewController.html | 2 +- ...e_model_.getWebViewControllerObjectId.html | 2 +- ...e_model_.getWebViewMessageRequestType.html | 2 +- ...d_utils_internal_util_.getProcessType.html | 2 +- ..._shared_utils_internal_util_.isClient.html | 2 +- ..._utils_internal_util_.isExtensionHost.html | 2 +- ...hared_utils_internal_util_.isRenderer.html | 2 +- ..._shared_utils_internal_util_.isServer.html | 2 +- .../_shared_utils_util_.bindClassMethods.html | 2 +- ...ed_utils_util_.deserializeRequestType.html | 2 +- ...tils_util_.getModuleSimilarApiMessage.html | 2 +- .../_shared_utils_util_.newNonce.html | 2 +- ...ared_utils_util_.serializeRequestType.html | 2 +- .../functions/getSavedWebViewDefinition.html | 2 +- .../getSavedWebViewDefinitionById.html | 2 +- papi-dts/functions/getWebViewState.html | 2 +- papi-dts/functions/resetWebViewState.html | 2 +- papi-dts/functions/setWebViewState.html | 2 +- .../functions/updateWebViewDefinition.html | 2 +- .../updateWebViewDefinitionById.html | 2 +- .../useWebViewScrollGroupScrRef.html | 2 +- papi-dts/functions/useWebViewState.html | 2 +- papi-dts/functions/webViewComponent.html | 2 +- ...types_extension_interface_.IExtension.html | 6 +-- ...rage_service_.ExtensionStorageService.html | 12 ++--- .../_papi_shared_types_.CommandHandlers.html | 12 ++--- .../_papi_shared_types_.DataProviders.html | 4 +- ..._types_.ProjectDataProviderInterfaces.html | 4 +- ...api_shared_types_.ProjectSettingTypes.html | 10 ++--- .../_papi_shared_types_.SettingTypes.html | 12 ++--- ...papi_shared_types_.WebViewControllers.html | 4 +- ..._dialog_definition_model_.DialogTypes.html | 4 +- ..._docking_framework_model_.FloatLayout.html | 6 +-- ..._docking_framework_model_.PanelLayout.html | 6 +-- ...ls_docking_framework_model_.TabLayout.html | 4 +- ....NetworkObjectStatusRemoteServiceType.html | 4 +- ...model_.NetworkObjectStatusServiceType.html | 6 +-- ...el_.IProjectDataProviderEngineFactory.html | 6 +-- ...a_provider_factory_interface_.default.html | 8 ++-- ...red_models_rpc_interface_.IRpcHandler.html | 12 ++--- ...ls_rpc_interface_.IRpcMethodRegistrar.html | 16 +++---- ...der_model_.IDisposableWebViewProvider.html | 8 ++-- ...der_model_.IRegisteredWebViewProvider.html | 6 +-- ...view_provider_model_.IWebViewProvider.html | 8 ++-- ...provider_service_.DataProviderService.html | 12 ++--- ...s_dialog_service_model_.DialogService.html | 6 +-- ...ces_internet_service_.InternetService.html | 4 +- ..._service_.MinimalNetworkObjectService.html | 6 +-- ..._object_service_.NetworkObjectService.html | 10 ++--- ...s_network_service_.PapiNetworkService.html | 6 +-- ...PapiBackendProjectDataProviderService.html | 6 +-- ...apiFrontendProjectDataProviderService.html | 4 +- ...ervice_model_.IProjectSettingsService.html | 10 ++--- ...vice_model_.IScrollGroupRemoteService.html | 6 +-- ...up_service_model_.IScrollGroupService.html | 8 ++-- ...r_service_.PapiWebViewProviderService.html | 10 ++--- ...vider_service_.WebViewProviderService.html | 12 ++--- ...iew_service_model_.WebViewServiceType.html | 20 ++++----- papi-dts/modules/__papi_backend_.html | 2 +- papi-dts/modules/__papi_core_.html | 2 +- papi-dts/modules/__papi_frontend_.html | 2 +- papi-dts/modules/__papi_frontend_react_.html | 2 +- .../modules/_client_services_rpc_client_.html | 2 +- .../_client_services_web_socket_factory_.html | 2 +- ...client_services_web_socket_interface_.html | 2 +- ...s_extension_activation_context_model_.html | 2 +- ..._extension_types_extension_interface_.html | 2 +- ...nsion_types_extension_manifest_model_.html | 2 +- ...ices_extension_host_web_socket_model_.html | 2 +- ...t_services_extension_storage_service_.html | 2 +- .../modules/_main_services_rpc_server_.html | 2 +- ...main_services_rpc_websocket_listener_.html | 2 +- .../_node_models_execution_token_model_.html | 2 +- ...ode_services_execution_token_service_.html | 2 +- ...de_services_node_file_system_service_.html | 2 +- .../modules/_node_utils_crypto_util_.html | 2 +- papi-dts/modules/_node_utils_util_.html | 2 +- papi-dts/modules/_papi_shared_types_.html | 2 +- ..._components_dialogs_dialog_base_data_.html | 2 +- ...ents_dialogs_dialog_definition_model_.html | 2 +- ...generators_create_use_data_hook_util_.html | 2 +- ..._create_use_network_object_hook_util_.html | 2 +- .../_renderer_hooks_papi_hooks_index_.html | 2 +- ...derer_hooks_papi_hooks_use_data_hook_.html | 2 +- ...ks_papi_hooks_use_data_provider_hook_.html | 2 +- ...i_hooks_use_data_provider_multi_hook_.html | 2 +- ..._papi_hooks_use_dialog_callback_hook_.html | 2 +- ...api_hooks_use_localized_strings_hook_.html | 2 +- ...oks_papi_hooks_use_project_data_hook_.html | 2 +- ...hooks_use_project_data_provider_hook_.html | 2 +- ..._papi_hooks_use_project_setting_hook_.html | 2 +- ..._hooks_use_scroll_group_scr_ref_hook_.html | 2 +- ...er_hooks_papi_hooks_use_setting_hook_.html | 2 +- ...i_hooks_use_web_view_controller_hook_.html | 2 +- ...services_renderer_web_socket_service_.html | 2 +- ...es_renderer_xml_http_request_service_.html | 2 +- ...r_services_scroll_group_service_host_.html | 2 +- .../_shared_data_file_system_model_.html | 2 +- .../modules/_shared_data_platform_data_.html | 2 +- papi-dts/modules/_shared_data_rpc_model_.html | 2 +- .../modules/_shared_global_this_model_.html | 2 +- .../modules/_shared_log_error_model_.html | 2 +- ...e_project_data_provider_engine_model_.html | 2 +- ...odels_create_process_privilege_model_.html | 2 +- ...ed_models_data_provider_engine_model_.html | 2 +- ...hared_models_data_provider_interface_.html | 2 +- .../_shared_models_data_provider_model_.html | 2 +- .../_shared_models_dialog_options_model_.html | 2 +- ...hared_models_docking_framework_model_.html | 2 +- ...red_models_elevated_privileges_model_.html | 2 +- ...ed_models_extension_basic_data_model_.html | 2 +- ...tract_data_provider_data_types_model_.html | 2 +- ...ls_manage_extensions_privilege_model_.html | 2 +- .../_shared_models_network_object_model_.html | 2 +- ..._network_object_status_service_model_.html | 2 +- .../_shared_models_openrpc_model_.html | 2 +- ...els_papi_network_event_emitter_model_.html | 2 +- ...t_data_provider_engine_factory_model_.html | 2 +- ...s_project_data_provider_engine_model_.html | 2 +- ...ject_data_provider_factory_interface_.html | 2 +- ...d_models_project_data_provider_model_.html | 2 +- ..._models_project_lookup_service_model_.html | 2 +- ...shared_models_project_metadata_model_.html | 2 +- .../_shared_models_rpc_interface_.html | 2 +- ...shared_models_web_view_factory_model_.html | 2 +- .../_shared_models_web_view_model_.html | 2 +- ...hared_models_web_view_provider_model_.html | 2 +- .../_shared_services_command_service_.html | 2 +- ...hared_services_data_provider_service_.html | 2 +- .../_shared_services_dialog_service_.html | 2 +- ...shared_services_dialog_service_model_.html | 2 +- .../_shared_services_internet_service_.html | 2 +- ...shared_services_localization_service_.html | 2 +- ..._services_localization_service_model_.html | 2 +- .../_shared_services_logger_service_.html | 2 +- .../_shared_services_menu_data_service_.html | 2 +- ...red_services_menu_data_service_model_.html | 2 +- ...ared_services_network_object_service_.html | 2 +- ...rvices_network_object_status_service_.html | 2 +- .../_shared_services_network_service_.html | 2 +- ...rvices_project_data_provider_service_.html | 2 +- ...ared_services_project_lookup_service_.html | 2 +- ...ed_services_project_settings_service_.html | 2 +- ...vices_project_settings_service_model_.html | 2 +- ..._shared_services_rpc_handler_factory_.html | 2 +- ...shared_services_scroll_group_service_.html | 2 +- ..._services_scroll_group_service_model_.html | 2 +- .../_shared_services_settings_service_.html | 2 +- ...ared_services_settings_service_model_.html | 2 +- ...d_services_web_view_provider_service_.html | 2 +- .../_shared_services_web_view_service_.html | 2 +- ...ared_services_web_view_service_model_.html | 2 +- .../modules/_shared_utils_internal_util_.html | 2 +- ...s_project_settings_document_combiner_.html | 2 +- ...tils_settings_document_combiner_base_.html | 2 +- papi-dts/modules/_shared_utils_util_.html | 2 +- papi-dts/types/__papi_frontend_.Papi.html | 2 +- ...ices_web_socket_interface_.IWebSocket.html | 2 +- ...ext_model_.ExecutionActivationContext.html | 2 +- ...ion_manifest_model_.ExtensionManifest.html | 2 +- ...ices_rpc_server_.PropagateEventMethod.html | 2 +- ...ution_token_model_.ExecutionTokenType.html | 2 +- ...file_system_service_.DirectoryEntries.html | 2 +- .../_papi_shared_types_.CommandNames.html | 2 +- ..._papi_shared_types_.DataProviderNames.html | 2 +- ..._papi_shared_types_.DataProviderTypes.html | 2 +- ...shared_types_.DisposableDataProviders.html | 2 +- ...hared_types_.IBaseProjectDataProvider.html | 2 +- ...pi_shared_types_.IProjectDataProvider.html | 2 +- ...ared_types_.NotesOnlyProjectDataTypes.html | 2 +- ...pi_shared_types_.PlaceholderDataTypes.html | 2 +- ...ared_types_.ProjectInterfaceDataTypes.html | 2 +- ..._papi_shared_types_.ProjectInterfaces.html | 2 +- ...api_shared_types_.ProjectSettingNames.html | 2 +- .../_papi_shared_types_.SettingNames.html | 2 +- .../_papi_shared_types_.StuffDataTypes.html | 2 +- ..._shared_types_.WebViewControllerTypes.html | 2 +- ...ojectDataProviderEngineSettingMethods.html | 2 +- ...ialog_base_data_.DialogDefinitionBase.html | 2 +- ...dialogs_dialog_base_data_.DialogProps.html | 6 +-- ...log_definition_model_.DialogDataTypes.html | 2 +- ...og_definition_model_.DialogDefinition.html | 2 +- ...alog_definition_model_.DialogTabTypes.html | 2 +- ...ition_model_.ProjectDialogOptionsBase.html | 2 +- ...ition_model_.SelectBooksDialogOptions.html | 2 +- ..._.SelectMultipleProjectsDialogOptions.html | 2 +- ...ion_model_.SelectProjectDialogOptions.html | 2 +- ...llback_hook_.UseDialogCallbackOptions.html | 2 +- .../_shared_data_file_system_model_.Uri.html | 2 +- .../_shared_data_rpc_model_.EventHandler.html | 2 +- ...ata_rpc_model_.InternalRequestHandler.html | 2 +- .../_shared_data_rpc_model_.RequestId.html | 2 +- ..._shared_data_rpc_model_.RequestParams.html | 2 +- ...model_.IBaseProjectDataProviderEngine.html | 2 +- ...rocess_privilege_model_.CreateProcess.html | 2 +- ..._privilege_model_.OperatingSystemData.html | 2 +- ...process_privilege_model_.PlatformFork.html | 2 +- ...rocess_privilege_model_.PlatformSpawn.html | 2 +- ...model_.DataProviderEngineNotifyUpdate.html | 2 +- ...ovider_engine_model_.WithNotifyUpdate.html | 2 +- ...s_data_provider_engine_model_.default.html | 2 +- ...er_interface_.IDisposableDataProvider.html | 2 +- ...dels_data_provider_interface_.default.html | 2 +- ..._provider_model_.DataProviderDataType.html | 2 +- ...provider_model_.DataProviderDataTypes.html | 2 +- ...ta_provider_model_.DataProviderGetter.html | 2 +- ...a_provider_model_.DataProviderGetters.html | 2 +- ...ta_provider_model_.DataProviderSetter.html | 2 +- ...a_provider_model_.DataProviderSetters.html | 2 +- ...rovider_model_.DataProviderSubscriber.html | 2 +- ..._model_.DataProviderSubscriberOptions.html | 2 +- ...ovider_model_.DataProviderSubscribers.html | 2 +- ...model_.DataProviderUpdateInstructions.html | 2 +- ...ls_data_provider_model_.DataTypeNames.html | 2 +- ...d_models_data_provider_model_.default.html | 2 +- ...dels_dialog_options_model_.DialogData.html | 2 +- ...s_dialog_options_model_.DialogOptions.html | 2 +- ...ocking_framework_model_.FloatPosition.html | 2 +- ...ls_docking_framework_model_.FloatSize.html | 2 +- ...odels_docking_framework_model_.Layout.html | 2 +- ...framework_model_.OnLayoutChangeRCDock.html | 2 +- ...cking_framework_model_.PanelDirection.html | 2 +- ...cking_framework_model_.PapiDockLayout.html | 2 +- ...docking_framework_model_.SavedTabInfo.html | 2 +- ...dels_docking_framework_model_.TabInfo.html | 2 +- ...ls_docking_framework_model_.TabLoader.html | 2 +- ...els_docking_framework_model_.TabSaver.html | 2 +- ...king_framework_model_.WebViewTabProps.html | 2 +- ..._privileges_model_.ElevatedPrivileges.html | 2 +- ..._basic_data_model_.ExtensionBasicData.html | 2 +- ...ta_provider_data_types_model_.default.html | 2 +- ...ilege_model_.DisableExtensionFunction.html | 2 +- ...vilege_model_.EnableExtensionFunction.html | 2 +- ..._privilege_model_.ExtensionIdentifier.html | 2 +- ...model_.GetInstalledExtensionsFunction.html | 2 +- ...xtensions_privilege_model_.HashValues.html | 2 +- ...ilege_model_.InstallExtensionFunction.html | 2 +- ..._privilege_model_.InstalledExtensions.html | 2 +- ...ons_privilege_model_.ManageExtensions.html | 2 +- ...object_model_.DisposableNetworkObject.html | 2 +- ...ject_model_.LocalObjectToProxyCreator.html | 2 +- ...s_network_object_model_.NetworkObject.html | 2 +- ...rk_object_model_.NetworkObjectDetails.html | 2 +- ...twork_object_model_.NetworkableObject.html | 2 +- ...ared_models_openrpc_model_.Components.html | 2 +- ...ls_openrpc_model_.ComponentsReference.html | 2 +- ..._shared_models_openrpc_model_.Contact.html | 2 +- ...dels_openrpc_model_.ContentDescriptor.html | 2 +- .../_shared_models_openrpc_model_.Error.html | 2 +- ..._shared_models_openrpc_model_.Example.html | 2 +- ...s_openrpc_model_.ExamplePairingObject.html | 2 +- ..._openrpc_model_.ExternalDocumentation.html | 2 +- .../_shared_models_openrpc_model_.Info.html | 2 +- ..._shared_models_openrpc_model_.License.html | 2 +- .../_shared_models_openrpc_model_.Link.html | 2 +- .../_shared_models_openrpc_model_.Method.html | 2 +- ...model_.MethodDocumentationWithoutName.html | 2 +- ...rpc_model_.NetworkObjectDocumentation.html | 2 +- ..._shared_models_openrpc_model_.OpenRpc.html | 2 +- ...hared_models_openrpc_model_.Reference.html | 2 +- .../_shared_models_openrpc_model_.Schema.html | 2 +- .../_shared_models_openrpc_model_.Server.html | 2 +- ..._models_openrpc_model_.ServerVariable.html | 2 +- ...nrpc_model_.SingleMethodDocumentation.html | 2 +- .../_shared_models_openrpc_model_.Tag.html | 2 +- ...ine_model_.IProjectDataProviderEngine.html | 2 +- ...terface_.ProjectMetadataFilterOptions.html | 2 +- ...ta_provider_model_.ExtensionDataScope.html | 2 +- ...ider_model_.MandatoryProjectDataTypes.html | 2 +- ...ataProviderEngineExtensionDataMethods.html | 4 +- ...rvice_model_.ProjectLookupServiceType.html | 12 ++--- ...rojectDataProviderFactoryMetadataInfo.html | 2 +- ...oject_metadata_model_.ProjectMetadata.html | 2 +- ...el_.ProjectMetadataWithoutFactoryInfo.html | 2 +- ...interface_.RegisteredRpcMethodDetails.html | 2 +- ...view_model_.GetSavedWebViewDefinition.html | 2 +- ...els_web_view_model_.GetWebViewOptions.html | 2 +- ...eb_view_model_.SavedWebViewDefinition.html | 2 +- ...el_.SavedWebViewDefinitionOmittedKeys.html | 2 +- ...b_view_model_.UpdateWebViewDefinition.html | 2 +- ...odel_.UseWebViewScrollGroupScrRefHook.html | 2 +- ...s_web_view_model_.UseWebViewStateHook.html | 2 +- ...els_web_view_model_.WebViewDefinition.html | 2 +- ...web_view_model_.WebViewDefinitionBase.html | 2 +- ...web_view_model_.WebViewDefinitionHtml.html | 2 +- ...eb_view_model_.WebViewDefinitionReact.html | 2 +- ..._web_view_model_.WebViewDefinitionURL.html | 2 +- ....WebViewDefinitionUpdatableProperties.html | 2 +- ...ew_model_.WebViewDefinitionUpdateInfo.html | 2 +- ...ared_models_web_view_model_.WebViewId.html | 2 +- ...d_models_web_view_model_.WebViewProps.html | 2 +- ...ed_models_web_view_model_.WebViewType.html | 2 +- ...ommand_service_.moduleSummaryComments.html | 2 +- ...n_service_model_.ILocalizationService.html | 8 ++-- ...ation_service_model_.LocalizationData.html | 2 +- ...vice_model_.LocalizationDataDataTypes.html | 2 +- ...n_service_model_.LocalizationSelector.html | 2 +- ..._service_model_.LocalizationSelectors.html | 2 +- ..._data_service_model_.IMenuDataService.html | 16 +++---- ...data_service_model_.MenuDataDataTypes.html | 2 +- ...e_model_.AllProjectSettingsValidators.html | 2 +- ...ervice_model_.ProjectSettingValidator.html | 2 +- ...l_.SimultaneousProjectSettingsChanges.html | 2 +- ...roup_service_model_.ScrollGroupScrRef.html | 2 +- ..._service_model_.ScrollGroupUpdateInfo.html | 2 +- ...ttings_service_model_.AllSettingsData.html | 2 +- ..._service_model_.AllSettingsValidators.html | 2 +- ...tings_service_model_.ISettingsService.html | 14 +++--- ...tings_service_model_.SettingDataTypes.html | 2 +- ...tings_service_model_.SettingValidator.html | 2 +- ...view_service_model_.CloseWebViewEvent.html | 2 +- ..._view_service_model_.OpenWebViewEvent.html | 2 +- ...iew_service_model_.UpdateWebViewEvent.html | 2 +- ...e_model_.WebViewMessageRequestHandler.html | 2 +- ...ment_combiner_.AllProjectSettingsInfo.html | 2 +- ...alizedProjectSettingsContributionInfo.html | 2 +- ...document_combiner_.ProjectSettingInfo.html | 2 +- ...iner_.ProjectSettingsContributionInfo.html | 2 +- ...cument_combiner_base_.AllSettingsInfo.html | 2 +- ...se_.LocalizedSettingsContributionInfo.html | 2 +- ...s_document_combiner_base_.SettingInfo.html | 2 +- ...mbiner_base_.SettingsContributionInfo.html | 2 +- .../_shared_utils_util_.RequestType.html | 2 +- ...red_utils_util_.SerializedRequestType.html | 2 +- ...ackend_.BaseProjectDataProviderEngine.html | 2 +- .../__papi_backend_.DataProviderEngine.html | 2 +- ...eringProjectDataProviderEngineFactory.html | 2 +- ...pi_backend_.ProjectDataProviderEngine.html | 2 +- .../__papi_backend_.WebViewFactory.html | 2 +- .../variables/__papi_backend_.commands.html | 2 +- .../__papi_backend_.dataProviders.html | 2 +- .../variables/__papi_backend_.default.html | 2 +- .../variables/__papi_backend_.dialogs.html | 2 +- .../variables/__papi_backend_.internet.html | 2 +- .../__papi_backend_.localization.html | 2 +- .../variables/__papi_backend_.logger.html | 2 +- .../variables/__papi_backend_.menuData.html | 2 +- .../variables/__papi_backend_.network.html | 2 +- .../__papi_backend_.networkObjectStatus.html | 2 +- .../__papi_backend_.networkObjects.html | 2 +- .../__papi_backend_.projectDataProviders.html | 2 +- .../__papi_backend_.projectLookup.html | 2 +- .../__papi_backend_.projectSettings.html | 2 +- .../__papi_backend_.scrollGroups.html | 2 +- .../variables/__papi_backend_.settings.html | 2 +- .../variables/__papi_backend_.storage.html | 2 +- .../__papi_backend_.webViewProviders.html | 2 +- .../variables/__papi_backend_.webViews.html | 2 +- papi-dts/variables/__papi_core_.default.html | 2 +- .../variables/__papi_frontend_.WebSocket.html | 2 +- .../__papi_frontend_.XMLHttpRequest.html | 2 +- .../variables/__papi_frontend_.commands.html | 2 +- .../__papi_frontend_.dataProviders.html | 2 +- .../variables/__papi_frontend_.default.html | 2 +- .../variables/__papi_frontend_.dialogs.html | 2 +- .../variables/__papi_frontend_.internet.html | 2 +- .../__papi_frontend_.localization.html | 2 +- .../variables/__papi_frontend_.logger.html | 2 +- .../variables/__papi_frontend_.menuData.html | 2 +- .../variables/__papi_frontend_.network.html | 2 +- ...__papi_frontend_.projectDataProviders.html | 2 +- .../__papi_frontend_.projectLookup.html | 2 +- .../variables/__papi_frontend_.react.html | 2 +- .../__papi_frontend_.scrollGroups.html | 2 +- .../variables/__papi_frontend_.settings.html | 2 +- .../variables/__papi_frontend_.webViews.html | 2 +- ...es_extension_storage_service_.default.html | 2 +- ...ices_execution_token_service_.default.html | 2 +- .../_node_utils_util_.FILE_PROTOCOL.html | 2 +- .../_node_utils_util_.RESOURCES_PROTOCOL.html | 2 +- ...nts_dialogs_dialog_base_data_.default.html | 2 +- ...ition_model_.SELECT_BOOKS_DIALOG_TYPE.html | 2 +- ....SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html | 2 +- ...ion_model_.SELECT_PROJECT_DIALOG_TYPE.html | 2 +- ...service_host_.availableScrollGroupIds.html | 2 +- ...orm_data_.DEV_MODE_RENDERER_INDICATOR.html | 2 +- ...ata_platform_data_.PLATFORM_NAMESPACE.html | 2 +- ...ared_data_rpc_model_.CATEGORY_COMMAND.html | 2 +- .../_shared_data_rpc_model_.GET_METHODS.html | 2 +- ...hared_data_rpc_model_.REGISTER_METHOD.html | 2 +- ...red_data_rpc_model_.UNREGISTER_METHOD.html | 2 +- ...shared_data_rpc_model_.WEBSOCKET_PORT.html | 2 +- ...LOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html | 2 +- ...kObjectStatusServiceNetworkObjectName.html | 2 +- ...ry_interface_.PDP_FACTORY_OBJECT_TYPE.html | 2 +- ...odel_.PROJECT_INTERFACE_PLATFORM_BASE.html | 2 +- ...RK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html | 2 +- ...rvice_model_.projectLookupServiceBase.html | 2 +- ...ce_model_.testingProjectLookupService.html | 2 +- ...SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html | 2 +- ...EW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html | 2 +- ...rvices_data_provider_service_.default.html | 2 +- ...ared_services_dialog_service_.default.html | 2 +- ...dialog_service_model_.CATEGORY_DIALOG.html | 2 +- ...ed_services_internet_service_.default.html | 2 +- ...ervices_localization_service_.default.html | 2 +- ...del_.localizationServiceObjectToProxy.html | 2 +- ...odel_.localizationServiceProviderName.html | 2 +- ...red_services_logger_service_.WARN_TAG.html | 2 +- ...ared_services_logger_service_.default.html | 2 +- ...d_services_menu_data_service_.default.html | 2 +- ...e_model_.menuDataServiceObjectToProxy.html | 2 +- ...ce_model_.menuDataServiceProviderName.html | 2 +- ...vices_network_object_service_.default.html | 2 +- ...ervice_.minimalNetworkObjectService-1.html | 2 +- ...etwork_object_status_service_.default.html | 2 +- ...network_service_.papiNetworkService-1.html | 2 +- ...piBackendProjectDataProviderService-1.html | 2 +- ...iFrontendProjectDataProviderService-1.html | 2 +- ...vices_project_lookup_service_.default.html | 2 +- ...ces_project_settings_service_.default.html | 2 +- ...Y_EXTENSION_PROJECT_SETTING_VALIDATOR.html | 2 +- ...ojectSettingsServiceNetworkObjectName.html | 2 +- ..._.projectSettingsServiceObjectToProxy.html | 2 +- ...ervices_scroll_group_service_.default.html | 2 +- ...del_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html | 2 +- ...WORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html | 2 +- ...ed_services_settings_service_.default.html | 2 +- ....CATEGORY_EXTENSION_SETTING_VALIDATOR.html | 2 +- ...odel_.settingsServiceDataProviderName.html | 2 +- ...e_model_.settingsServiceObjectToProxy.html | 2 +- ...es_web_view_provider_service_.default.html | 2 +- ...service_.papiWebViewProviderService-1.html | 2 +- ...ed_services_web_view_service_.default.html | 2 +- ...model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html | 2 +- ...del_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html | 2 +- ...odel_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html | 2 +- ...el_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html | 2 +- ....NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html | 2 +- ...odel_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html | 2 +- ...hared_utils_util_.MODULE_SIMILAR_APIS.html | 2 +- ...ed_utils_util_.REQUEST_TYPE_SEPARATOR.html | 2 +- papi-dts/variables/isNoisyDevModeEnabled.html | 2 +- papi-dts/variables/isPackaged.html | 2 +- papi-dts/variables/logLevel.html | 2 +- papi-dts/variables/processType.html | 2 +- papi-dts/variables/resourcesPath.html | 2 +- papi-dts/variables/webViewId.html | 2 +- platform-bible-react/assets/search.js | 2 +- .../enums/BookSelectionMode.html | 4 +- .../enums/DropdownMenuItemType.html | 4 +- platform-bible-react/functions/Alert.html | 2 +- .../functions/AlertDescription.html | 2 +- .../functions/AlertTitle.html | 2 +- platform-bible-react/functions/Badge.html | 2 +- .../functions/BookChapterControl.html | 2 +- .../functions/BookSelector.html | 2 +- platform-bible-react/functions/Button.html | 2 +- platform-bible-react/functions/Card.html | 2 +- .../functions/CardContent.html | 2 +- .../functions/CardDescription.html | 2 +- .../functions/CardFooter.html | 2 +- .../functions/CardHeader.html | 2 +- platform-bible-react/functions/CardTitle.html | 2 +- .../functions/ChapterRangeSelector.html | 2 +- platform-bible-react/functions/Checkbox.html | 2 +- platform-bible-react/functions/Checklist.html | 2 +- platform-bible-react/functions/ComboBox.html | 2 +- platform-bible-react/functions/DataTable.html | 2 +- .../functions/DisableButton.html | 2 +- .../functions/DropdownMenu.html | 2 +- .../functions/DropdownMenuCheckboxItem.html | 2 +- .../functions/DropdownMenuContent.html | 2 +- .../functions/DropdownMenuGroup.html | 2 +- .../functions/DropdownMenuItem.html | 4 +- .../functions/DropdownMenuLabel.html | 2 +- .../functions/DropdownMenuPortal.html | 2 +- .../functions/DropdownMenuRadioGroup.html | 2 +- .../functions/DropdownMenuRadioItem.html | 2 +- .../functions/DropdownMenuSeparator.html | 2 +- .../functions/DropdownMenuShortcut.html | 4 +- .../functions/DropdownMenuSub.html | 2 +- .../functions/DropdownMenuSubContent.html | 2 +- .../functions/DropdownMenuSubTrigger.html | 2 +- .../functions/DropdownMenuTrigger.html | 2 +- .../functions/EnableButton.html | 2 +- .../functions/FilterButton.html | 2 +- .../functions/FilterDropdown.html | 2 +- .../functions/FilterableResourceList.html | 2 +- platform-bible-react/functions/Footer.html | 2 +- platform-bible-react/functions/GridMenu.html | 2 +- .../functions/HamburgerMenuButton.html | 2 +- .../functions/IconButton.html | 2 +- platform-bible-react/functions/Input.html | 2 +- .../functions/InstallButton.html | 2 +- platform-bible-react/functions/Inventory.html | 2 +- platform-bible-react/functions/Label.html | 2 +- .../functions/MarkdownRenderer.html | 2 +- platform-bible-react/functions/MenuItem.html | 2 +- platform-bible-react/functions/MoreInfo.html | 2 +- .../functions/MultiSelectComboBox.html | 2 +- .../functions/NavigationContentSearch.html | 2 +- .../functions/NoExtensionsFound.html | 2 +- .../functions/RadioGroup.html | 2 +- .../functions/RadioGroupItem.html | 2 +- .../functions/ScriptureResultsViewer.html | 2 +- .../functions/ScrollGroupSelector.html | 2 +- platform-bible-react/functions/SearchBar.html | 2 +- platform-bible-react/functions/Select.html | 2 +- .../functions/SelectContent.html | 2 +- .../functions/SelectGroup.html | 2 +- .../functions/SelectItem.html | 2 +- .../functions/SelectLabel.html | 2 +- .../functions/SelectScrollDownButton.html | 2 +- .../functions/SelectScrollUpButton.html | 2 +- .../functions/SelectSeparator.html | 2 +- .../functions/SelectTrigger.html | 2 +- .../functions/SelectValue.html | 2 +- platform-bible-react/functions/Separator.html | 2 +- .../functions/SettingsList.html | 2 +- .../functions/SettingsListHeader.html | 2 +- .../functions/SettingsListItem.html | 2 +- .../functions/SettingsSidebar.html | 2 +- .../SettingsSidebarContentSearch.html | 2 +- platform-bible-react/functions/Slider.html | 2 +- platform-bible-react/functions/Sonner-1.html | 2 +- platform-bible-react/functions/Spinner.html | 2 +- platform-bible-react/functions/Switch.html | 2 +- platform-bible-react/functions/Table.html | 2 +- platform-bible-react/functions/TableBody.html | 2 +- .../functions/TableCaption.html | 2 +- platform-bible-react/functions/TableCell.html | 2 +- .../functions/TableFooter.html | 2 +- platform-bible-react/functions/TableHead.html | 2 +- .../functions/TableHeader.html | 2 +- platform-bible-react/functions/TableRow.html | 2 +- platform-bible-react/functions/Tabs.html | 2 +- .../functions/TabsContent.html | 2 +- platform-bible-react/functions/TabsList.html | 2 +- .../functions/TabsTrigger.html | 2 +- platform-bible-react/functions/TextField.html | 2 +- .../functions/ToggleGroup.html | 2 +- .../functions/ToggleGroupItem.html | 2 +- platform-bible-react/functions/Toolbar.html | 2 +- .../functions/UiLanguageSelector.html | 2 +- .../functions/UpdateButton.html | 2 +- .../functions/VersionHistory.html | 2 +- .../functions/VerticalTabs.html | 2 +- .../functions/VerticalTabsContent.html | 2 +- .../functions/VerticalTabsList.html | 2 +- .../functions/VerticalTabsTrigger.html | 2 +- .../functions/badgeVariants.html | 2 +- .../functions/buttonVariants.html | 2 +- platform-bible-react/functions/cn.html | 2 +- .../functions/getBookNumFromId.html | 2 +- .../functions/getLinesFromUSFM.html | 2 +- .../functions/getNumberFromUSFM.html | 2 +- .../functions/getStatusForItem.html | 2 +- .../functions/inventoryCountColumn.html | 2 +- .../functions/inventoryItemColumn.html | 2 +- .../functions/inventoryStatusColumn.html | 2 +- platform-bible-react/functions/useEvent.html | 2 +- .../functions/useEventAsync.html | 2 +- .../functions/usePromise.html | 2 +- .../interfaces/BadgeProps.html | 4 +- .../interfaces/ButtonProps.html | 6 +-- .../interfaces/CommandHandler.html | 2 +- .../interfaces/MultiColumnMenuProvider.html | 2 +- .../types/BookSelectorLocalizedStrings.html | 2 +- .../types/ChapterRangeSelectorProps.html | 2 +- .../types/ChecklistProps.html | 2 +- platform-bible-react/types/ColumnDef.html | 2 +- .../types/ComboBoxLabelOption.html | 2 +- .../types/ComboBoxOption.html | 2 +- platform-bible-react/types/ComboBoxProps.html | 5 +-- platform-bible-react/types/DropdownGroup.html | 2 +- platform-bible-react/types/DropdownItem.html | 2 +- .../types/DropdownMenuCheckboxItemProps.html | 2 +- .../types/DropdownMenuContentProps.html | 2 +- .../types/DropdownMenuItemProps.html | 2 +- .../types/DropdownMenuLabelProps.html | 2 +- .../types/DropdownMenuRadioItemProps.html | 2 +- .../types/DropdownMenuSeparatorProps.html | 2 +- .../types/DropdownMenuShortcutProps.html | 2 +- .../types/DropdownMenuSubContentProps.html | 2 +- .../types/DropdownMenuSubTriggerProps.html | 2 +- platform-bible-react/types/GridMenuInfo.html | 2 +- platform-bible-react/types/GridMenuProps.html | 2 +- .../types/IconButtonProps.html | 2 +- .../types/InventoryItemOccurrence.html | 2 +- .../types/InventoryLocalizedStrings.html | 2 +- .../types/InventoryTableData.html | 2 +- platform-bible-react/types/LanguageInfo.html | 2 +- .../types/MenuItemListProps.html | 2 +- platform-bible-react/types/ProjectInfo.html | 2 +- platform-bible-react/types/ResultsSet.html | 2 +- platform-bible-react/types/ResultsSource.html | 2 +- platform-bible-react/types/RowContents.html | 2 +- platform-bible-react/types/Scope.html | 2 +- .../types/ScriptureItemDetail.html | 2 +- .../ScriptureResultsViewerColumnInfo.html | 2 +- .../types/ScriptureResultsViewerProps.html | 5 +-- .../types/ScriptureSrcItemDetail.html | 2 +- .../types/ScrollGroupSelectorProps.html | 2 +- .../types/SearchBarProps.html | 2 +- .../types/SelectedSettingsSidebarItem.html | 2 +- .../types/SettingsSidebarProps.html | 2 +- platform-bible-react/types/SortDirection.html | 2 +- platform-bible-react/types/SpinnerProps.html | 2 +- .../types/TabKeyValueContent.html | 2 +- platform-bible-react/types/TableContents.html | 2 +- .../types/TextFieldProps.html | 2 +- platform-bible-react/types/ToolbarProps.html | 2 +- .../types/UiLanguageSelectorProps.html | 5 +-- .../types/UsePromiseOptions.html | 2 +- .../types/VersionHistoryType.html | 2 +- .../types/VersionInformation.html | 2 +- .../variables/BOOK_SELECTOR_STRING_KEYS.html | 2 +- .../FILTERABLE_RESOURCE_LIST_STRING_KEYS.html | 2 +- .../variables/INVENTORY_STRING_KEYS.html | 2 +- .../classes/AsyncVariable.html | 12 ++--- platform-bible-utils/classes/Collator.html | 8 ++-- .../classes/DateTimeFormat.html | 14 +++--- .../classes/DocumentCombiner.html | 28 ++++++------ platform-bible-utils/classes/Mutex.html | 2 +- platform-bible-utils/classes/MutexMap.html | 4 +- .../NonValidatingDocumentCombiner.html | 28 ++++++------ .../classes/NumberFormat.html | 14 +++--- .../classes/PlatformEventEmitter.html | 16 +++---- .../classes/UnsubscriberAsyncList.html | 8 ++-- .../classes/UsjReaderWriter.html | 26 +++++------ .../aggregateUnsubscriberAsyncs.html | 2 +- .../functions/aggregateUnsubscribers.html | 2 +- platform-bible-utils/functions/at.html | 2 +- platform-bible-utils/functions/charAt.html | 2 +- .../functions/codePointAt.html | 2 +- .../functions/compareScrRefs.html | 2 +- .../createSyncProxyForAsyncObject.html | 2 +- platform-bible-utils/functions/debounce.html | 2 +- platform-bible-utils/functions/deepClone.html | 2 +- platform-bible-utils/functions/deepEqual.html | 2 +- .../functions/deserialize.html | 2 +- platform-bible-utils/functions/endsWith.html | 2 +- .../functions/ensureArray.html | 2 +- .../functions/escapeStringRegexp.html | 2 +- .../functions/formatBytes.html | 2 +- .../functions/formatReplacementString.html | 2 +- .../formatReplacementStringToArray.html | 2 +- .../functions/formatScrRef.html | 2 +- .../functions/getAllObjectFunctionNames.html | 2 +- .../functions/getChaptersForBook.html | 2 +- .../functions/getCurrentLocale.html | 2 +- .../functions/getErrorMessage.html | 2 +- .../getLocalizeKeyForScrollGroupId.html | 2 +- .../getLocalizeKeysForScrollGroupIds.html | 2 +- .../getLocalizedIdFromBookNumber.html | 2 +- platform-bible-utils/functions/groupBy.html | 2 +- .../functions/htmlEncode.html | 2 +- platform-bible-utils/functions/includes.html | 2 +- platform-bible-utils/functions/indexOf.html | 2 +- .../functions/isLocalizeKey.html | 2 +- .../functions/isSerializable.html | 2 +- platform-bible-utils/functions/isString.html | 2 +- platform-bible-utils/functions/isSubset.html | 2 +- .../functions/lastIndexOf.html | 2 +- platform-bible-utils/functions/newGuid.html | 2 +- platform-bible-utils/functions/normalize.html | 2 +- .../functions/offsetBook.html | 2 +- .../functions/offsetChapter.html | 2 +- .../functions/offsetVerse.html | 2 +- .../functions/ordinalCompare.html | 2 +- platform-bible-utils/functions/padEnd.html | 2 +- platform-bible-utils/functions/padStart.html | 2 +- .../functions/scrRefToBBBCCCVVV.html | 2 +- platform-bible-utils/functions/serialize.html | 2 +- platform-bible-utils/functions/slice.html | 2 +- platform-bible-utils/functions/split.html | 2 +- .../functions/startsWith.html | 2 +- .../functions/stringLength.html | 2 +- platform-bible-utils/functions/substring.html | 2 +- platform-bible-utils/functions/toArray.html | 2 +- .../transformAndEnsureRegExpArray.html | 2 +- .../transformAndEnsureRegExpRegExpArray.html | 2 +- platform-bible-utils/functions/wait.html | 2 +- .../functions/waitForDuration.html | 2 +- platform-bible-utils/interfaces/BookInfo.html | 4 +- .../interfaces/CannotHaveOnDidDispose.html | 6 +-- platform-bible-utils/interfaces/Dispose.html | 4 +- .../interfaces/IUsjReaderWriter.html | 24 +++++----- .../interfaces/LanguageStrings.html | 2 +- .../LocalizedStringDataContribution.html | 4 +- .../ModifierExtensionControlled.html | 4 +- .../interfaces/ModifierProject.html | 10 ++--- .../interfaces/OnDidDispose.html | 4 +- .../interfaces/ProjectSettingProperties.html | 2 +- .../interfaces/ProjectSettingsGroup.html | 6 +-- .../interfaces/ProjectStateContribution.html | 2 +- .../interfaces/ScriptureReference.html | 4 +- .../interfaces/SettingProperties.html | 2 +- .../interfaces/SettingsGroup.html | 6 +-- .../interfaces/StateBase.html | 6 +-- .../interfaces/StringMetadata.html | 6 +-- .../interfaces/StringsMetadata.html | 2 +- .../interfaces/UserStateContribution.html | 2 +- .../types/CanHaveOnDidDispose.html | 2 +- .../types/ColumnsWithHeaders.html | 2 +- .../types/DblResourceData.html | 2 +- platform-bible-utils/types/DeepPartial.html | 2 +- .../types/DocumentCombinerOptions.html | 2 +- .../ExtensionControlledProjectSetting.html | 2 +- .../types/ExtensionControlledSetting.html | 2 +- .../types/ExtensionControlledState.html | 2 +- .../types/GroupsInMultiColumnMenu.html | 2 +- .../types/GroupsInSingleColumnMenu.html | 2 +- .../types/JsonDocumentLike.html | 2 +- platform-bible-utils/types/LocalizeKey.html | 2 +- platform-bible-utils/types/Localized.html | 2 +- .../types/LocalizedStringValue.html | 2 +- .../types/MenuColumnWithHeader.html | 2 +- .../types/MenuGroupDetailsInColumn.html | 2 +- .../types/MenuGroupDetailsInSubMenu.html | 2 +- platform-bible-utils/types/MenuItemBase.html | 2 +- .../types/MenuItemContainingCommand.html | 2 +- .../types/MenuItemContainingSubmenu.html | 2 +- .../types/MultiColumnMenu.html | 2 +- .../types/OrderedExtensibleContainer.html | 2 +- platform-bible-utils/types/OrderedItem.html | 2 +- platform-bible-utils/types/PlatformEvent.html | 2 +- .../types/PlatformEventAsync.html | 2 +- .../types/PlatformEventHandler.html | 2 +- platform-bible-utils/types/PlatformMenus.html | 2 +- .../types/ProjectSetting.html | 2 +- .../types/ProjectSettingBase.html | 2 +- .../types/ProjectSettingsContribution.html | 2 +- .../types/ReferencedItem.html | 2 +- platform-bible-utils/types/ReplaceType.html | 2 +- platform-bible-utils/types/ResourceType.html | 2 +- platform-bible-utils/types/ScriptureNode.html | 2 +- .../types/ScriptureSelection.html | 2 +- .../types/ScriptureTextAnchor.html | 2 +- platform-bible-utils/types/ScrollGroupId.html | 2 +- platform-bible-utils/types/Setting.html | 2 +- platform-bible-utils/types/SettingBase.html | 2 +- .../types/SettingsContribution.html | 2 +- .../types/SingleColumnMenu.html | 2 +- .../types/UnionToIntersection.html | 2 +- platform-bible-utils/types/Unsubscriber.html | 2 +- .../types/UnsubscriberAsync.html | 2 +- platform-bible-utils/types/UserState.html | 2 +- .../types/UsjContentLocation.html | 2 +- .../types/VerseRefOffset.html | 2 +- platform-bible-utils/types/WebViewMenu.html | 2 +- platform-bible-utils/types/WebViewMenus.html | 2 +- .../variables/CHAPTER_TYPE.html | 2 +- .../variables/FIRST_SCR_BOOK_NUM.html | 2 +- .../variables/FIRST_SCR_CHAPTER_NUM.html | 2 +- .../variables/FIRST_SCR_VERSE_NUM.html | 2 +- .../variables/LAST_SCR_BOOK_NUM.html | 2 +- .../variables/VERSE_TYPE.html | 2 +- .../variables/defaultScrRef.html | 2 +- .../localizedStringsDocumentSchema.html | 2 +- .../variables/menuDocumentSchema.html | 2 +- .../projectSettingsDocumentSchema.html | 2 +- .../variables/settingsDocumentSchema.html | 2 +- 853 files changed, 1216 insertions(+), 1221 deletions(-) diff --git a/papi-dts/classes/_client_services_rpc_client_.default.html b/papi-dts/classes/_client_services_rpc_client_.default.html index 6628b00e58..5bc539de32 100644 --- a/papi-dts/classes/_client_services_rpc_client_.default.html +++ b/papi-dts/classes/_client_services_rpc_client_.default.html @@ -1,6 +1,6 @@ default | papi-dts

Manages the JSON-RPC protocol on the client end of a websocket that connects to main

Created by any process that connects to the websocket server owned by main

-

Implements

Constructors

Implements

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Methods

Methods

  • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

    • On clients: connecting to the server
    • @@ -19,19 +19,19 @@

    Parameters

    • localEventHandler: EventHandler

      Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -
  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

  • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between processes

    • event: T

      Event data to emit on the network

      -

    Returns void

  • Send a request and resolve after receiving a response

    +

Returns void

+
diff --git a/papi-dts/classes/_main_services_rpc_server_.default.html b/papi-dts/classes/_main_services_rpc_server_.default.html index 1e1830bdfc..4b1d757c5a 100644 --- a/papi-dts/classes/_main_services_rpc_server_.default.html +++ b/papi-dts/classes/_main_services_rpc_server_.default.html @@ -2,7 +2,7 @@ intended to be instantiated by anything other than RpcWebSocketListener.

Created by RpcWebSocketListener when a client connects to the web socket server. There is one RpcServer object per client that connects to the web socket server.

-

Implements

Constructors

Implements

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Methods

Methods

  • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

    • On clients: connecting to the server
    • On servers: opening an endpoint for clients to connect

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -
  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

  • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between processes

    • event: T

      Event data to emit on the network

      -

    Returns void

  • Send a request and resolve after receiving a response

    +

Returns void

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -
+
diff --git a/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html b/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html index 93d78e0e94..46a3450ace 100644 --- a/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html +++ b/papi-dts/classes/_main_services_rpc_websocket_listener_.default.html @@ -5,7 +5,7 @@ other processes will be tied to the RPCServer that services the connection for that other process.

Created by the main process on start up when the network service initializes

-

Implements

Constructors

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to +

Constructors

Properties

connectionStatus: ConnectionStatus

Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

-

Accessors

Methods

Accessors

Methods

  • Sets up the RPC handler by populating connector info, setting up event handlers, and doing one of the following:

    • On clients: connecting to the server
    • @@ -26,19 +26,19 @@

    Parameters

    • localEventHandler: EventHandler

      Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

    Returns Promise<boolean>

    Promise that resolves when finished connecting

    -
  • Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -

    Returns Promise<void>

  • Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Type Parameters

    • T

    Parameters

    • eventType: string

      Unique network event type for coordinating between processes

    • event: T

      Event data to emit on the network

      -

    Returns void

  • Send a request and resolve after receiving a response

    +

Returns void

  • Send a request and resolve after receiving a response

    Parameters

    • requestType: `${string}:${string}`

      Type of request (or "method" in JSONRPC jargon) to call

    • requestParams: RequestParams

      Parameters associated with this request

    Returns Promise<JSONRPCResponse>

    Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

    -
+
diff --git a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html index b6e5deacfb..5da20f0036 100644 --- a/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html +++ b/papi-dts/classes/_node_models_execution_token_model_.ExecutionToken.html @@ -1,8 +1,8 @@ ExecutionToken | papi-dts

Execution tokens can be passed into API calls to provide context about their identity

-

Implements

Constructors

Implements

Constructors

Properties

Methods

Constructors

Properties

name: string

Name of an extension

-
nonce: string
type

Methods

+

Constructors

Properties

name: string

Name of an extension

+
nonce: string
type

Methods

diff --git a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html index 9ab999a05c..c9f57856ff 100644 --- a/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_web_socket_service_.default.html @@ -2,7 +2,7 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

Note that the Node WebSocket implementation is different and not wrapped here.

-

Implements

Constructors

Implements

  • WebSocket

Constructors

Properties

addEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

+

Constructors

Properties

addEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

Can be set, to change how binary data is returned. The default is "blob".

MDN Reference

-
bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

+
bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)

MDN Reference

-
close: ((code?: number, reason?: string) => void)

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

+
close: ((code?: number, reason?: string) => void)

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

MDN Reference

-
CLOSED
CLOSING
CONNECTING
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

+
CLOSED
CLOSING
CONNECTING
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

-
extensions: string

Returns the extensions selected by the server, if any.

+
extensions: string

Returns the extensions selected by the server, if any.

MDN Reference

-
onclose: null | ((this: WebSocket, ev: CloseEvent) => any)
onerror: null | ((this: WebSocket, ev: Event) => any)
onmessage: null | ((this: WebSocket, ev: MessageEvent<any>) => any)
onopen: null | ((this: WebSocket, ev: Event) => any)
OPEN
protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

+
onclose: null | ((this: WebSocket, ev: CloseEvent) => any)
onerror: null | ((this: WebSocket, ev: Event) => any)
onmessage: null | ((this: WebSocket, ev: MessageEvent<any>) => any)
onopen: null | ((this: WebSocket, ev: Event) => any)
OPEN
protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

MDN Reference

-
readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

+
readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

MDN Reference

-
removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
send: ((data:
    | string
    | ArrayBufferLike
    | ArrayBufferView
    | Blob) => void)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

+
removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
send: ((data:
    | string
    | ArrayBufferLike
    | ArrayBufferView
    | Blob) => void)

Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

MDN Reference

-
url: string

Returns the URL that was used to establish the WebSocket connection.

+
url: string

Returns the URL that was used to establish the WebSocket connection.

MDN Reference

-
+
diff --git a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html index c6543a4e47..575c4c0ee0 100644 --- a/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html +++ b/papi-dts/classes/_renderer_services_renderer_xml_http_request_service_.default.html @@ -2,7 +2,7 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

Note that Node doesn't have a native implementation, so this is only for the renderer.

-

Implements

Constructors

Implements

  • XMLHttpRequest

Constructors

Properties

Constructors

Properties

abort: (() => void)

Cancels any network activity.

+

Constructors

Properties

abort: (() => void)

Cancels any network activity.

MDN Reference

-
addEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

+
addEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | AddEventListenerOptions) => void)
dispatchEvent: ((event: Event) => boolean)

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

-
DONE
getAllResponseHeaders: (() => string)
getResponseHeader: ((name: string) => null | string)
HEADERS_RECEIVED
LOADING
onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onreadystatechange: null | ((this: XMLHttpRequest, ev: Event) => any)
ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

Sets the request method, request URL, and synchronous flag.

+
DONE
getAllResponseHeaders: (() => string)
getResponseHeader: ((name: string) => null | string)
HEADERS_RECEIVED
LOADING
onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
onreadystatechange: null | ((this: XMLHttpRequest, ev: Event) => any)
ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)
open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

Sets the request method, request URL, and synchronous flag.

Throws a "SyntaxError" DOMException if either method is not a valid method or url cannot be parsed.

Throws a "SecurityError" DOMException if method is a case-insensitive match for CONNECT, TRACE, or TRACK.

Throws an "InvalidAccessError" DOMException if async is false, current global object is a Window object, and the timeout attribute is not zero or the responseType attribute is not the empty string.

MDN Reference

-
OPENED
overrideMimeType: ((mime: string) => void)

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

+
OPENED
overrideMimeType: ((mime: string) => void)

Acts as if the Content-Type header value for a response is mime. (It does not change the header.)

Throws an "InvalidStateError" DOMException if state is loading or done.

MDN Reference

-
readyState: number

Returns client's state.

+
readyState: number

Returns client's state.

MDN Reference

-
removeEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
response: any

Returns the response body.

+
removeEventListener: (<K>(type: K, listener: ((this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)
response: any

Returns the response body.

MDN Reference

-
responseText: string

Returns response as text.

+
responseText: string

Returns response as text.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "text".

MDN Reference

-
responseType: XMLHttpRequestResponseType

Returns the response type.

+
responseType: XMLHttpRequestResponseType

Returns the response type.

Can be set to change the response type. Values are: the empty string (default), "arraybuffer", "blob", "document", "json", and "text".

When set: setting to "document" is ignored if current global object is not a Window object.

When set: throws an "InvalidStateError" DOMException if state is loading or done.

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

MDN Reference

-
responseURL: string
responseXML: null | Document

Returns the response as document.

+
responseURL: string
responseXML: null | Document

Returns the response as document.

Throws an "InvalidStateError" DOMException if responseType is not the empty string or "document".

MDN Reference

-
send: ((body?: null | Document | XMLHttpRequestBodyInit) => void)

Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

+
send: ((body?: null | Document | XMLHttpRequestBodyInit) => void)

Initiates the request. The body argument provides the request body, if any, and is ignored if the request method is GET or HEAD.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

MDN Reference

-
setRequestHeader: ((name: string, value: string) => void)

Combines a header in author request headers.

+
setRequestHeader: ((name: string, value: string) => void)

Combines a header in author request headers.

Throws an "InvalidStateError" DOMException if either state is not opened or the send() flag is set.

Throws a "SyntaxError" DOMException if name is not a header name or if value is not a header value.

MDN Reference

-
status: number
statusText: string
timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and this's synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

+
status: number
statusText: string
timeout: number

Can be set to a time in milliseconds. When set to a non-zero value will cause fetching to terminate after the given time has passed. When the time has passed, the request has not yet completed, and this's synchronous flag is unset, a timeout event will then be dispatched, or a "TimeoutError" DOMException will be thrown otherwise (for the send() method).

When set: throws an "InvalidAccessError" DOMException if the synchronous flag is set and current global object is a Window object.

MDN Reference

-
UNSENT
upload: XMLHttpRequestUpload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

+
UNSENT
upload: XMLHttpRequestUpload

Returns the associated XMLHttpRequestUpload object. It can be used to gather transmission information when data is transferred to a server.

MDN Reference

-
withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

+
withCredentials: boolean

True when credentials are to be included in a cross-origin request. False when they are to be excluded in a cross-origin request and when cookies are to be ignored in its response. Initially false.

When set: throws an "InvalidStateError" DOMException if state is not unsent or opened, or if the send() flag is set.

MDN Reference

-
+
diff --git a/papi-dts/classes/_shared_log_error_model_.default.html b/papi-dts/classes/_shared_log_error_model_.default.html index fc2d899c33..67c7039e79 100644 --- a/papi-dts/classes/_shared_log_error_model_.default.html +++ b/papi-dts/classes/_shared_log_error_model_.default.html @@ -1,5 +1,5 @@ default | papi-dts

Error that force logs the error message before throwing. Useful for debugging in some situations.

-

Hierarchy

  • Error
    • default

Constructors

Hierarchy

  • Error
    • default

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
message: string
name: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
message: string
name: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stack?: string
stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html index 7cdf0c8c1b..d00e13a005 100644 --- a/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_base_project_data_provider_engine_model_.BaseProjectDataProviderEngine.html @@ -7,7 +7,7 @@

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

Type Parameters

Hierarchy (view full)

Constructors

Methods

Constructors

Methods

+

Parameters

Returns void

diff --git a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html index 8dffc2c171..4019e61593 100644 --- a/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html +++ b/papi-dts/classes/_shared_models_data_provider_engine_model_.DataProviderEngine.html @@ -2,7 +2,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Type Parameters

Hierarchy (view full)

Implements

Constructors

Methods

Constructors

Methods

  • Method to run to send clients updates for a specific data type outside of the set<data_type> method. papi overwrites this function on the DataProviderEngine itself to emit an update based on @@ -28,4 +28,4 @@

    @see DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Parameters

    Returns void

+

Parameters

Returns void

diff --git a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html index d196903388..d6e91c1846 100644 --- a/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html +++ b/papi-dts/classes/_shared_models_papi_network_event_emitter_model_.default.html @@ -7,7 +7,7 @@

WARNING: Do not use this class directly outside of NetworkService, or it will not do what you expect. Use NetworkService.createNetworkEventEmitter.

WARNING: You cannot emit events with complex types on the network.

-

Type Parameters

Hierarchy

Constructors

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

Properties

dispose emit subscribe @@ -19,23 +19,23 @@

Constructors

Properties

dispose: (() => Promise<boolean>)

Disposes of this event, preparing it to release from memory

-
emit: ((event: T) => void)

Runs the subscriptions for the event

+
    • (): void
    • Returns void

Returns "shared/models/papi-network-event-emitter.model".default<T>

Properties

dispose: (() => Promise<boolean>)

Disposes of this event, preparing it to release from memory

+
emit: ((event: T) => void)

Runs the subscriptions for the event

Type declaration

    • (event): void
    • Parameters

      • event: T

        Event data to provide to subscribed callbacks

        -

      Returns void

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+

Returns void

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Function to run with the event when it is emitted

Unsubscriber function to run to stop calling the passed-in function when the event is emitted

event

-

Accessors

  • get event(): PlatformEvent<T>
  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

Accessors

  • get event(): PlatformEvent<T>
  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. Use like const unsubscriber = event(callback)

    Returns PlatformEvent<T>

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    -

Methods

Methods

  • Disposes of this event, preparing it to release from memory. Added here so children can override emit and still call the base functionality.

    -

    Returns Promise<boolean>

  • Function that runs the subscriptions for the event. Added here so children can override emit +

    Returns Promise<boolean>

  • Function that runs the subscriptions for the event. Added here so children can override emit and still call the base functionality. See NetworkEventEmitter.emit for example

    -

    Parameters

    • event: T

    Returns void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    +

    Parameters

    • event: T

    Returns void

  • Runs only the subscriptions for the event that are on this process. Does not send over network

    Parameters

    • event: T

      Event data to provide to subscribed callbacks

      -

    Returns void

+

Returns void

diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html index ebcd172dc3..dd3386d71a 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_factory_model_.LayeringProjectDataProviderEngineFactory.html @@ -5,15 +5,15 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

-

Type Parameters

Constructors

Type Parameters

Constructors

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

-
projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces +

Returns "shared/models/project-data-provider-engine-factory.model".LayeringProjectDataProviderEngineFactory<SupportedProjectInterfaces>

Properties

pdpfId: string
pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

+
projectInterfacesToLayerOver: undefined | string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included in the available projects this Layering PDPF @@ -33,14 +33,14 @@

  • Include one
  • Include both two and three.
  • -
    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    +
    providedProjectInterfaces: SupportedProjectInterfaces

    The list of projectInterfaces that this layering PDPF provides on top of existing projects.

    providedProjectInterfaces: ['four', 'five'];
     

    This layering PDPF will announce that its provides the projectInterfaces four and five for projects that match projectInterfacesToLayerOver.

    -

    Methods

    Methods

    +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    diff --git a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html index b4b06b2774..d8434df1b5 100644 --- a/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html +++ b/papi-dts/classes/_shared_models_project_data_provider_engine_model_.ProjectDataProviderEngine.html @@ -7,7 +7,7 @@

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    Type Parameters

    Hierarchy (view full)

    Constructors

    Methods

    Constructors

    Methods

    +

    Parameters

    Returns void

    diff --git a/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html b/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html index ffeb4b9a02..139bb0e7d4 100644 --- a/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html +++ b/papi-dts/classes/_shared_models_web_view_factory_model_.WebViewFactory.html @@ -13,13 +13,13 @@ want to overwrite this class's getWebView because that will eliminate most of the benefits associated with using this class.

    IWebViewProvider for more information on extending this class.

    -

    Type Parameters

    Implements

    Constructors

    Type Parameters

    Implements

    Constructors

    Properties

    webViewType: WebViewType

    Methods

    Constructors

    Properties

    webViewType: WebViewType

    Methods

    • Creates a WebViewController that corresponds to the WebViewDefinition provided. WebViewFactory calls this as part of its getWebView. WebViewFactory will automatically register this controller with the web view provider service (papi.webViewProviders.registerWebViewController), run its dispose when the web view is @@ -37,15 +37,15 @@ web view controller created for this web view.

    Returns Promise<WebViewControllers[WebViewType]>

    Web view controller for the web view with the webViewDefinition provided. Or undefined if you do not want to create a web view controller for this web view.

    -
    • Disposes of all WVCs that were created by this provider

      -

      Returns Promise<boolean>

    • Disposes of all WVCs that were created by this provider

      +

      Returns Promise<boolean>

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      WebViewFactory calls this as part of its getWebView, which is called by the PAPI @@ -72,4 +72,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html b/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html index 5372e53540..5f102ee72d 100644 --- a/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html +++ b/papi-dts/classes/_shared_utils_project_settings_document_combiner_.default.html @@ -1,4 +1,4 @@ -default | papi-dts

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    Hierarchy (view full)

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -
    options: DocumentCombinerOptions
    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    -

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +
    options: DocumentCombinerOptions
    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    +

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered indeterminate as it depends on the order in which Map.forEach iterates over the contributions. However, the order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is is @@ -33,13 +33,13 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -

    Returns JsonDocumentLike

    Transformed contributed document

    -

    Returns JsonDocumentLike

    Returns void

    +

    Returns void

    diff --git a/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html b/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html index ef681a7f05..dbce475fc4 100644 --- a/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html +++ b/papi-dts/classes/_shared_utils_settings_document_combiner_base_.default.html @@ -1,4 +1,4 @@ -default | papi-dts

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    Hierarchy (view full)

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -
    options: DocumentCombinerOptions
    settingTypeName: string

    Name for type of setting to use in error messages

    -

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike>
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined>

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +
    options: DocumentCombinerOptions
    settingTypeName: string

    Name for type of setting to use in error messages

    +

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered indeterminate as it depends on the order in which Map.forEach iterates over the contributions. However, the order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is is @@ -31,13 +31,13 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -

    Returns JsonDocumentLike

    Transformed contributed document

    -

    Returns JsonDocumentLike

    Returns void

    +

    Returns void

    diff --git a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html index 92de5aee02..00dd063ab9 100644 --- a/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html +++ b/papi-dts/enums/_node_services_node_file_system_service_.EntryType.html @@ -1,5 +1,5 @@ EntryType | papi-dts

    Type of file system item in a directory

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Directory
    File
    Unknown
    +

    Enumeration Members

    Directory
    File
    Unknown
    diff --git a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html index c00fdfee66..763f574332 100644 --- a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html +++ b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html @@ -1,9 +1,9 @@ ConnectionStatus | papi-dts

    Whether an RPC object is setting up or has finished setting up its connection and is ready to communicate on the network

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    Connected

    Finished setting up its connection

    -
    Connecting

    Attempting to connect to the network

    -
    Disconnected

    Not connected to the network

    -
    +
    Connecting

    Attempting to connect to the network

    +
    Disconnected

    Not connected to the network

    +
    diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index 87a2035267..96b8187bf3 100644 --- a/papi-dts/enums/_shared_global_this_model_.ProcessType.html +++ b/papi-dts/enums/_shared_global_this_model_.ProcessType.html @@ -1,5 +1,5 @@ ProcessType | papi-dts

    Type of Paranext process

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    ExtensionHost
    Main
    Renderer
    +

    Enumeration Members

    ExtensionHost
    Main
    Renderer
    diff --git a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html index 0f8bdc17e1..9f570bc533 100644 --- a/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html +++ b/papi-dts/enums/_shared_models_elevated_privileges_model_.ElevatedPrivilegeNames.html @@ -1,4 +1,4 @@ ElevatedPrivilegeNames | papi-dts

    String constants that are listed in an extension's manifest.json to state needed privileges

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    createProcess
    manageExtensions
    +

    Enumeration Members

    createProcess
    manageExtensions
    diff --git a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html index c430affa23..caeb456c9a 100644 --- a/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html +++ b/papi-dts/enums/_shared_models_web_view_model_.WebViewContentType.html @@ -1,11 +1,11 @@ WebViewContentType | papi-dts

    The type of code that defines a webview's content

    -

    Enumeration Members

    Enumeration Members

    Enumeration Members

    HTML

    This webview is a raw HTML/JS/CSS webview.

    -
    React

    This webview is a React webview. It must specify its component by setting it to +

    React

    This webview is a React webview. It must specify its component by setting it to globalThis.webViewComponent

    -
    URL

    This webview's content is fetched from the url specified (iframe src attribute). Note that +

    URL

    This webview's content is fetched from the url specified (iframe src attribute). Note that webViews of this type cannot access the papi because they cannot be on the same origin as the parent window.

    -
    +
    diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index 3a1554d9af..c8068be6a3 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    This is just an alias for internet.fetch

    • Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    +

    Parameters

    Returns Promise<Response>

  • Parameters

    Returns Promise<Response>

  • diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index fc68c5b0f7..c6e540b07e 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    This is just an alias for internet.fetch

    • Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

    +

    Parameters

    Returns Promise<Response>

  • Parameters

    Returns Promise<Response>

  • diff --git a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html index dfdf4678fe..334e0c8cb5 100644 --- a/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html +++ b/papi-dts/functions/_client_services_web_socket_factory_.createWebSocket.html @@ -1,3 +1,3 @@ createWebSocket | papi-dts

    Creates a WebSocket for the renderer or extension host depending on where you're running

    • Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -
    +
    diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html index d872a19d9c..5a93d00832 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.buildExtensionPathFromName.html @@ -1,2 +1,2 @@ buildExtensionPathFromName | papi-dts
    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    +

    Parameters

    Returns string

    diff --git a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html index e99c367758..c2f2830611 100644 --- a/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html +++ b/papi-dts/functions/_extension_host_services_extension_storage_service_.setExtensionUris.html @@ -1,3 +1,3 @@ setExtensionUris | papi-dts
    • This is only intended to be called by the extension service. This service cannot call into the extension service or it causes a circular dependency.

      -

      Parameters

      • urisPerExtension: Map<string, string>

      Returns void

    +

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html index 3240cd562c..9e1829c060 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.copyFile.html @@ -5,4 +5,4 @@
  • Optionalmode: number

    Bitwise modifiers that affect how the copy works. See fsPromises.copyFile for more information

    -
  • Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html index 888989c66c..c7f772c263 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.createDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.createDir.html @@ -1,4 +1,4 @@ createDir | papi-dts
    • Create a directory in the file system if it does not exist. Does not throw if it already exists.

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves once the directory has been created

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html index 2ddaafc743..03e050bebe 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteDir.html @@ -1,4 +1,4 @@ deleteDir | papi-dts
    • Remove a directory and all its contents recursively from the file system

      Parameters

      • uri: string

        URI of directory

      Returns Promise<void>

      Promise that resolves when the delete operation finishes

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html index 0699b1d1ab..3c152c4506 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.deleteFile.html @@ -1,4 +1,4 @@ deleteFile | papi-dts
    • Delete a file if it exists

      Parameters

      • uri: string

        URI of file

      Returns Promise<void>

      Promise that resolves when the file is deleted or determined to not exist

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html index 49def23942..9d22c33b1a 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.getStats.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.getStats.html @@ -3,4 +3,4 @@

    Parameters

    Returns Promise<BigIntStats | undefined>

    Promise that resolves to object of type https://nodejs.org/api/fs.html#class-fsstats if file or directory exists, undefined if it doesn't

    -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html index 08b4bf7e36..c5718d90ca 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.moveFile.html @@ -1,4 +1,4 @@ moveFile | papi-dts
    • Moves a file from one location to another

      Parameters

      • sourceUri: string

        The location of the file to move

      • destinationUri: string

        The uri where the file should be moved

        -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html index f72e3dfd4f..0b95b75a80 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readDir.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readDir.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<DirectoryEntries>

    Map of entry type to list of uris for each entry in the directory with that type.

    -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html index 6af3e76a8f..081d3763f1 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileBinary.html @@ -1,4 +1,4 @@ readFileBinary | papi-dts
    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html index ba72c1dc85..cbb65d1083 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.readFileText.html @@ -1,4 +1,4 @@ readFileText | papi-dts
    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.touch.html b/papi-dts/functions/_node_services_node_file_system_service_.touch.html index ca3cb71fdb..a5748a484a 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.touch.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.touch.html @@ -1,4 +1,4 @@ touch | papi-dts
    • Set the last modified and accessed times for the file or directory

      Parameters

      • uri: string

        URI of file or directory

      • date: Date

      Returns Promise<void>

      Promise that resolves once the touch operation finishes

      -
    +
    diff --git a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html index 2d8266e0d0..74abedfd24 100644 --- a/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html +++ b/papi-dts/functions/_node_services_node_file_system_service_.writeFile.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<void>

    Promise that resolves after writing the file

    -
    +
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 6597b625b1..e525d288e0 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html @@ -1,4 +1,4 @@ createNonce | papi-dts
    +
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index 0cdbf4c8fb..d0106a82d4 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html +++ b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html @@ -1 +1 @@ -createUuid | papi-dts
    +createUuid | papi-dts
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html index ef2d8bd757..15dcd21a94 100644 --- a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html +++ b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html @@ -3,4 +3,4 @@
  • encodingType:
        | "base64"
        | "base64url"
        | "binary"
        | "hex"

    String encoding to use for returning the binary hash value that is calculated

  • buffer: Buffer

    Raw data to be fed into the hash algorithm

  • Returns string

    String encoded value of the digest (https://csrc.nist.gov/glossary/term/hash_digest)

    -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index 0136694459..7a96c21866 100644 --- a/papi-dts/functions/_node_utils_util_.getAppDir.html +++ b/papi-dts/functions/_node_utils_util_.getAppDir.html @@ -1,5 +1,5 @@ getAppDir | papi-dts

    Gets the platform-specific user Platform.Bible folder for this application

    When running in development: <repo_directory>/dev-appdata

    When packaged: <user_home_directory>/.platform.bible

    -

    Properties

    Properties

    Properties

    clear: (() => void)
    diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index 7a81bd6878..512cd3f70d 100644 --- a/papi-dts/functions/_node_utils_util_.getPathFromUri.html +++ b/papi-dts/functions/_node_utils_util_.getPathFromUri.html @@ -1,4 +1,4 @@ getPathFromUri | papi-dts
    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html index c695f91e71..d4184aca49 100644 --- a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html +++ b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html @@ -1,3 +1,3 @@ isNoisyDevModeEnvVariableSet | papi-dts

    FunctionisNoisyDevModeEnvVariableSet

    Determines if running in noisy dev mode

    • Returns boolean

      True if the process is running in noisy dev mode, false otherwise

      -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 5dd4d1c891..c7bfa85750 100644 --- a/papi-dts/functions/_node_utils_util_.joinUriPaths.html +++ b/papi-dts/functions/_node_utils_util_.joinUriPaths.html @@ -2,4 +2,4 @@

    Parameters

    Returns Uri

    One uri that combines the uri and the paths in left-to-right order

    -
    +
    diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index 139907465b..62a24f1b1a 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts
    +resolveHtmlPath | papi-dts
    diff --git a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html index fda2bef1a0..b553da8310 100644 --- a/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html +++ b/papi-dts/functions/_renderer_components_dialogs_dialog_base_data_.hookUpDialogService.html @@ -3,4 +3,4 @@ mitigate a dependency cycle

    Parameters

    Returns void

    +

    Returns void

    diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html index dc65d20bc4..f2b4943f7d 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_data_hook_util_.default.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns UseDataHookGeneric<TUseDataProviderParams>

    useData hook for getting data from a data provider

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html index 6617b9cb31..440ea9461f 100644 --- a/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html +++ b/papi-dts/functions/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.default.html @@ -9,4 +9,4 @@ (result of this hook, if you want this hook to just return the network object again)

    Returns ((...args: THookParams) => NetworkObject<object> | undefined)

    A function that takes in a networkObjectSource and returns a NetworkObject

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html index 44bc7e1f5c..42ec7a830e 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_hook_.default.html @@ -31,4 +31,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html index cdc5ea0083..9227767e69 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_hook_.default.html @@ -3,4 +3,4 @@ useDataProvider, if you want this hook to just return the data provider again)

    Returns undefined | DataProviders[DataProviderName]

    Undefined if the data provider has not been retrieved, data provider if it has been retrieved and is not disposed, and undefined again if the data provider is disposed

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html index c402f5ea80..7bbc0894ec 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.default.html @@ -9,4 +9,4 @@ dataProviderSources. Each item in the array will be (a) undefined if the data provider has not been retrieved or has been disposed, or (b) a data provider if it has been retrieved and is not disposed.

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html index f83e72a1c8..adc7d7ec9f 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.default.html @@ -59,7 +59,7 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook -
  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will +

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will open a dialog with the provided dialogType and options then run the resolveCallback with the dialog response or rejectCallback if there is an error. By default, only one dialog can be open at a time.

    @@ -105,4 +105,4 @@ specify as many or as few properties here as you want to overwrite the properties in the options you provide to the hook
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html index 8fed720a5f..8d33f86b3a 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_localized_strings_hook_.default.html @@ -15,4 +15,4 @@
  • localizedStrings: The current state of the localizations, either defaultState or the stored state on the papi, if any
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html index 7ef11208f0..856217ade5 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_hook_.default.html @@ -39,4 +39,4 @@
  • isLoading: whether the data with the data type and selector is awaiting retrieval from the data provider
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html index 19945bd464..e81598b426 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.default.html @@ -12,4 +12,4 @@

    Returns undefined | ProjectDataProviderInterfaces[ProjectInterface]

    undefined if the Project Data Provider has not been retrieved, the requested Project Data Provider if it has been retrieved and is not disposed, and undefined again if the Project Data Provider is disposed

    -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html index 87e50c7ec0..db46d68f2a 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_project_setting_hook_.default.html @@ -30,4 +30,4 @@ setting
  • isLoading: whether the setting value is awaiting retrieval from the Project Data Provider
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html index b4781f5eb5..8ad2dedf68 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.default.html @@ -22,4 +22,4 @@
  • setScrollGroupId: Function to use to update the scroll group with which this scrollGroupScrRef is synced
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html index 20110e15d8..0ba3418fa2 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_setting_hook_.default.html @@ -18,4 +18,4 @@
  • setSetting: Function that updates the setting to a new value
  • resetSetting: Function that removes the setting and resets the value to defaultState
  • -
    +
    diff --git a/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html b/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html index 7e5b649892..07f8201688 100644 --- a/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html +++ b/papi-dts/functions/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.default.html @@ -9,4 +9,4 @@

    Returns undefined | NetworkObject<WebViewControllers[WebViewType]>

    undefined if the Web View Controller has not been retrieved, the requested Web View Controller if it has been retrieved and is not disposed, and undefined again if the Web View Controller is disposed

    -
    +
    diff --git a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html index bc43c06a9c..b074e3821a 100644 --- a/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html +++ b/papi-dts/functions/_renderer_services_renderer_web_socket_service_.blockWebSocketsToPapiNetwork.html @@ -1,2 +1,2 @@ blockWebSocketsToPapiNetwork | papi-dts

    Once our network is running, run this to stop extensions from connecting to it directly

    -
    +
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html index 3a6b4843b5..e044b90951 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.getScrRefSync.html @@ -1,2 +1,2 @@ getScrRefSync | papi-dts
    • See IScrollGroupRemoteService.getScrRef

      -

      Parameters

      • OptionalscrollGroupId: number

      Returns ScriptureReference

    +

    Parameters

    Returns ScriptureReference

    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html index 6fcc6d7036..e8fa220c79 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.onDidUpdateScrRef.html @@ -1,2 +1,2 @@ onDidUpdateScrRef | papi-dts

    Event that emits with information about a changed Scripture Reference for a scroll group

    -
    +
    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html index 33717866a4..c429967545 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.setScrRefSync.html @@ -2,4 +2,4 @@

    Parameters

    Returns boolean

    +

    Returns boolean

    diff --git a/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html b/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html index 13cf7adff3..cd0f13cf7d 100644 --- a/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html +++ b/papi-dts/functions/_renderer_services_scroll_group_service_host_.startScrollGroupService.html @@ -1,2 +1,2 @@ startScrollGroupService | papi-dts
    • Register the network object that backs the scroll group service

      -

      Returns Promise<void>

    +

    Returns Promise<void>

    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html index 415695d4fc..208c3e2c6c 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html @@ -4,4 +4,4 @@
  • OptionalrequestId: RequestId

    ID of the request that this response is intended to address. If no ID was provided, don't pass a value to this parameter.

  • Returns JSONRPCErrorResponse

    JSONRPCErrorResponse message that can be serialized and sent over a connection

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html index 5c5bb9d510..bf29d174b5 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html @@ -3,4 +3,4 @@
  • requestParams: RequestParams

    Parameters to pass along when the request is processed

  • requestId: RequestId

    Unique ID for this connection of this request

  • Returns JSONRPCRequest

    JSONRPCRequest message that can be serialized and sent over a connection

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html index 104ff69c24..ba1775405e 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html @@ -3,4 +3,4 @@
  • OptionalrequestId: RequestId

    ID of the request that this response is intended to address. If no ID was provided, don't pass a value to this parameter.

  • Returns JSONRPCSuccessResponse

    JSONRPCSuccessResponse message that can be serialized and sent over a connection

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html index ca6d79c956..53e98a844d 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html +++ b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html @@ -4,4 +4,4 @@ must not be converted to undefined per the JSONRPC protocol.

    After a request has been processed by the protocol stack, call fixupResponse to restore undefined responses.

    -

    Parameters

    Returns JSONRPCRequest | JSONRPCResponse | (JSONRPCRequest | JSONRPCResponse)[]

    +

    Parameters

    Returns JSONRPCRequest | JSONRPCResponse | (JSONRPCRequest | JSONRPCResponse)[]

    diff --git a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html index 4a0ab06264..6803cda02e 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html +++ b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html @@ -1,4 +1,4 @@ fixupResponse | papi-dts
    • Convert null results back to undefined once we're out of the protocol stack.

      This works in tandem with deserializeMessage to properly handle null values in JSONRPC messages.

      -

      Parameters

      • response: JSONRPCResponse

      Returns JSONRPCResponse

    +

    Parameters

    Returns JSONRPCResponse

    diff --git a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html index 242d81144b..a9ca530f03 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html +++ b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html @@ -5,4 +5,4 @@
  • name: string

    Name of the handler running this request for logging purposes

  • requestType: string

    Type of request for logging purposes

  • Returns Promise<JSONRPCResponse>

    The response from the request including the method not found error if it times out

    -
    +
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html index a89c91dcbe..fd37ce340e 100644 --- a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html +++ b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html @@ -1,2 +1,2 @@ sendPayloadToWebSocket | papi-dts
    • Serialize a payload, if needed, and send it over the provided WebSocket

      -

      Parameters

      • ws: undefined | WebSocket
      • payload: unknown

      Returns void

    +

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html index df10dd22fb..2885c45902 100644 --- a/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html +++ b/papi-dts/functions/_shared_models_data_provider_model_.getDataProviderDataTypeFromFunctionName.html @@ -1,4 +1,4 @@ getDataProviderDataTypeFromFunctionName | papi-dts
    +
    diff --git a/papi-dts/functions/_shared_models_openrpc_model_.createEmptyOpenRpc.html b/papi-dts/functions/_shared_models_openrpc_model_.createEmptyOpenRpc.html index fb8c755da8..6414e4683b 100644 --- a/papi-dts/functions/_shared_models_openrpc_model_.createEmptyOpenRpc.html +++ b/papi-dts/functions/_shared_models_openrpc_model_.createEmptyOpenRpc.html @@ -1,2 +1,2 @@ createEmptyOpenRpc | papi-dts
    +

    Parameters

    Returns OpenRpc

    diff --git a/papi-dts/functions/_shared_models_openrpc_model_.getEmptyMethodDocs.html b/papi-dts/functions/_shared_models_openrpc_model_.getEmptyMethodDocs.html index e4fc132550..35042737dd 100644 --- a/papi-dts/functions/_shared_models_openrpc_model_.getEmptyMethodDocs.html +++ b/papi-dts/functions/_shared_models_openrpc_model_.getEmptyMethodDocs.html @@ -1,3 +1,3 @@ getEmptyMethodDocs | papi-dts
    +

    Returns MethodDocumentationWithoutName

    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html index abf914e18f..bc534dc9f5 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.areProjectInterfacesIncluded.html @@ -15,4 +15,4 @@ expressions defining which interfaces should be excluded.

    Returns boolean

    A boolean value indicating whether the project interfaces satisfy the inclusion and exclusion criteria.

    -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html index 62efc6f9d7..ea57182bea 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.compareProjectDataProviderFactoryMetadataInfoMinimalMatch.html @@ -5,4 +5,4 @@

    Parameters

    Returns -1 | 0 | 1

    -1 if a is less than b, 0 if equal, and 1 otherwise

    -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html index 2e069657f7..ff700d07ab 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryIdFromNetworkObjectName.html @@ -1,4 +1,4 @@ getPDPFactoryIdFromNetworkObjectName | papi-dts
    • Transform a network object id for a pdp factory into its well-known pdp factory id

      Parameters

      • pdpFactoryNetworkObjectName: string

        Id for then network object for this pdp factory

      Returns string

      Id extensions use to identify this pdp factory

      -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html index 85ad480428..8b440e5220 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.getPDPFactoryNetworkObjectNameFromId.html @@ -1,4 +1,4 @@ getPDPFactoryNetworkObjectNameFromId | papi-dts
    • Transform the well-known pdp factory id into an id for its network object to use

      Parameters

      • pdpFactoryId: string

        Id extensions use to identify this pdp factory

      Returns string

      Id for then network object for this pdp factory

      -
    +
    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html index 8005101952..5063302b7f 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.internalGetMetadata.html @@ -4,4 +4,4 @@ provided by the PDP Factory with the matching id (or all PDP Factories if no id is specified) for the project will be returned. If you need projectInterfaces supported by specific PDP Factories, you can access it at ProjectMetadata.pdpFactoryInfo.

    -

    Parameters

    Returns Promise<ProjectMetadata[]>

    +

    Parameters

    Returns Promise<ProjectMetadata[]>

    diff --git a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html index 6df8879c55..9416f0d74a 100644 --- a/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html +++ b/papi-dts/functions/_shared_models_project_lookup_service_model_.transformGetMetadataForProjectParametersToFilter.html @@ -1 +1 @@ -transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

      • OptionalprojectId: string
      • OptionalprojectInterface: keyof ProjectDataProviderInterfaces
      • OptionalpdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    +transformGetMetadataForProjectParametersToFilter | papi-dts
    • Parameters

      • OptionalprojectId: string
      • OptionalprojectInterface: keyof ProjectDataProviderInterfaces
      • OptionalpdpFactoryId: string

      Returns {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

      • includePdpFactoryIds: string | undefined
      • includeProjectIds: string | undefined
      • includeProjectInterfaces: string | undefined
    diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index 0a97298601..6de12cac79 100644 --- a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html +++ b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html @@ -3,4 +3,4 @@
    +
    diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index 27f02e1044..f47155f7fc 100644 --- a/papi-dts/functions/_shared_services_command_service_.registerCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.registerCommand.html @@ -7,4 +7,4 @@
  • handler: CommandHandlers[CommandName]

    Function to run when the command is invoked

  • OptionalcommandDocs: SingleMethodDocumentation
  • Returns Promise<UnsubscriberAsync>

    Promise that resolves if the command successfully registered and unsubscriber function to run to stop the passed-in function from handling commands

    -
    +
    diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index 9a9ce5e6d6..add35f11c4 100644 --- a/papi-dts/functions/_shared_services_command_service_.sendCommand.html +++ b/papi-dts/functions/_shared_services_command_service_.sendCommand.html @@ -1,2 +1,2 @@ sendCommand | papi-dts

    Send a command to the backend.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html index 37459f2071..f52d47ad68 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.getByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.getByType.html @@ -1,4 +1,4 @@ getByType | papi-dts
    • Get a data provider that has previously been set up

      Type Parameters

      Parameters

      • providerName: string

        Name of the desired data provider

      Returns Promise<T | undefined>

      The data provider with the given name if one exists, undefined otherwise

      -
    +
    diff --git a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html index 9760ab60b4..84b3db7d84 100644 --- a/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html +++ b/papi-dts/functions/_shared_services_data_provider_service_.registerEngineByType.html @@ -12,4 +12,4 @@ set methods are layered over to facilitate data provider subscriptions.

    Returns Promise<IDisposableDataProvider<"shared/models/data-provider.interface".default<TDataTypes>>>

    The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 345f7ff490..a3c0347082 100644 --- a/papi-dts/functions/_shared_services_logger_service_.formatLog.html +++ b/papi-dts/functions/_shared_services_logger_service_.formatLog.html @@ -3,4 +3,4 @@
  • serviceName: string

    Name of the service to show in the log

  • Optionaltag: string

    Optional tag at the end of the service name

  • Returns string

    Formatted string of a service message

    -
    +
    diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html index bbeafa0d4d..db145d1bd5 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidCreateNetworkObject.html @@ -1,3 +1,3 @@ onDidCreateNetworkObject | papi-dts

    Event that fires when a new object has been created on the network (locally or remotely). The event contains information about the new network object.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html index f16c253043..17a39c62a3 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html +++ b/papi-dts/functions/_shared_services_network_object_service_.onDidDisposeNetworkObject.html @@ -1,2 +1,2 @@ onDidDisposeNetworkObject | papi-dts

    Event that fires with a network object ID when that object is disposed locally or remotely

    -
    • Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    +
    diff --git a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html index c722493b77..37c6341d44 100644 --- a/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html +++ b/papi-dts/functions/_shared_services_network_object_service_.overrideDispose.html @@ -1,2 +1,2 @@ overrideDispose | papi-dts
    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    +

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index 136a05c922..1ba4806f65 100644 --- a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html +++ b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html @@ -4,4 +4,4 @@ emitters.

    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index 301c3855bb..8646ad565d 100644 --- a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html +++ b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html @@ -3,4 +3,4 @@
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index d2c9c7aa17..f942172c9a 100644 --- a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html +++ b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html @@ -1,4 +1,4 @@ getNetworkEvent | papi-dts

    Gets the network event with the specified type. Creates the emitter if it does not exist

    • Type Parameters

      • T

      Parameters

      • eventType: string

        Unique network event type for coordinating between connections

      Returns PlatformEvent<T>

      Event for the event type that runs the callback provided when the event is emitted

      -
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index a9dca19ec6..25f8933e1e 100644 --- a/papi-dts/functions/_shared_services_network_service_.initialize.html +++ b/papi-dts/functions/_shared_services_network_service_.initialize.html @@ -1 +1 @@ -initialize | papi-dts
    +initialize | papi-dts
    diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index a5ac70cbac..93fb8e19d6 100644 --- a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html +++ b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html @@ -2,4 +2,4 @@

    Parameters

    Returns Promise<UnsubscriberAsync>

    Promise that resolves if the request successfully registered and unsubscriber function to run to stop the passed-in function from handling requests

    -
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index d0434caa8f..bfa5b14478 100644 --- a/papi-dts/functions/_shared_services_network_service_.request.html +++ b/papi-dts/functions/_shared_services_network_service_.request.html @@ -2,4 +2,4 @@
    +
    diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index f0ce458b83..b369103299 100644 --- a/papi-dts/functions/_shared_services_network_service_.shutdown.html +++ b/papi-dts/functions/_shared_services_network_service_.shutdown.html @@ -1,2 +1,2 @@ shutdown | papi-dts

    Closes the network services gracefully

    -
    +
    diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html index 13aa8faf98..e7b9fd1422 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.get.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.get.html @@ -13,4 +13,4 @@

    If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

    -
    +
    diff --git a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html index 940c678418..6bb537c7fa 100644 --- a/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html +++ b/papi-dts/functions/_shared_services_project_data_provider_service_.registerProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ should be available on the PDPEs created by this factory.

  • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

    Used in a ProjectDataProviderFactory to create ProjectDataProviders

  • Returns Promise<Dispose>

    Promise that resolves to a disposable object when the registration operation completes

    -
    +
    diff --git a/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html b/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html index 52bcde6160..ade55b6455 100644 --- a/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html +++ b/papi-dts/functions/_shared_services_project_settings_service_.filterProjectSettingsContributionsByProjectInterfaces.html @@ -7,4 +7,4 @@ contributions by.

    Returns Localized<ProjectSettingsContributionInfo["contributions"]> | undefined

    A filtered set of contributions, or undefined if no contributions match the project interfaces.

    -
    +
    diff --git a/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html b/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html index d23f40b771..53124b05e9 100644 --- a/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html +++ b/papi-dts/functions/_shared_services_rpc_handler_factory_.createRpcHandler.html @@ -1,2 +1,2 @@ createRpcHandler | papi-dts

    Creates a server or client RPC handler depending on if we're in main or some other process

    -
    +
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html index c3e49ca184..22f68569b5 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewController.html @@ -1 +1 @@ -getWebViewController | papi-dts
    +getWebViewController | papi-dts
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html index ab40d697c1..f40b3be5f5 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewControllerObjectId.html @@ -1,2 +1,2 @@ getWebViewControllerObjectId | papi-dts

    Gets the id for the web view controller network object with the given name

    -
    +
    diff --git a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html index 6d67512703..fb6f40f21a 100644 --- a/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html +++ b/papi-dts/functions/_shared_services_web_view_service_model_.getWebViewMessageRequestType.html @@ -1,2 +1,2 @@ getWebViewMessageRequestType | papi-dts
    • Get request type for posting a message to a web view

      -

      Parameters

      • webViewId: string

      Returns `${string}:${string}`

    +

    Parameters

    Returns `${string}:${string}`

    diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index 9442ca8749..475a1a55eb 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html +++ b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html @@ -1,3 +1,3 @@ getProcessType | papi-dts

    Gets which kind of process this is (main, renderer, extension-host)

    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index a2713ddf38..dd0b076f65 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isClient.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isClient.html @@ -1,3 +1,3 @@ isClient | papi-dts

    Determine if running on a client process (renderer, extension-host) or on the server.

    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index 01ee721094..4d12f7d095 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html @@ -1,3 +1,3 @@ isExtensionHost | papi-dts

    Determine if running on the extension host

    • Returns boolean

      Returns true if running on the extension host, false otherwise

      -
    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index eba8c9ef92..b7e1ed1ebb 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html @@ -1,3 +1,3 @@ isRenderer | papi-dts

    Determine if running on the renderer process

    • Returns boolean

      Returns true if running on the renderer, false otherwise

      -
    +
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index ed4296c32f..dd354be04b 100644 --- a/papi-dts/functions/_shared_utils_internal_util_.isServer.html +++ b/papi-dts/functions/_shared_utils_internal_util_.isServer.html @@ -1,3 +1,3 @@ isServer | papi-dts

    Determine if running on the server process (main)

    +
    diff --git a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html index b4f2c74646..23f5dd1e9d 100644 --- a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html +++ b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html @@ -2,4 +2,4 @@ "this" in its functions refer to the object rather than the caller of the function. For example, if a function on the class is provided to a callback, if "this" isn't bound to the object then "this" will refer to the entity running the callback.

    -

    Type Parameters

    Parameters

    Returns void

    +

    Type Parameters

    Parameters

    Returns void

    diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index f53aab2850..7d584ae19b 100644 --- a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html @@ -1,2 +1,2 @@ deserializeRequestType | papi-dts
    +

    Parameters

    Returns RequestType

    diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index 33b1ab2ac2..e57056b3f8 100644 --- a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html +++ b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html @@ -1,4 +1,4 @@ getModuleSimilarApiMessage | papi-dts
    • Get a message that says the module import was rejected and to try a similar api if available.

      Parameters

      • moduleName: string

        Name of required module that was rejected

      Returns string

      String that says the import was rejected and a similar api to try

      -
    +
    diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 4770200300..737a4b13b0 100644 --- a/papi-dts/functions/_shared_utils_util_.newNonce.html +++ b/papi-dts/functions/_shared_utils_util_.newNonce.html @@ -3,4 +3,4 @@

    WARNING: THIS IS NOT CURRENTLY CRYPTOGRAPHICALLY SECURE! TODO: Make this cryptographically random! Use some polymorphic library that works in all contexts? https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues only works in browser

    -

    Returns string

    +

    Returns string

    diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 7e3ecd8c13..fad03c40f2 100644 --- a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html +++ b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html @@ -2,4 +2,4 @@

    Parameters

    Returns SerializedRequestType

    Full requestType for use in network calls

    -
    +
    diff --git a/papi-dts/functions/getSavedWebViewDefinition.html b/papi-dts/functions/getSavedWebViewDefinition.html index 71fdd5ddd1..9315e6e5fb 100644 --- a/papi-dts/functions/getSavedWebViewDefinition.html +++ b/papi-dts/functions/getSavedWebViewDefinition.html @@ -1,4 +1,4 @@ getSavedWebViewDefinition | papi-dts

    FunctiongetSavedWebViewDefinition

    Gets the saved properties on this WebView's WebView definition

    @returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -
    +
    diff --git a/papi-dts/functions/getSavedWebViewDefinitionById.html b/papi-dts/functions/getSavedWebViewDefinitionById.html index e926fbf897..40f347560e 100644 --- a/papi-dts/functions/getSavedWebViewDefinitionById.html +++ b/papi-dts/functions/getSavedWebViewDefinitionById.html @@ -1 +1 @@ -getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    +getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index 96fc086f54..c27afc16c5 100644 --- a/papi-dts/functions/getWebViewState.html +++ b/papi-dts/functions/getWebViewState.html @@ -1,3 +1,3 @@ getWebViewState | papi-dts

    FunctiongetWebViewState

    Retrieve the value from web view state with the given 'stateKey', if it exists. Otherwise return default value

    -
    +
    diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index 00c2ef5829..51cef63c2b 100644 --- a/papi-dts/functions/resetWebViewState.html +++ b/papi-dts/functions/resetWebViewState.html @@ -1,2 +1,2 @@ resetWebViewState | papi-dts

    FunctionresetWebViewState

    Remove the value for a given key in the web view state

    -
    +
    diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index e0a2fa64eb..5e6b0e356f 100644 --- a/papi-dts/functions/setWebViewState.html +++ b/papi-dts/functions/setWebViewState.html @@ -1,2 +1,2 @@ setWebViewState | papi-dts

    FunctionsetWebViewState

    Set the value for a given key in the web view state.

    -
    • Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    +
    diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index ee06b96548..17db1b584a 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -7,4 +7,4 @@
    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -
    +
    diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index bc459ddc21..2bf4211b84 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    +updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    diff --git a/papi-dts/functions/useWebViewScrollGroupScrRef.html b/papi-dts/functions/useWebViewScrollGroupScrRef.html index 1a4a86f4be..e2af20ff8a 100644 --- a/papi-dts/functions/useWebViewScrollGroupScrRef.html +++ b/papi-dts/functions/useWebViewScrollGroupScrRef.html @@ -16,4 +16,4 @@
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
     
    -
    +
    diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index a17f6d4087..179abfa0c4 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -25,4 +25,4 @@
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    +
    diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 2fc6dc4985..245cf49836 100644 --- a/papi-dts/functions/webViewComponent.html +++ b/papi-dts/functions/webViewComponent.html @@ -1,7 +1,7 @@ webViewComponent | papi-dts

    FunctionwebViewComponent

    A function that each React WebView extension must provide for Paranext to display it. Only used in WebView iframes.

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html index ab86f383e2..b1d52930e4 100644 --- a/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html +++ b/papi-dts/interfaces/_extension_host_extension_types_extension_interface_.IExtension.html @@ -1,10 +1,10 @@ IExtension | papi-dts

    Interface for all extensions to implement

    -
    interface IExtension {
        activate: ((context: ExecutionActivationContext) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    interface IExtension {
        activate: ((context: ExecutionActivationContext) => Promise<void>);
        deactivate?: UnsubscriberAsync;
    }

    Properties

    activate: ((context: ExecutionActivationContext) => Promise<void>)

    Sets up this extension! Runs when paranext wants this extension to activate. For example, activate() should register commands for this extension

    Type declaration

      • (context): Promise<void>
      • Parameters

        Returns Promise<void>

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context +

    Returns Promise<void>

    deactivate?: UnsubscriberAsync

    Deactivate anything in this extension that is not covered by the registrations in the context object given to activate().

    Promise that resolves to true if successfully deactivated

    -
    +
    diff --git a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html index cd50673f98..1c1ef48e20 100644 --- a/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html +++ b/papi-dts/interfaces/_extension_host_services_extension_storage_service_.ExtensionStorageService.html @@ -1,4 +1,4 @@ -ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token: ExecutionToken, key: string) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>);
        readUserData: ((token: ExecutionToken, key: string) => Promise<string>);
        writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>);
    }

    Properties

    deleteUserData +ExtensionStorageService | papi-dts
    interface ExtensionStorageService {
        deleteUserData: ((token: ExecutionToken, key: string) => Promise<void>);
        readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>);
        readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>);
        readUserData: ((token: ExecutionToken, key: string) => Promise<string>);
        writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>);
    }

    Properties

    Parameters

    • token: ExecutionToken

      ExecutionToken provided to the extension when activate() was called

    • key: string

      Unique identifier of the data

    Returns Promise<void>

    Promise that will resolve if the data is deleted successfully

    -
    readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        +
    readBinaryFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<Buffer>)

    Type declaration

      • (token, fileName): Promise<Buffer>
      • Read a binary file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<Buffer>

        Promise for a Buffer with the contents of the file

        -
    readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        +
    readTextFileFromInstallDirectory: ((token: ExecutionToken, fileName: string) => Promise<string>)

    Type declaration

      • (token, fileName): Promise<string>
      • Read a text file from the the extension's installation directory

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • fileName: string

          Name of the file to be read

        Returns Promise<string>

        Promise for a string with the contents of the file

        -
    readUserData: ((token: ExecutionToken, key: string) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the +

    readUserData: ((token: ExecutionToken, key: string) => Promise<string>)

    Type declaration

      • (token, key): Promise<string>
      • Read data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        Returns Promise<string>

        Promise for a string containing the data

        -
    writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the +

    writeUserData: ((token: ExecutionToken, key: string, data: string) => Promise<void>)

    Type declaration

      • (token, key, data): Promise<void>
      • Write data specific to the user (as identified by the OS) and extension (as identified by the ExecutionToken)

        Parameters

        • token: ExecutionToken

          ExecutionToken provided to the extension when activate() was called

        • key: string

          Unique identifier of the data

        • data: string

          Data to be written

        Returns Promise<void>

        Promise that will resolve if the data is written successfully

        -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index 7e813fcf10..fb9fa74226 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -7,7 +7,7 @@
    declare module 'papi-shared-types' {
    export interface CommandHandlers {
    'myExtension.myCommand1': (foo: string, bar: number) => string;
    'myExtension.myCommand2': (foo: string) => Promise<void>;
    }
    }
    -
    interface CommandHandlers {
        platform.openDeveloperDocumentationUrl: (() => Promise<void>);
        platform.openProjectSettings: ((webViewId: string) => Promise<void>);
        platform.openSettings: ((webViewId?: string) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restart: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums: number[]) => number);
        test.echo: ((message: string) => string);
        test.echoExtensionHost: ((message: string) => Promise<string>);
        test.throwError: ((message: string) => void);
        test.throwErrorExtensionHost: ((message: string) => void);
    }
    interface CommandHandlers {
        platform.openDeveloperDocumentationUrl: (() => Promise<void>);
        platform.openProjectSettings: ((webViewId: string) => Promise<void>);
        platform.openSettings: ((webViewId?: string) => Promise<void>);
        platform.openUserSettings: (() => Promise<void>);
        platform.quit: (() => Promise<void>);
        platform.restart: (() => Promise<void>);
        platform.restartExtensionHost: (() => Promise<void>);
        test.addMany: ((...nums: number[]) => number);
        test.echo: ((message: string) => string);
        test.echoExtensionHost: ((message: string) => Promise<string>);
        test.throwError: ((message: string) => void);
        test.throwErrorExtensionHost: ((message: string) => void);
    }

    Properties

    platform.openDeveloperDocumentationUrl: (() => Promise<void>)

    Open a browser to the platform's OpenRPC documentation

    -
    platform.openProjectSettings: ((webViewId: string) => Promise<void>)

    3 December 2024. Renamed to platform.openSettings

    -
    platform.openSettings: ((webViewId?: string) => Promise<void>)
    platform.openUserSettings: (() => Promise<void>)

    3 December 2024. Renamed to platform.openSettings

    -
    platform.quit: (() => Promise<void>)

    Shut down the application

    -
    platform.restart: (() => Promise<void>)

    Restart the application

    -
    platform.restartExtensionHost: (() => Promise<void>)
    test.addMany: ((...nums: number[]) => number)
    test.echo: ((message: string) => string)
    test.echoExtensionHost: ((message: string) => Promise<string>)
    test.throwError: ((message: string) => void)
    test.throwErrorExtensionHost: ((message: string) => void)
    +
    platform.openProjectSettings: ((webViewId: string) => Promise<void>)

    3 December 2024. Renamed to platform.openSettings

    +
    platform.openSettings: ((webViewId?: string) => Promise<void>)
    platform.openUserSettings: (() => Promise<void>)

    3 December 2024. Renamed to platform.openSettings

    +
    platform.quit: (() => Promise<void>)

    Shut down the application

    +
    platform.restart: (() => Promise<void>)

    Restart the application

    +
    platform.restartExtensionHost: (() => Promise<void>)
    test.addMany: ((...nums: number[]) => number)
    test.echo: ((message: string) => string)
    test.echoExtensionHost: ((message: string) => Promise<string>)
    test.throwError: ((message: string) => void)
    test.throwErrorExtensionHost: ((message: string) => void)
    diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index cdb8695e27..ece36d4336 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -11,6 +11,6 @@
    declare module 'papi-shared-types' {
    export type PeopleDataTypes = {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    };

    export type PeopleDataMethods = {
    deletePerson(name: string): Promise<boolean>;
    testRandomMethod(things: string): Promise<string>;
    };

    export type PeopleDataProvider = IDataProvider<PeopleDataTypes> & PeopleDataMethods;

    export interface DataProviders {
    'helloSomeone.people': PeopleDataProvider;
    }
    }
    -
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Properties

    +

    Properties

    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index 4e9ef4133a..0eedfd3084 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -34,10 +34,10 @@
    declare module 'papi-shared-types' {
    export type MyBaseProjectDataTypes = {
    MyProjectData: DataProviderDataType<string, string, string>;
    };

    export type MyLayeringProjectDataTypes = {
    MyOtherProjectData: DataProviderDataType<number, number, number>;
    };

    export interface ProjectDataProviderInterfaces {
    // Note that the base PDP implements `I**Base**ProjectDataProvider`
    MyExtensionBaseProjectInterface: IBaseProjectDataProvider<MyProjectDataTypes>;
    // Note that the layering PDP only implements `IProjectDataProvider` because the base PDP already
    // provides the `platform.base` data types
    MyExtensionLayeringProjectInterface: IProjectDataProvider<MyLayeringProjectDataTypes>;
    }
    }
    -
    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    interface ProjectDataProviderInterfaces {
        platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>;
        platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>;
        platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>;
    }

    Properties

    Base projectInterface that all PDPs that expose their own unique project ids must implement.

    There should be a PDP that provides platform.base for all available project ids.

    -
    +
    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>
    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>
    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index c1936422d0..2dbd6e1172 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -10,7 +10,7 @@
    declare module 'papi-shared-types' {
    export interface ProjectSettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.isEditable: boolean;
        platform.language: string;
        platform.name: string;
    }

    Properties

    interface ProjectSettingTypes {
        platform.fullName: string;
        platform.isEditable: boolean;
        platform.language: string;
        platform.name: string;
    }

    Properties

    'World English Bible'
     
    -
    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it +

    platform.isEditable: boolean

    Whether or not the project is editable. This is a general "editable", not necessarily that it is editable by the current user.

    Projects that are not editable are sometimes called "resources".

    -
    platform.language: string

    Localized name of the language in which this project is written. This will be displayed +

    platform.language: string

    Localized name of the language in which this project is written. This will be displayed directly in the UI.

    'English'
     
    -
    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the +

    platform.name: string

    Short name of the project (not necessarily unique). This will be displayed directly in the UI.

    'WEB'
     
    -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 4a3eadbff5..bcc444b8a3 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -9,19 +9,19 @@
    declare module 'papi-shared-types' {
    export interface SettingTypes {
    'myExtension.highlightColor': string | { r: number; g: number; b: number };
    }
    }
    -
    interface SettingTypes {
        platform.commentsEnabled: boolean;
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }
    interface SettingTypes {
        platform.commentsEnabled: boolean;
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.commentsEnabled: boolean

    Enable reading and writing comments in projects. This is an experimental feature.

    -
    platform.interfaceLanguage: string[]

    List of locales to use when localizing the interface. First in the list receives highest +

    platform.interfaceLanguage: string[]

    List of locales to use when localizing the interface. First in the list receives highest priority. Please always add 'en' (English) at the end when using this setting so everything localizes to English if it does not have a localization in a higher-priority locale.

    -
    platform.paratextDataLastRegistryDataCachedTimes: {
        [key: string]: string;
    }

    Tracking last S/R registry data cache time managed in the dotnet process and used for +

    platform.paratextDataLastRegistryDataCachedTimes: {
        [key: string]: string;
    }

    Tracking last S/R registry data cache time managed in the dotnet process and used for interacting with ParatextData.

    -
    platform.ptxUtilsMementoData: {
        [key: string]: string;
    }

    Mementos managed in the dotnet process and used for interacting with PtxUtils. Mementos are +

    platform.ptxUtilsMementoData: {
        [key: string]: string;
    }

    Mementos managed in the dotnet process and used for interacting with PtxUtils. Mementos are persisted objects containing some data. They are stored as xml strings.

    -
    platform.verseRef: ScriptureReference

    Current Verse Reference for Scroll Group A. Deprecated - please use papi.scrollGroups and +

    platform.verseRef: ScriptureReference

    Current Verse Reference for Scroll Group A. Deprecated - please use papi.scrollGroups and useWebViewScrollGroupScrRef

    -
    +
    diff --git a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html index fba8253168..3b696b767b 100644 --- a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html +++ b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html @@ -18,6 +18,6 @@
    declare module 'papi-shared-types' {
    export type PeopleWebViewController = NetworkableObject<{
    setSelectedPerson(name: string): Promise<boolean>;
    testRandomMethod(things: string): Promise<string>;
    }>;

    export interface WebViewControllers {
    'helloSomeone.peopleWebView': PeopleWebViewController;
    }
    }
    -
    interface WebViewControllers {
        platform.placeholderWebView: NetworkableObject<{
            runPlaceholderStuff(thing: string): Promise<boolean>;
        }>;
        platform.stuffWebView: NetworkableObject<{
            doStuff(thing: string): Promise<boolean>;
        }>;
    }
    interface WebViewControllers {
        platform.placeholderWebView: NetworkableObject<{
            runPlaceholderStuff(thing: string): Promise<boolean>;
        }>;
        platform.stuffWebView: NetworkableObject<{
            doStuff(thing: string): Promise<boolean>;
        }>;
    }

    Properties

    platform.placeholderWebView: NetworkableObject<{
        runPlaceholderStuff(thing: string): Promise<boolean>;
    }>
    platform.stuffWebView: NetworkableObject<{
        doStuff(thing: string): Promise<boolean>;
    }>
    +

    Properties

    platform.placeholderWebView: NetworkableObject<{
        runPlaceholderStuff(thing: string): Promise<boolean>;
    }>
    platform.stuffWebView: NetworkableObject<{
        doStuff(thing: string): Promise<boolean>;
    }>
    diff --git a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html index dba219e788..294cc98d4e 100644 --- a/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html +++ b/papi-dts/interfaces/_renderer_components_dialogs_dialog_definition_model_.DialogTypes.html @@ -1,7 +1,7 @@ DialogTypes | papi-dts

    Mapped type for dialog functions to use in getting various types for dialogs

    Keys should be dialog names, and values should be DialogDataTypes

    If you add a dialog here, you must also add it on DIALOGS

    -

    Properties

    Properties

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    +

    Properties

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>
    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>
    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>
    diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html index 5a7923d426..0162a75a24 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.FloatLayout.html @@ -1,6 +1,6 @@ FloatLayout | papi-dts

    Information about a floating window

    -
    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    interface FloatLayout {
        floatSize?: FloatSize;
        position?: FloatPosition;
        type: "float";
    }

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -
    type
    +

    Properties

    floatSize?: FloatSize
    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +
    type
    diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html index a22db77a64..9bc4259d1a 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.PanelLayout.html @@ -1,6 +1,6 @@ PanelLayout | papi-dts

    Information about a panel

    -
    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    interface PanelLayout {
        direction?: PanelDirection;
        targetTabId?: string;
        type: "panel";
    }

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    -
    type
    +

    Properties

    direction?: PanelDirection
    targetTabId?: string

    If undefined, it will add in the direction relative to the previously added tab.

    +
    type
    diff --git a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html index 62f5f5c984..12d22563ae 100644 --- a/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html +++ b/papi-dts/interfaces/_shared_models_docking_framework_model_.TabLayout.html @@ -1,3 +1,3 @@ TabLayout | papi-dts

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type
    +
    interface TabLayout {
        type: "tab";
    }

    Properties

    Properties

    type
    diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html index ef25cc4947..81b8202748 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusRemoteServiceType.html @@ -1,5 +1,5 @@ -NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts
    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Get details about all available network objects

    Type declaration

    +
    diff --git a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html index 9c90a8ef43..2d22929363 100644 --- a/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html +++ b/papi-dts/interfaces/_shared_models_network_object_status_service_model_.NetworkObjectStatusServiceType.html @@ -1,10 +1,10 @@ NetworkObjectStatusServiceType | papi-dts

    Provides functions related to the set of available network objects

    -
    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

    interface NetworkObjectStatusServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
        waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>)

    Get details about all available network objects

    Type declaration

    waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>)

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    +
    waitForNetworkObject: ((objectDetailsToMatch: Partial<NetworkObjectDetails>, timeoutInMS?: number) => Promise<NetworkObjectDetails>)

    Get a promise that resolves when a network object is registered or rejects if a timeout is hit

    Type declaration

      • (objectDetailsToMatch, timeoutInMS?): Promise<NetworkObjectDetails>
      • Parameters

        • objectDetailsToMatch: Partial<NetworkObjectDetails>

          Subset of object details on the network object to wait for. Compared to object details using isSubset

        • OptionaltimeoutInMS: number

          Max duration to wait for the network object. If not provided, it will wait @@ -12,4 +12,4 @@

        Returns Promise<NetworkObjectDetails>

        Promise that either resolves to the NetworkObjectDetails for a network object once the network object is registered, or rejects if a timeout is provided and the timeout is reached before the network object is registered

        -
    +
    diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html index 7f75028b40..a5c5cd3cbf 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_engine_factory_model_.IProjectDataProviderEngineFactory.html @@ -20,7 +20,7 @@

    To make creating a Layering PDPF easier, you can extend LayeringProjectDataProviderEngineFactory, which automatically fulfills the special requirements for Layering PDPFs. We highly recommend using it.

    -
    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId: string): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    interface IProjectDataProviderEngineFactory<SupportedProjectInterfaces> {
        createProjectDataProviderEngine(projectId: string): Promise<IProjectDataProviderEngine<SupportedProjectInterfaces>>;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
    }

    Type Parameters

    Methods

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -46,4 +46,4 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    diff --git a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html index 00c73b49e2..edfcfddf00 100644 --- a/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html +++ b/papi-dts/interfaces/_shared_models_project_data_provider_factory_interface_.default.html @@ -6,11 +6,11 @@ and provide additional projectInterfaces on those projects (Layering PDP Factory). Base PDP Factories must create PDPs that support the platform.base projectInterface. See IBaseProjectDataProvider and ProjectDataProviderInterfaces for more information.

    -
    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId: string): Promise<string>;
    }

    Hierarchy

    Properties

    interface default {
        dispose: UnsubscriberAsync;
        getAvailableProjects(layeringFilters?: ProjectMetadataFilterOptions): Promise<ProjectMetadataWithoutFactoryInfo[]>;
        getProjectDataProviderId(projectId: string): Promise<string>;
    }

    Hierarchy

    • Dispose
      • default

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    Methods

    • Get metadata about all projects that can be served by PDPs created by this PDP factory.

      If this is a Base PDP Factory, this method should return this PDP Factory's own unique project IDs.

      If this is a Layering PDP Factory, this method should call @@ -28,11 +28,11 @@ calling papi.projectLookup.getMetadataForAllProjects inside this method. If you are not calling getMetadataForAllProjects inside this method (likely if this is a Base PDPF), you can safely ignore this parameter.

      -

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    +
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html index 21636914ed..900e95bbc6 100644 --- a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html +++ b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html @@ -4,7 +4,7 @@ really just the name of a method in JSONRPC. So "method names" and "request types" are treated as the same thing. Similarly, what we call a "request handler" is the same thing as a "method" that has been registered with a JSONRPC server.

    -
    interface IRpcHandler {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    interface IRpcHandler {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    Type declaration

      • (localEventHandler): Promise<boolean>
      • Parameters

        • localEventHandler: EventHandler

          Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

        Returns Promise<boolean>

        Promise that resolves when finished connecting

        -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    +
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -
    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Unique network event type for coordinating between processes

    Event data to emit on the network

    -
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    +
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    Type declaration

      • (requestType, requestParams): Promise<JSONRPCResponse>
      • Parameters

        • requestType: `${string}:${string}`

          Type of request (or "method" in JSONRPC jargon) to call

        • requestParams: RequestParams

          Parameters associated with this request

        Returns Promise<JSONRPCResponse>

        Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

        -
    +
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html index a507dec12a..416ea1eb33 100644 --- a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html +++ b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html @@ -5,7 +5,7 @@ really just the name of a method in JSONRPC. So "method names" and "request types" are treated as the same thing. Similarly, what we call a "request handler" is the same thing as a "method" that has been registered with a JSONRPC server.

    -
    interface IRpcMethodRegistrar {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        registerMethod: ((methodName: string, method: InternalRequestHandler, methodDocs?: SingleMethodDocumentation) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    interface IRpcMethodRegistrar {
        connect: ((localEventHandler: EventHandler) => Promise<boolean>);
        connectionStatus: ConnectionStatus;
        disconnect: (() => Promise<void>);
        emitEventOnNetwork: EventHandler;
        registerMethod: ((methodName: string, method: InternalRequestHandler, methodDocs?: SingleMethodDocumentation) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

    Type declaration

      • (localEventHandler): Promise<boolean>
      • Parameters

        • localEventHandler: EventHandler

          Function that handles events from the server by accepting an eventType and an event and emitting the event locally. Used when receiving an event over the network.

        Returns Promise<boolean>

        Promise that resolves when finished connecting

        -
    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to +

    connectionStatus: ConnectionStatus

    Whether this connector is setting up or has finished setting up its connection and is ready to communicate on the network

    -
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    +
    disconnect: (() => Promise<void>)

    Disconnects from the connection:

    • On clients: disconnects from the server
    • On servers: disconnects from all clients and closes its connection endpoint
    -
    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be +

    emitEventOnNetwork: EventHandler

    Sends an event to other processes. Does NOT run the local event subscriptions as they should be run by NetworkEventEmitter after sending on network.

    Unique network event type for coordinating between processes

    Event data to emit on the network

    -
    registerMethod: ((methodName: string, method: InternalRequestHandler, methodDocs?: SingleMethodDocumentation) => Promise<boolean>)

    Register a method that will be called if an RPC request is made

    -
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    +
    registerMethod: ((methodName: string, method: InternalRequestHandler, methodDocs?: SingleMethodDocumentation) => Promise<boolean>)

    Register a method that will be called if an RPC request is made

    +
    request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>)

    Send a request and resolve after receiving a response

    Type declaration

      • (requestType, requestParams): Promise<JSONRPCResponse>
      • Parameters

        • requestType: `${string}:${string}`

          Type of request (or "method" in JSONRPC jargon) to call

        • requestParams: RequestParams

          Parameters associated with this request

        Returns Promise<JSONRPCResponse>

        Promise that resolves to a JSONRPCSuccessResponse or JSONRPCErrorResponse message

        -
    unregisterMethod: ((methodName: string) => Promise<boolean>)

    Unregister a method so it is no longer available to RPC requests

    -
    +
    unregisterMethod: ((methodName: string) => Promise<boolean>)

    Unregister a method so it is no longer available to RPC requests

    +
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html index 991b27fc75..3efa359cec 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IDisposableWebViewProvider.html @@ -1,12 +1,12 @@ IDisposableWebViewProvider | papi-dts

    A web view provider that has been registered with the PAPI and returned to the extension that registered it. It is able to be disposed with dispose.

    The PAPI returns this type from papi.webViewProviders.register.

    -
    interface IDisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface IDisposableWebViewProvider {
        dispose: UnsubscriberAsync;
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -34,4 +34,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html index 00aea0359e..22ac197017 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IRegisteredWebViewProvider.html @@ -2,10 +2,10 @@

    This is what the papi gives on webViewProviderService.get (not exposed on the PAPI). Basically a layer over NetworkObject

    This type is internal to core and is not used by extensions

    -
    interface IRegisteredWebViewProvider {
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    interface IRegisteredWebViewProvider {
        onDidDispose: PlatformEvent<void>;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    Methods

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -33,4 +33,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html index 6be83548db..9b78674dd8 100644 --- a/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html +++ b/papi-dts/interfaces/_shared_models_web_view_provider_model_.IWebViewProvider.html @@ -6,12 +6,12 @@ and extensions, you can extend the abstract class WebViewFactory to make the process easier. Alternatively, if you want to manage web view controllers manually, you can register them in IWebViewProvider.getWebView.

    -
    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    interface IWebViewProvider {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
        getWebView(savedWebViewDefinition: SavedWebViewDefinition, getWebViewOptions: GetWebViewOptions, webViewNonce: string): Promise<undefined | WebViewDefinition>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    • Receives a SavedWebViewDefinition and fills it out into a full WebViewDefinition, providing the contents of the web view and other properties that are important for displaying the web view.

      The PAPI calls this method as part of opening a new web view or (re)loading an existing web @@ -39,4 +39,4 @@ applicable (See papi.webViewProviders.registerWebViewController).

    Returns Promise<undefined | WebViewDefinition>

    Full WebViewDefinition including the content and other important display properties based on the SavedWebViewDefinition provided

    -
    +
    diff --git a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html index aa54b746bc..ce665198fa 100644 --- a/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html +++ b/papi-dts/interfaces/_shared_services_data_provider_service_.DataProviderService.html @@ -1,4 +1,4 @@ -DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method: Function & {
                    doNotNotify?: boolean;
                }): void;
                (target: object, member: string): void;
            };
            ignore: {
                (method: Function & {
                    isIgnored?: boolean;
                }): void;
                (target: object, member: string): void;
            };
        };
        get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName: string) => boolean);
        registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine +DataProviderService | papi-dts
    interface DataProviderService {
        DataProviderEngine: typeof "shared/models/data-provider-engine.model".DataProviderEngine;
        decorators: {
            doNotNotify: {
                (method: Function & {
                    doNotNotify?: boolean;
                }): void;
                (target: object, member: string): void;
            };
            ignore: {
                (method: Function & {
                    isIgnored?: boolean;
                }): void;
                (target: object, member: string): void;
            };
        };
        get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>);
        hasKnown: ((providerName: string) => boolean);
        registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
            [property: string]: unknown;
        }) => Promise<DisposableDataProviders[DataProviderName]>);
    }

    Properties

    DataProviderEngine decorators get hasKnown @@ -7,7 +7,7 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    IDataProviderEngine for more information on extending this class.

    -
    decorators: {
        doNotNotify: {
            (method: Function & {
                doNotNotify?: boolean;
            }): void;
            (target: object, member: string): void;
        };
        ignore: {
            (method: Function & {
                isIgnored?: boolean;
            }): void;
            (target: object, member: string): void;
        };
    }

    A collection of decorators to be used with the data provider service

    +
    decorators: {
        doNotNotify: {
            (method: Function & {
                doNotNotify?: boolean;
            }): void;
            (target: object, member: string): void;
        };
        ignore: {
            (method: Function & {
                isIgnored?: boolean;
            }): void;
            (target: object, member: string): void;
        };
    }

    A collection of decorators to be used with the data provider service

    Type declaration

    • doNotNotify: {
          (method: Function & {
              doNotNotify?: boolean;
          }): void;
          (target: object, member: string): void;
      }

      Decorator function that marks a data provider engine set<data_type> method not to automatically emit an update and notify subscribers of a change to the data. papi will still consider the set<data_type> method to be a data type method, but it will not layer over it to emit updates.

      @@ -81,19 +81,19 @@

      WARNING: Do not copy and paste this example. The @ symbol does not render correctly in JSDoc code blocks, so a different unicode character was used. Please use a normal @ when using a decorator.

      -
    get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

    +
    get: (<DataProviderName>(providerName: DataProviderName) => Promise<DataProviders[DataProviderName] | undefined>)

    Get a data provider that has previously been set up

    Type declaration

      • <DataProviderName>(providerName): Promise<DataProviders[DataProviderName] | undefined>
      • Get a data provider that has previously been set up

        Type Parameters

        • DataProviderName extends keyof DataProviders

        Parameters

        Returns Promise<DataProviders[DataProviderName] | undefined>

        The data provider with the given name if one exists, undefined otherwise

    Name of the desired data provider

    The data provider with the given name if one exists, undefined otherwise

    -
    hasKnown: ((providerName: string) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider +

    hasKnown: ((providerName: string) => boolean)

    Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

    Type declaration

      • (providerName): boolean
      • Indicate if we are aware of an existing data provider with the given name. If a data provider with the given name is somewhere else on the network, this function won't tell you about it unless something else in the existing process is subscribed to it.

        -

        Parameters

        • providerName: string

        Returns boolean

    registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableDataProviders[DataProviderName]>)

    Creates a data provider to be shared on the network layering over the provided data provider +

    Parameters

    • providerName: string

    Returns boolean

    registerEngine: (<DataProviderName>(providerName: DataProviderName, dataProviderEngine: "shared/models/data-provider-engine.model".default<DataProviderTypes[DataProviderName]>, dataProviderType?: string, dataProviderAttributes?: {
        [property: string]: unknown;
    }) => Promise<DisposableDataProviders[DataProviderName]>)

    Creates a data provider to be shared on the network layering over the provided data provider engine.

    Type declaration

      • <DataProviderName>(providerName, dataProviderEngine, dataProviderType?, dataProviderAttributes?): Promise<DisposableDataProviders[DataProviderName]>
      • Creates a data provider to be shared on the network layering over the provided data provider engine.

        @@ -121,4 +121,4 @@ set methods are layered over to facilitate data provider subscriptions.

        The data provider including control over disposing of it. Note that this data provider is a new object distinct from the data provider engine passed in.

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html index c4f2a321b4..c66b104bda 100644 --- a/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html +++ b/papi-dts/interfaces/_shared_services_dialog_service_model_.DialogService.html @@ -1,11 +1,11 @@ DialogService | papi-dts

    Prompt the user for responses with dialogs

    -
    interface DialogService {
        selectProject(options?: ProjectDialogOptionsBase): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType: DialogTabType, options?: DialogTypes[DialogTabType]["options"]): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    interface DialogService {
        selectProject(options?: ProjectDialogOptionsBase): Promise<undefined | string>;
        showDialog<DialogTabType>(dialogType: DialogTabType, options?: DialogTypes[DialogTabType]["options"]): Promise<undefined | DialogTypes[DialogTabType]["responseType"]>;
    }

    Methods

    • Shows a select project dialog to the user and prompts the user to select a project

      Parameters

      Returns Promise<undefined | string>

      Returns the user's selected project id or undefined if the user cancels

      -
    +
    diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index e94541cdb5..fa39b6442f 100644 --- a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html +++ b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html @@ -1,3 +1,3 @@ -InternetService | papi-dts
    interface InternetService {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    }

    Properties

    fetch +InternetService | papi-dts
    interface InternetService {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    }

    Properties

    Properties

    fetch: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Type declaration

      • (input, init?): Promise<Response>
      • Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input, init?): Promise<Response>
      • Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

    +

    Parameters

    • input: RequestInfo | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

  • (input, init?): Promise<Response>
  • Parameters

    • input: string | Request | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

  • diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html index d0bc921d7a..388af268c7 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.MinimalNetworkObjectService.html @@ -1,4 +1,4 @@ -MinimalNetworkObjectService | papi-dts
    interface MinimalNetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +MinimalNetworkObjectService | papi-dts
    interface MinimalNetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>)

    Type declaration

      • <T>(id, createLocalObjectToProxy?): Promise<undefined | NetworkObject<T>>
      • Get a network object that has previously been set up to be shared on the network. A network @@ -10,7 +10,7 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -
    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?, objectDocumentation?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        +
    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?, objectDocumentation?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -19,4 +19,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • OptionalobjectType: string
        • OptionalobjectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown
        • OptionalobjectDocumentation: NetworkObjectDocumentation

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html index 1c9c40a113..f2241f4788 100644 --- a/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html +++ b/papi-dts/interfaces/_shared_services_network_object_service_.NetworkObjectService.html @@ -1,4 +1,4 @@ -NetworkObjectService | papi-dts
    interface NetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id: string) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +NetworkObjectService | papi-dts
    interface NetworkObjectService {
        get: (<T>(id: string, createLocalObjectToProxy?: LocalObjectToProxyCreator<T>) => Promise<undefined | NetworkObject<T>>);
        hasKnown: ((id: string) => boolean);
        initialize: (() => Promise<void>);
        onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>;
        set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
            [property: string]: unknown;
        }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get hasKnown initialize onDidCreateNetworkObject @@ -12,12 +12,12 @@ will be based upon. The object this function creates cannot have an onDidDispose property. This function is useful for setting up network events on a network object.

    Returns Promise<undefined | NetworkObject<T>>

    A promise for the network object with specified ID if one exists, undefined otherwise

    -
    hasKnown: ((id: string) => boolean)

    Type declaration

      • (id): boolean
      • Search locally known network objects for the given ID. Don't look on the network for more +

    hasKnown: ((id: string) => boolean)

    Type declaration

      • (id): boolean
      • Search locally known network objects for the given ID. Don't look on the network for more objects.

        Parameters

        • id: string

        Returns boolean

        Whether we know of an existing network object with the provided ID already on the network

        -
    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        -

        Returns Promise<void>

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?, objectDocumentation?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        +
    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        +

        Returns Promise<void>

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>
    set: (<T>(id: string, objectToShare: T, objectType?: string, objectAttributes?: {
        [property: string]: unknown;
    }, objectDocumentation?: NetworkObjectDocumentation) => Promise<DisposableNetworkObject<T>>)

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?, objectDocumentation?): Promise<DisposableNetworkObject<T>>
      • Set up an object to be shared on the network.

        Type Parameters

        Parameters

        • id: string

          ID of the object to share on the network. All processes must use this ID to look it up.

        • objectToShare: T

          The object to set up as a network object. It will have an event named onDidDispose added to its properties. An error will be thrown if the object already had an @@ -26,4 +26,4 @@ object did not already define a dispose function, one will be added.

          WARNING: setting a network object mutates the provided object.

        • OptionalobjectType: string
        • OptionalobjectAttributes: {
              [property: string]: unknown;
          }
          • [property: string]: unknown
        • OptionalobjectDocumentation: NetworkObjectDocumentation

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 21f81e15af..3bd9986c74 100644 --- a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html +++ b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html @@ -1,4 +1,4 @@ -PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts
    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>)

    Type declaration

      • <T>(eventType): PlatformEventEmitter<T>
      • Creates an event emitter that works properly over the network. Other connections receive this event when it is emitted.

        @@ -6,7 +6,7 @@ emitters.

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PlatformEventEmitter<T>

        Event emitter whose event works between connections

        -
    getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        +
    getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>)

    Type declaration

      • <T>(eventType): PlatformEvent<T>
      • Gets the network event with the specified type. Creates the emitter if it does not exist

        Type Parameters

        • T

        Parameters

        • eventType: string

          Unique network event type for coordinating between connections

        Returns PlatformEvent<T>

        Event for the event type that runs the callback provided when the event is emitted

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html index 7816cc9001..ed7cebf193 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiBackendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>);
    }

    Properties

    get +PapiBackendProjectDataProviderService | papi-dts
    interface PapiBackendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
        registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>);
    }

    Properties

    get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript @@ -15,11 +15,11 @@

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -
    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        +
    registerProjectDataProviderEngineFactory: (<SupportedProjectInterfaces>(pdpFactoryId: string, projectInterfaces: SupportedProjectInterfaces, pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>) => Promise<Dispose>)

    Type declaration

      • <SupportedProjectInterfaces>(pdpFactoryId, projectInterfaces, pdpEngineFactory): Promise<Dispose>
      • Add a new Project Data Provider Factory to PAPI that uses the given engine.

        Type Parameters

        Parameters

        • pdpFactoryId: string

          Unique id for this PDP factory

        • projectInterfaces: SupportedProjectInterfaces

          The standardized sets of methods (projectInterfaces) supported by the Project Data Provider Engines produced by this factory. Indicates what sort of project data should be available on the PDPEs created by this factory.

        • pdpEngineFactory: IProjectDataProviderEngineFactory<SupportedProjectInterfaces>

          Used in a ProjectDataProviderFactory to create ProjectDataProviders

        Returns Promise<Dispose>

        Promise that resolves to a disposable object when the registration operation completes

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html index 9554bfdedb..9b17084bcc 100644 --- a/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html +++ b/papi-dts/interfaces/_shared_services_project_data_provider_service_.PapiFrontendProjectDataProviderService.html @@ -1,4 +1,4 @@ -PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts
    interface PapiFrontendProjectDataProviderService {
        get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>);
    }

    Properties

    Properties

    get: (<ProjectInterface>(projectInterface: ProjectInterface, projectId: string, pdpFactoryId?: string) => Promise<ProjectDataProviderInterfaces[ProjectInterface]>)

    Type declaration

      • <ProjectInterface>(projectInterface, projectId, pdpFactoryId?): Promise<ProjectDataProviderInterfaces[ProjectInterface]>
      • Get a Project Data Provider for the given project ID.

        Type Parameters

        Parameters

        • projectInterface: ProjectInterface

          projectInterface that the project to load must support. The TypeScript type for the returned project data provider will have the project data provider interface type @@ -14,4 +14,4 @@

          If did not find a project data provider for the project id that supports the requested projectInterface (and from the requested PDP factory if specified)

          -
    +
    diff --git a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html index 19e08c79d4..2385e6d771 100644 --- a/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html +++ b/papi-dts/interfaces/_shared_services_project_settings_service_model_.IProjectSettingsService.html @@ -1,5 +1,5 @@ IProjectSettingsService | papi-dts

    Provides utility functions that project data providers should call when handling project settings

    -
    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key: ProjectSettingName): Promise<ProjectSettingTypes[ProjectSettingName]>;
        getLocalizedContributionInfo(): Promise<undefined | {
            contributions: {};
            settings: {
                platform.fullName: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.isEditable: undefined | {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.language: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.name: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
            };
        }>;
        isValid<ProjectSettingName>(key: ProjectSettingName, newValue: ProjectSettingTypes[ProjectSettingName], currentValue: ProjectSettingTypes[ProjectSettingName], allChanges?: SimultaneousProjectSettingsChanges): Promise<boolean>;
        registerValidator<ProjectSettingName>(key: ProjectSettingName, validatorCallback: ProjectSettingValidator<ProjectSettingName>): Promise<UnsubscriberAsync>;
    }

    Methods

    interface IProjectSettingsService {
        getDefault<ProjectSettingName>(key: ProjectSettingName): Promise<ProjectSettingTypes[ProjectSettingName]>;
        getLocalizedContributionInfo(): Promise<undefined | {
            contributions: {};
            settings: {
                platform.fullName: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.isEditable: undefined | {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.language: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
                platform.name: undefined | {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                };
            };
        }>;
        isValid<ProjectSettingName>(key: ProjectSettingName, newValue: ProjectSettingTypes[ProjectSettingName], currentValue: ProjectSettingTypes[ProjectSettingName], allChanges?: SimultaneousProjectSettingsChanges): Promise<boolean>;
        registerValidator<ProjectSettingName>(key: ProjectSettingName, validatorCallback: ProjectSettingValidator<ProjectSettingName>): Promise<UnsubscriberAsync>;
    }

    Methods

    Type Parameters

    Parameters

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

    The default value for the setting if a default value is registered

    If a default value is not registered for the setting

    -
    • Get the current set of project settings contribution info given all the input documents with +

    • Get the current set of project settings contribution info given all the input documents with all localized string keys localized properly.

      Returns Promise<undefined | {
          contributions: {};
          settings: {
              platform.fullName: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.isEditable: undefined | {
                  default: boolean;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.language: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
              platform.name: undefined | {
                  default: string;
                  derivesFrom?: string;
                  description?: string;
                  excludePdpFactoryIds?: string | string[];
                  excludeProjectInterfaces?: string | (string | string[])[];
                  includePdpFactoryIds?: string | string[];
                  includeProjectInterfaces?: string | (string | string[])[];
                  label: string;
                  platformType?: undefined;
                  type?: undefined;
              };
          };
      }>

      Localized project settings contribution info or undefined

      -
    • Calls registered project settings validators to determine whether or not a project setting change is valid.

      Every Project Data Provider must run this function when it receives a request to set a project setting before changing the value of the setting.

      @@ -23,7 +23,7 @@
    • currentValue: ProjectSettingTypes[ProjectSettingName]

      The current project setting value

    • OptionalallChanges: SimultaneousProjectSettingsChanges

      All project settings changes being set in one batch

    Returns Promise<boolean>

    true if change is valid, false otherwise

    -
    +
    diff --git a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html index d9d16cef0d..6e96f624a6 100644 --- a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html +++ b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupRemoteService.html @@ -1,12 +1,12 @@ IScrollGroupRemoteService | papi-dts

    Parts of the Scroll Group Service that are exposed through the network object

    -
    interface IScrollGroupRemoteService {
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

    interface IScrollGroupRemoteService {
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<ScriptureReference>

      Scripture reference associated with the provided scroll group

      -
    • Sets the ScriptureReference associated with the provided scroll group

      +
    • Sets the ScriptureReference associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: ScriptureReference

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

      -
    +
    diff --git a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html index 153e924b1b..d5268ff2ba 100644 --- a/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html +++ b/papi-dts/interfaces/_shared_services_scroll_group_service_model_.IScrollGroupService.html @@ -1,14 +1,14 @@ IScrollGroupService | papi-dts

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    interface IScrollGroupService {
        onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>;
        getScrRef(scrollGroupId?: number): Promise<ScriptureReference>;
        setScrRef(scrollGroupId: undefined | number, scrRef: ScriptureReference): Promise<boolean>;
    }

    Hierarchy (view full)

    Properties

    onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>

    Event that emits with information about a changed Scripture Reference for a scroll group

    -

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      +

    Methods

    • Get the ScriptureReference associated with the provided scroll group

      Parameters

      • OptionalscrollGroupId: number

        Scroll group whose Scripture reference to get. Defaults to 0

      Returns Promise<ScriptureReference>

      Scripture reference associated with the provided scroll group

      -
    • Sets the ScriptureReference associated with the provided scroll group

      Parameters

      • scrollGroupId: undefined | number

        Scroll group whose Scripture reference to get. If undefined, defaults to 0

      • scrRef: ScriptureReference

        Scripture reference to which to set the scroll group

      Returns Promise<boolean>

      true if the Scripture reference changed. false otherwise

      -
    +
    diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html index f90bb63486..51ba87fece 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.PapiWebViewProviderService.html @@ -1,4 +1,4 @@ -PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    postMessageToWebView +PapiWebViewProviderService | papi-dts
    interface PapiWebViewProviderService {
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    postMessageToWebView register registerWebViewController registerWebViewProvider @@ -19,8 +19,8 @@ targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)

    -

    Returns Promise<void>

    register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>)

    13 November 2024. Renamed to registerWebViewProvider

    -
    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

    Returns Promise<void>

    register: ((...args: [webViewType: string, webViewProvider: IWebViewProvider]) => Promise<IDisposableWebViewProvider>)

    13 November 2024. Renamed to registerWebViewProvider

    +
    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

      • <WebViewType>(webViewType, webViewId, webViewController): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>
      • Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.

        A Web View Controller is a network object that represents a web view and whose methods facilitate @@ -33,10 +33,10 @@ is closed

        WARNING: setting a web view controller mutates the provided object.

    Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

    webViewController modified to be a network object

    -
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        +
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<IDisposableWebViewProvider>

        webViewProvider modified to be a network object and able to be disposed with dispose

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html index d0c551ab62..a4353ae460 100644 --- a/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html +++ b/papi-dts/interfaces/_shared_services_web_view_provider_service_.WebViewProviderService.html @@ -1,4 +1,4 @@ -WebViewProviderService | papi-dts
    interface WebViewProviderService {
        getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>);
        initialize: (() => Promise<void>);
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    getWebViewProvider +WebViewProviderService | papi-dts
    interface WebViewProviderService {
        getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>);
        initialize: (() => Promise<void>);
        postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>);
        registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>);
        registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>);
    }

    Properties

    getWebViewProvider: ((webViewType: string) => Promise<IRegisteredWebViewProvider | undefined>)

    Type declaration

      • (webViewType): Promise<IRegisteredWebViewProvider | undefined>
      • Get a web view provider that has previously been set up

        Parameters

        • webViewType: string

          Type of webview provider to get

        Returns Promise<IRegisteredWebViewProvider | undefined>

        Web view provider with the given name if one exists, undefined otherwise

        -
    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        -

        Returns Promise<void>

    postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type declaration

      • (webViewId, webViewNonce, message, targetOrigin?): Promise<void>
      • Sends a message to the specified web view. Expected to be used only by the +

    initialize: (() => Promise<void>)

    Type declaration

      • (): Promise<void>
      • Sets up the service. Only runs once and always returns the same promise after that

        +

        Returns Promise<void>

    postMessageToWebView: ((webViewId: string, webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type declaration

      • (webViewId, webViewNonce, message, targetOrigin?): Promise<void>
      • Sends a message to the specified web view. Expected to be used only by the IWebViewProvider that created the web view or the WebViewControllers that represents the web view created by the Web View Provider.

        postMessage is used to @@ -24,7 +24,7 @@ targetOrigin for more information. Defaults to same origin only (works automatically with React and HTML web views)

        -

    Returns Promise<void>

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

    Returns Promise<void>

    registerWebViewController: (<WebViewType>(webViewType: WebViewType, webViewId: string, webViewController: WebViewControllers[WebViewType]) => Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>)

    Type declaration

      • <WebViewType>(webViewType, webViewId, webViewController): Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>
      • Register a web view controller to represent a web view. It is expected that a web view provider calls this to register a web view controller for a web view that is being created. If a web view provider extends WebViewFactory, it will call this function automatically.

        A Web View Controller is a network object that represents a web view and whose methods facilitate @@ -37,10 +37,10 @@ is closed

        WARNING: setting a web view controller mutates the provided object.

    Returns Promise<DisposableNetworkObject<WebViewControllers[WebViewType]>>

    webViewController modified to be a network object

    -
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        +
    registerWebViewProvider: ((webViewType: string, webViewProvider: IWebViewProvider) => Promise<IDisposableWebViewProvider>)

    Type declaration

      • (webViewType, webViewProvider): Promise<IDisposableWebViewProvider>
      • Register a web view provider to serve webViews for a specified type of webViews

        Parameters

        • webViewType: string

          Type of web view to provide

        • webViewProvider: IWebViewProvider

          Object to register as a webView provider including control over disposing of it.

          WARNING: setting a webView provider mutates the provided object.

        Returns Promise<IDisposableWebViewProvider>

        webViewProvider modified to be a network object and able to be disposed with dispose

        -
    +
    diff --git a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html index 7c7b383c8f..4a9a1a9079 100644 --- a/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html +++ b/papi-dts/interfaces/_shared_services_web_view_service_model_.WebViewServiceType.html @@ -1,7 +1,7 @@ WebViewServiceType | papi-dts

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    interface WebViewServiceType {
        getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<OpenWebViewEvent>;
        onDidCloseWebView: PlatformEvent<CloseWebViewEvent>;
        onDidOpenWebView: PlatformEvent<OpenWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        getOpenWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getSavedWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getWebViewController<WebViewType>(webViewType: WebViewType, webViewId: string): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>;
    }

    Properties

    interface WebViewServiceType {
        getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        onDidAddWebView: PlatformEvent<OpenWebViewEvent>;
        onDidCloseWebView: PlatformEvent<CloseWebViewEvent>;
        onDidOpenWebView: PlatformEvent<OpenWebViewEvent>;
        onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>;
        openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>);
        getOpenWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getSavedWebViewDefinition(webViewId: string): Promise<undefined | SavedWebViewDefinition>;
        getWebViewController<WebViewType>(webViewType: WebViewType, webViewId: string): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>;
    }

    Properties

    getWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    6 November 2024. Renamed to openWebView.

    -
    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    13 November 2024. Renamed to onDidOpenWebView

    -
    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    -
    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    -
    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    -
    openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    Creates a new web view or gets an existing one depending on if you request an existing one and +

    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    13 November 2024. Renamed to onDidOpenWebView

    +
    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    +
    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    +
    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    +
    openWebView: ((webViewType: string, layout?: Layout, options?: GetWebViewOptions) => Promise<undefined | string>)

    Creates a new web view or gets an existing one depending on if you request an existing one and if the web view provider decides to give that existing one to you (it is up to the provider).

    Type declaration

      • (webViewType, layout?, options?): Promise<undefined | string>
      • Parameters

        • webViewType: string

          Type of WebView to create

        • Optionallayout: Layout

          Information about where you want the web view to go. Defaults to adding as a tab

          @@ -24,7 +24,7 @@

        Returns Promise<undefined | string>

        Promise that resolves to the ID of the webview we got or undefined if the provider did not create a WebView for this request.

    If something went wrong like the provider for the webViewType was not found

    -

    Methods

    • Gets the saved properties on the WebView definition with the specified ID

      +

    Methods

    • Gets the saved properties on the WebView definition with the specified ID

      Note: this only returns a representation of the current web view definition, not the actual web view definition itself. Changing properties on the returned definition does not affect the actual web view definition. You can possibly change the actual web view definition by calling @@ -33,8 +33,8 @@

      Parameters

      • webViewId: string

        The ID of the WebView whose saved properties to get

      Returns Promise<undefined | SavedWebViewDefinition>

      Saved properties of the WebView definition with the specified ID or undefined if not found

      -
    • Get an existing web view controller for an open web view.

      A Web View Controller is a network object that represents a web view and whose methods facilitate communication between its associated web view and extensions that want to interact with it.

      @@ -44,4 +44,4 @@
    • webViewId: string

      Id of web view for which to get the corresponding web view controller if one exists

    Returns Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>

    Web view controller with the given name if one exists, undefined otherwise

    -
    +
    diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index e461f6d90e..267c03fb97 100644 --- a/papi-dts/modules/__papi_backend_.html +++ b/papi-dts/modules/__papi_backend_.html @@ -1,4 +1,4 @@ -"@papi/backend" | papi-dts

    Namespace"@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine +"@papi/backend" | papi-dts

    Namespace"@papi/backend"

    Index

    Variables

    BaseProjectDataProviderEngine commands DataProviderEngine dataProviders diff --git a/papi-dts/modules/__papi_core_.html b/papi-dts/modules/__papi_core_.html index 0e0427a0d7..247b9b8063 100644 --- a/papi-dts/modules/__papi_core_.html +++ b/papi-dts/modules/__papi_core_.html @@ -1,4 +1,4 @@ -"@papi/core" | papi-dts

    Namespace"@papi/core"

    References

    ComponentsDocumentation +"@papi/core" | papi-dts

    Namespace"@papi/core"

    References

    ComponentsDocumentation DataProviderDataType DataProviderSubscriberOptions DataProviderUpdateInstructions diff --git a/papi-dts/modules/__papi_frontend_.html b/papi-dts/modules/__papi_frontend_.html index 8cc5eef9fc..7fda1479eb 100644 --- a/papi-dts/modules/__papi_frontend_.html +++ b/papi-dts/modules/__papi_frontend_.html @@ -1,4 +1,4 @@ -"@papi/frontend" | papi-dts

    Namespace"@papi/frontend"

    Index

    Type Aliases

    Papi +"@papi/frontend" | papi-dts

    Namespace"@papi/frontend"

    Index

    Type Aliases

    Variables

    commands dataProviders default diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index eb4bc4f30f..7e0c18d697 100644 --- a/papi-dts/modules/__papi_frontend_react_.html +++ b/papi-dts/modules/__papi_frontend_react_.html @@ -1,4 +1,4 @@ -"@papi/frontend/react" | papi-dts

    Namespace"@papi/frontend/react"

    References

    useData +"@papi/frontend/react" | papi-dts

    Namespace"@papi/frontend/react"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_client_services_rpc_client_.html b/papi-dts/modules/_client_services_rpc_client_.html index dc2445d3a3..b5c9de0a37 100644 --- a/papi-dts/modules/_client_services_rpc_client_.html +++ b/papi-dts/modules/_client_services_rpc_client_.html @@ -1,2 +1,2 @@ -"client/services/rpc-client" | papi-dts

    Namespace"client/services/rpc-client"

    Index

    Classes

    default +"client/services/rpc-client" | papi-dts

    Namespace"client/services/rpc-client"

    Index

    Classes

    diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index b131eab0f3..b5c8d4dbe2 100644 --- a/papi-dts/modules/_client_services_web_socket_factory_.html +++ b/papi-dts/modules/_client_services_web_socket_factory_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.factory" | papi-dts

    Namespace"client/services/web-socket.factory"

    Index

    Functions

    createWebSocket +"client/services/web-socket.factory" | papi-dts

    Namespace"client/services/web-socket.factory"

    Index

    Functions

    diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 58a437359e..6e6290793f 100644 --- a/papi-dts/modules/_client_services_web_socket_interface_.html +++ b/papi-dts/modules/_client_services_web_socket_interface_.html @@ -1,2 +1,2 @@ -"client/services/web-socket.interface" | papi-dts

    Namespace"client/services/web-socket.interface"

    Index

    Type Aliases

    IWebSocket +"client/services/web-socket.interface" | papi-dts

    Namespace"client/services/web-socket.interface"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html index 95d70e7221..c046aa30de 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_activation_context_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Namespace"extension-host/extension-types/extension-activation-context.model"

    Index

    Type Aliases

    ExecutionActivationContext +"extension-host/extension-types/extension-activation-context.model" | papi-dts

    Namespace"extension-host/extension-types/extension-activation-context.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html index 628410e783..eb1bb97c31 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_interface_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_interface_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension.interface" | papi-dts

    Namespace"extension-host/extension-types/extension.interface"

    Index

    Interfaces

    IExtension +"extension-host/extension-types/extension.interface" | papi-dts

    Namespace"extension-host/extension-types/extension.interface"

    Index

    Interfaces

    diff --git a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html index 4477ca6105..876ed7bae3 100644 --- a/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html +++ b/papi-dts/modules/_extension_host_extension_types_extension_manifest_model_.html @@ -1,2 +1,2 @@ -"extension-host/extension-types/extension-manifest.model" | papi-dts

    Namespace"extension-host/extension-types/extension-manifest.model"

    Index

    Type Aliases

    ExtensionManifest +"extension-host/extension-types/extension-manifest.model" | papi-dts

    Namespace"extension-host/extension-types/extension-manifest.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html index 6c587f5346..3c71e67871 100644 --- a/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html +++ b/papi-dts/modules/_extension_host_services_extension_host_web_socket_model_.html @@ -1,3 +1,3 @@ -"extension-host/services/extension-host-web-socket.model" | papi-dts

    Namespace"extension-host/services/extension-host-web-socket.model"

    Index

    Namespaces

    default +"extension-host/services/extension-host-web-socket.model" | papi-dts

    Namespace"extension-host/services/extension-host-web-socket.model"

    Index

    Namespaces

    Classes

    diff --git a/papi-dts/modules/_extension_host_services_extension_storage_service_.html b/papi-dts/modules/_extension_host_services_extension_storage_service_.html index 2f709de62f..4ff9d1ea56 100644 --- a/papi-dts/modules/_extension_host_services_extension_storage_service_.html +++ b/papi-dts/modules/_extension_host_services_extension_storage_service_.html @@ -1,4 +1,4 @@ -"extension-host/services/extension-storage.service" | papi-dts

    Namespace"extension-host/services/extension-storage.service"

    Index

    Interfaces

    ExtensionStorageService +"extension-host/services/extension-storage.service" | papi-dts

    Namespace"extension-host/services/extension-storage.service"

    Index

    Interfaces

    Variables

    Functions

    buildExtensionPathFromName setExtensionUris diff --git a/papi-dts/modules/_main_services_rpc_server_.html b/papi-dts/modules/_main_services_rpc_server_.html index 3de8ba0bd6..baddfdd58e 100644 --- a/papi-dts/modules/_main_services_rpc_server_.html +++ b/papi-dts/modules/_main_services_rpc_server_.html @@ -1,3 +1,3 @@ -"main/services/rpc-server" | papi-dts

    Namespace"main/services/rpc-server"

    Index

    Classes

    default +"main/services/rpc-server" | papi-dts

    Namespace"main/services/rpc-server"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_main_services_rpc_websocket_listener_.html b/papi-dts/modules/_main_services_rpc_websocket_listener_.html index a12f0a56e1..f276c23e01 100644 --- a/papi-dts/modules/_main_services_rpc_websocket_listener_.html +++ b/papi-dts/modules/_main_services_rpc_websocket_listener_.html @@ -1,2 +1,2 @@ -"main/services/rpc-websocket-listener" | papi-dts

    Namespace"main/services/rpc-websocket-listener"

    Index

    Classes

    default +"main/services/rpc-websocket-listener" | papi-dts

    Namespace"main/services/rpc-websocket-listener"

    Index

    Classes

    diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 5e0f74477f..8a11c37fc0 100644 --- a/papi-dts/modules/_node_models_execution_token_model_.html +++ b/papi-dts/modules/_node_models_execution_token_model_.html @@ -1,3 +1,3 @@ -"node/models/execution-token.model" | papi-dts

    Namespace"node/models/execution-token.model"

    Index

    Classes

    ExecutionToken +"node/models/execution-token.model" | papi-dts

    Namespace"node/models/execution-token.model"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index 8ae64f2937..69f515ecb7 100644 --- a/papi-dts/modules/_node_services_execution_token_service_.html +++ b/papi-dts/modules/_node_services_execution_token_service_.html @@ -1,2 +1,2 @@ -"node/services/execution-token.service" | papi-dts

    Namespace"node/services/execution-token.service"

    Index

    Variables

    default +"node/services/execution-token.service" | papi-dts

    Namespace"node/services/execution-token.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_node_services_node_file_system_service_.html b/papi-dts/modules/_node_services_node_file_system_service_.html index 06292b3498..1b22ef744c 100644 --- a/papi-dts/modules/_node_services_node_file_system_service_.html +++ b/papi-dts/modules/_node_services_node_file_system_service_.html @@ -1,4 +1,4 @@ -"node/services/node-file-system.service" | papi-dts

    Namespace"node/services/node-file-system.service"

    Index

    Enumerations

    EntryType +"node/services/node-file-system.service" | papi-dts

    Namespace"node/services/node-file-system.service"

    Index

    Enumerations

    Type Aliases

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 3456e1831f..a3fbdaecf3 100644 --- a/papi-dts/modules/_node_utils_crypto_util_.html +++ b/papi-dts/modules/_node_utils_crypto_util_.html @@ -1,4 +1,4 @@ -"node/utils/crypto-util" | papi-dts

    Namespace"node/utils/crypto-util"

    Index

    Functions

    createNonce +"node/utils/crypto-util" | papi-dts
    diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 451c434621..4f7dfc7150 100644 --- a/papi-dts/modules/_node_utils_util_.html +++ b/papi-dts/modules/_node_utils_util_.html @@ -1,4 +1,4 @@ -"node/utils/util" | papi-dts

    Namespace"node/utils/util"

    Index

    Variables

    FILE_PROTOCOL +"node/utils/util" | papi-dts

    Namespace"node/utils/util"

    Index

    Variables

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index d385255416..bc2ab50f48 100644 --- a/papi-dts/modules/_papi_shared_types_.html +++ b/papi-dts/modules/_papi_shared_types_.html @@ -1,4 +1,4 @@ -"papi-shared-types" | papi-dts

    Namespace"papi-shared-types"

    Index

    Interfaces

    CommandHandlers +"papi-shared-types" | papi-dts

    Namespace"papi-shared-types"

    Index

    Interfaces

    CommandHandlers DataProviders ProjectDataProviderInterfaces ProjectSettingTypes diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html index 849295e3d3..860218e9ad 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_base_data_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace"renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    DialogDefinitionBase +"renderer/components/dialogs/dialog-base.data" | papi-dts

    Namespace"renderer/components/dialogs/dialog-base.data"

    Index

    Type Aliases

    Variables

    Functions

    hookUpDialogService diff --git a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html index 9571ed854c..a5281ed64b 100644 --- a/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html +++ b/papi-dts/modules/_renderer_components_dialogs_dialog_definition_model_.html @@ -1,4 +1,4 @@ -"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace"renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    DialogTypes +"renderer/components/dialogs/dialog-definition.model" | papi-dts

    Namespace"renderer/components/dialogs/dialog-definition.model"

    Index

    Interfaces

    Type Aliases

    DialogDataTypes DialogDefinition DialogTabTypes diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html index 02aecc9f36..4ff2d2786e 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_data_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-data-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-data-hook.util"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html index fc9c652e49..4702540b10 100644 --- a/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html +++ b/papi-dts/modules/_renderer_hooks_hook_generators_create_use_network_object_hook_util_.html @@ -1,2 +1,2 @@ -"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    default +"renderer/hooks/hook-generators/create-use-network-object-hook.util" | papi-dts

    Namespace"renderer/hooks/hook-generators/create-use-network-object-hook.util"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index cedb0afbd5..9bed9a728e 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html @@ -1,4 +1,4 @@ -"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace"renderer/hooks/papi-hooks/index"

    References

    useData +"renderer/hooks/papi-hooks/index" | papi-dts

    Namespace"renderer/hooks/papi-hooks/index"

    References

    useData useDataProvider useDataProviderMulti useDialogCallback diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html index 09e4f5a94f..320b20e065 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html index 38466b410b..9043aa9ec5 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html index d88c16524b..9ee379b984 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_data_provider_multi_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-data-provider-multi.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-data-provider-multi.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html index 97f810aca7..6b496fd390 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.html @@ -1,3 +1,3 @@ -"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    UseDialogCallbackOptions +"renderer/hooks/papi-hooks/use-dialog-callback.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-dialog-callback.hook"

    Index

    Type Aliases

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html index 3b006f36c7..701c312703 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_localized_strings_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-localized-strings-hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-localized-strings-hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html index 1e0107fb23..54823c0d1a 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html index 79209ea638..d8a5af9b00 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_data_provider_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-data-provider.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-data-provider.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html index 2bd98cd3ff..96bfe9e64b 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_project_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-project-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-project-setting.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html index 16618c5824..f16e3517a8 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_scroll_group_scr_ref_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-scroll-group-scr-ref.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html index 361c27c3eb..aa253588ee 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_setting_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-setting.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-setting.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html index 9eff1e9b6b..9e8bf63576 100644 --- a/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html +++ b/papi-dts/modules/_renderer_hooks_papi_hooks_use_web_view_controller_hook_.html @@ -1,2 +1,2 @@ -"renderer/hooks/papi-hooks/use-web-view-controller.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-web-view-controller.hook"

    Index

    Functions

    default +"renderer/hooks/papi-hooks/use-web-view-controller.hook" | papi-dts

    Namespace"renderer/hooks/papi-hooks/use-web-view-controller.hook"

    Index

    Functions

    diff --git a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html index f9b5a348c6..b8f4351e11 100644 --- a/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_web_socket_service_.html @@ -1,3 +1,3 @@ -"renderer/services/renderer-web-socket.service" | papi-dts

    Namespace"renderer/services/renderer-web-socket.service"

    Index

    Classes

    default +"renderer/services/renderer-web-socket.service" | papi-dts

    Namespace"renderer/services/renderer-web-socket.service"

    Index

    Classes

    Functions

    diff --git a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html index 97529401d2..91163b8259 100644 --- a/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html +++ b/papi-dts/modules/_renderer_services_renderer_xml_http_request_service_.html @@ -1,2 +1,2 @@ -"renderer/services/renderer-xml-http-request.service" | papi-dts

    Namespace"renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    default +"renderer/services/renderer-xml-http-request.service" | papi-dts

    Namespace"renderer/services/renderer-xml-http-request.service"

    Index

    Classes

    diff --git a/papi-dts/modules/_renderer_services_scroll_group_service_host_.html b/papi-dts/modules/_renderer_services_scroll_group_service_host_.html index 3066ab44c4..f89bfae3c5 100644 --- a/papi-dts/modules/_renderer_services_scroll_group_service_host_.html +++ b/papi-dts/modules/_renderer_services_scroll_group_service_host_.html @@ -1,4 +1,4 @@ -"renderer/services/scroll-group.service-host" | papi-dts

    Namespace"renderer/services/scroll-group.service-host"

    Index

    Variables

    availableScrollGroupIds +"renderer/services/scroll-group.service-host" | papi-dts

    Namespace"renderer/services/scroll-group.service-host"

    Index

    Variables

    Functions

    getScrRefSync onDidUpdateScrRef setScrRefSync diff --git a/papi-dts/modules/_shared_data_file_system_model_.html b/papi-dts/modules/_shared_data_file_system_model_.html index 70c222ef53..2852831558 100644 --- a/papi-dts/modules/_shared_data_file_system_model_.html +++ b/papi-dts/modules/_shared_data_file_system_model_.html @@ -1,2 +1,2 @@ -"shared/data/file-system.model" | papi-dts

    Namespace"shared/data/file-system.model"

    Index

    Type Aliases

    Uri +"shared/data/file-system.model" | papi-dts

    Namespace"shared/data/file-system.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_data_platform_data_.html b/papi-dts/modules/_shared_data_platform_data_.html index 0284c19cef..e96bacf013 100644 --- a/papi-dts/modules/_shared_data_platform_data_.html +++ b/papi-dts/modules/_shared_data_platform_data_.html @@ -1,3 +1,3 @@ -"shared/data/platform.data" | papi-dts

    Namespace"shared/data/platform.data"

    Index

    Variables

    DEV_MODE_RENDERER_INDICATOR +"shared/data/platform.data" | papi-dts
    diff --git a/papi-dts/modules/_shared_data_rpc_model_.html b/papi-dts/modules/_shared_data_rpc_model_.html index c8dc553f5b..dfe32cc6d0 100644 --- a/papi-dts/modules/_shared_data_rpc_model_.html +++ b/papi-dts/modules/_shared_data_rpc_model_.html @@ -1,4 +1,4 @@ -"shared/data/rpc.model" | papi-dts

    Namespace"shared/data/rpc.model"

    Index

    Enumerations

    ConnectionStatus +"shared/data/rpc.model" | papi-dts

    Namespace"shared/data/rpc.model"

    Index

    Enumerations

    Type Aliases

    EventHandler InternalRequestHandler RequestId diff --git a/papi-dts/modules/_shared_global_this_model_.html b/papi-dts/modules/_shared_global_this_model_.html index ba76e10472..1efb7872b0 100644 --- a/papi-dts/modules/_shared_global_this_model_.html +++ b/papi-dts/modules/_shared_global_this_model_.html @@ -1,2 +1,2 @@ -"shared/global-this.model" | papi-dts

    Namespace"shared/global-this.model"

    Index

    Enumerations

    ProcessType +"shared/global-this.model" | papi-dts

    Namespace"shared/global-this.model"

    Index

    Enumerations

    diff --git a/papi-dts/modules/_shared_log_error_model_.html b/papi-dts/modules/_shared_log_error_model_.html index 2674ce948c..053f7af128 100644 --- a/papi-dts/modules/_shared_log_error_model_.html +++ b/papi-dts/modules/_shared_log_error_model_.html @@ -1,2 +1,2 @@ -"shared/log-error.model" | papi-dts

    Namespace"shared/log-error.model"

    Index

    Classes

    default +"shared/log-error.model" | papi-dts

    Namespace"shared/log-error.model"

    Index

    Classes

    diff --git a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html index d2b3b6defe..aa871ace0c 100644 --- a/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_base_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/base-project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/base-project-data-provider-engine.model"

    Index

    Classes

    BaseProjectDataProviderEngine +"shared/models/base-project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/base-project-data-provider-engine.model"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_create_process_privilege_model_.html b/papi-dts/modules/_shared_models_create_process_privilege_model_.html index 682b925ab7..318d5460a4 100644 --- a/papi-dts/modules/_shared_models_create_process_privilege_model_.html +++ b/papi-dts/modules/_shared_models_create_process_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/create-process-privilege.model" | papi-dts

    Namespace"shared/models/create-process-privilege.model"

    Index

    Type Aliases

    CreateProcess +"shared/models/create-process-privilege.model" | papi-dts

    Namespace"shared/models/create-process-privilege.model"

    Index

    Type Aliases

    CreateProcess OperatingSystemData PlatformFork PlatformSpawn diff --git a/papi-dts/modules/_shared_models_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_data_provider_engine_model_.html index 02a9270528..0f031b504b 100644 --- a/papi-dts/modules/_shared_models_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_engine_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider-engine.model" | papi-dts

    Namespace"shared/models/data-provider-engine.model"

    Index

    Classes

    DataProviderEngine +"shared/models/data-provider-engine.model" | papi-dts

    Namespace"shared/models/data-provider-engine.model"

    Index

    Classes

    Type Aliases

    DataProviderEngineNotifyUpdate default WithNotifyUpdate diff --git a/papi-dts/modules/_shared_models_data_provider_interface_.html b/papi-dts/modules/_shared_models_data_provider_interface_.html index 163ff03e72..c801348b85 100644 --- a/papi-dts/modules/_shared_models_data_provider_interface_.html +++ b/papi-dts/modules/_shared_models_data_provider_interface_.html @@ -1,3 +1,3 @@ -"shared/models/data-provider.interface" | papi-dts

    Namespace"shared/models/data-provider.interface"

    Index

    Type Aliases

    default +"shared/models/data-provider.interface" | papi-dts

    Namespace"shared/models/data-provider.interface"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index aac3209191..e3ee5406d3 100644 --- a/papi-dts/modules/_shared_models_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/data-provider.model" | papi-dts

    Namespace"shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType +"shared/models/data-provider.model" | papi-dts

    Namespace"shared/models/data-provider.model"

    Index

    Type Aliases

    DataProviderDataType DataProviderDataTypes DataProviderGetter DataProviderGetters diff --git a/papi-dts/modules/_shared_models_dialog_options_model_.html b/papi-dts/modules/_shared_models_dialog_options_model_.html index 5986c70500..66a2b46653 100644 --- a/papi-dts/modules/_shared_models_dialog_options_model_.html +++ b/papi-dts/modules/_shared_models_dialog_options_model_.html @@ -1,4 +1,4 @@ -"shared/models/dialog-options.model" | papi-dts

    Namespace"shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData +"shared/models/dialog-options.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 808138f7e8..20b728af43 100644 --- a/papi-dts/modules/_shared_models_docking_framework_model_.html +++ b/papi-dts/modules/_shared_models_docking_framework_model_.html @@ -1,4 +1,4 @@ -"shared/models/docking-framework.model" | papi-dts

    Namespace"shared/models/docking-framework.model"

    Index

    Interfaces

    FloatLayout +"shared/models/docking-framework.model" | papi-dts

    Namespace"shared/models/docking-framework.model"

    Index

    Interfaces

    Type Aliases

    FloatPosition diff --git a/papi-dts/modules/_shared_models_elevated_privileges_model_.html b/papi-dts/modules/_shared_models_elevated_privileges_model_.html index 96f4acb9dc..31ac0c9acd 100644 --- a/papi-dts/modules/_shared_models_elevated_privileges_model_.html +++ b/papi-dts/modules/_shared_models_elevated_privileges_model_.html @@ -1,3 +1,3 @@ -"shared/models/elevated-privileges.model" | papi-dts

    Namespace"shared/models/elevated-privileges.model"

    Index

    Enumerations

    ElevatedPrivilegeNames +"shared/models/elevated-privileges.model" | papi-dts

    Namespace"shared/models/elevated-privileges.model"

    Index

    Enumerations

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_extension_basic_data_model_.html b/papi-dts/modules/_shared_models_extension_basic_data_model_.html index 40e8d251ec..f6385b9d3d 100644 --- a/papi-dts/modules/_shared_models_extension_basic_data_model_.html +++ b/papi-dts/modules/_shared_models_extension_basic_data_model_.html @@ -1,2 +1,2 @@ -"shared/models/extension-basic-data.model" | papi-dts

    Namespace"shared/models/extension-basic-data.model"

    Index

    Type Aliases

    ExtensionBasicData +"shared/models/extension-basic-data.model" | papi-dts

    Namespace"shared/models/extension-basic-data.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html index 6008e40bb0..27f98f2b8f 100644 --- a/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html +++ b/papi-dts/modules/_shared_models_extract_data_provider_data_types_model_.html @@ -1,2 +1,2 @@ -"shared/models/extract-data-provider-data-types.model" | papi-dts

    Namespace"shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    default +"shared/models/extract-data-provider-data-types.model" | papi-dts

    Namespace"shared/models/extract-data-provider-data-types.model"

    Index

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html index f6003e0af1..8fd11750db 100644 --- a/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html +++ b/papi-dts/modules/_shared_models_manage_extensions_privilege_model_.html @@ -1,4 +1,4 @@ -"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace"shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction +"shared/models/manage-extensions-privilege.model" | papi-dts

    Namespace"shared/models/manage-extensions-privilege.model"

    Index

    Type Aliases

    DisableExtensionFunction EnableExtensionFunction ExtensionIdentifier GetInstalledExtensionsFunction diff --git a/papi-dts/modules/_shared_models_network_object_model_.html b/papi-dts/modules/_shared_models_network_object_model_.html index f5ac103fc2..c5ab9c8fbe 100644 --- a/papi-dts/modules/_shared_models_network_object_model_.html +++ b/papi-dts/modules/_shared_models_network_object_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object.model" | papi-dts

    Namespace"shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject +"shared/models/network-object.model" | papi-dts

    Namespace"shared/models/network-object.model"

    Index

    Type Aliases

    DisposableNetworkObject LocalObjectToProxyCreator NetworkableObject NetworkObject diff --git a/papi-dts/modules/_shared_models_network_object_status_service_model_.html b/papi-dts/modules/_shared_models_network_object_status_service_model_.html index 806657e3fe..c3678de168 100644 --- a/papi-dts/modules/_shared_models_network_object_status_service_model_.html +++ b/papi-dts/modules/_shared_models_network_object_status_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/network-object-status.service-model" | papi-dts

    Namespace"shared/models/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType +"shared/models/network-object-status.service-model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_openrpc_model_.html b/papi-dts/modules/_shared_models_openrpc_model_.html index f4ba8d7305..431c3ca3cd 100644 --- a/papi-dts/modules/_shared_models_openrpc_model_.html +++ b/papi-dts/modules/_shared_models_openrpc_model_.html @@ -1,4 +1,4 @@ -"shared/models/openrpc.model" | papi-dts

    Namespace"shared/models/openrpc.model"

    Index

    Type Aliases

    Components +"shared/models/openrpc.model" | papi-dts

    Namespace"shared/models/openrpc.model"

    Index

    Type Aliases

    Components ComponentsReference Contact ContentDescriptor diff --git a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html index 1e04325639..f507b65571 100644 --- a/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html +++ b/papi-dts/modules/_shared_models_papi_network_event_emitter_model_.html @@ -1,2 +1,2 @@ -"shared/models/papi-network-event-emitter.model" | papi-dts

    Namespace"shared/models/papi-network-event-emitter.model"

    Index

    Classes

    default +"shared/models/papi-network-event-emitter.model" | papi-dts

    Namespace"shared/models/papi-network-event-emitter.model"

    Index

    Classes

    diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html index 4f67a4ad0c..296b3ed9d0 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_factory_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine-factory.model" | papi-dts

    Namespace"shared/models/project-data-provider-engine-factory.model"

    Index

    Classes

    LayeringProjectDataProviderEngineFactory +"shared/models/project-data-provider-engine-factory.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html index 9df51eb911..c68faab56a 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_engine_model_.html @@ -1,3 +1,3 @@ -"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/project-data-provider-engine.model"

    Index

    Classes

    ProjectDataProviderEngine +"shared/models/project-data-provider-engine.model" | papi-dts

    Namespace"shared/models/project-data-provider-engine.model"

    Index

    Classes

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html index 291c7dc175..05c45c7623 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_factory_interface_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace"shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    default +"shared/models/project-data-provider-factory.interface" | papi-dts

    Namespace"shared/models/project-data-provider-factory.interface"

    Index

    Interfaces

    Type Aliases

    Variables

    diff --git a/papi-dts/modules/_shared_models_project_data_provider_model_.html b/papi-dts/modules/_shared_models_project_data_provider_model_.html index 679ac9d1b0..7704096313 100644 --- a/papi-dts/modules/_shared_models_project_data_provider_model_.html +++ b/papi-dts/modules/_shared_models_project_data_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-data-provider.model" | papi-dts

    Namespace"shared/models/project-data-provider.model"

    Index

    Type Aliases

    ExtensionDataScope +"shared/models/project-data-provider.model" | papi-dts

    Namespace"shared/models/project-data-provider.model"

    Index

    Type Aliases

    Variables

    PROJECT_INTERFACE_PLATFORM_BASE diff --git a/papi-dts/modules/_shared_models_project_lookup_service_model_.html b/papi-dts/modules/_shared_models_project_lookup_service_model_.html index 946538b81e..1514e5348a 100644 --- a/papi-dts/modules/_shared_models_project_lookup_service_model_.html +++ b/papi-dts/modules/_shared_models_project_lookup_service_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-lookup.service-model" | papi-dts

    Namespace"shared/models/project-lookup.service-model"

    Index

    Type Aliases

    ProjectLookupServiceType +"shared/models/project-lookup.service-model" | papi-dts

    Namespace"shared/models/project-lookup.service-model"

    Index

    Type Aliases

    Variables

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE projectLookupServiceBase testingProjectLookupService diff --git a/papi-dts/modules/_shared_models_project_metadata_model_.html b/papi-dts/modules/_shared_models_project_metadata_model_.html index 6f8da723f9..7dd3981c5b 100644 --- a/papi-dts/modules/_shared_models_project_metadata_model_.html +++ b/papi-dts/modules/_shared_models_project_metadata_model_.html @@ -1,4 +1,4 @@ -"shared/models/project-metadata.model" | papi-dts

    Namespace"shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo +"shared/models/project-metadata.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_models_rpc_interface_.html b/papi-dts/modules/_shared_models_rpc_interface_.html index b6b03f25e8..df4d62d4db 100644 --- a/papi-dts/modules/_shared_models_rpc_interface_.html +++ b/papi-dts/modules/_shared_models_rpc_interface_.html @@ -1,4 +1,4 @@ -"shared/models/rpc.interface" | papi-dts

    Namespace"shared/models/rpc.interface"

    Index

    Interfaces

    IRpcHandler +"shared/models/rpc.interface" | papi-dts

    Namespace"shared/models/rpc.interface"

    Index

    Interfaces

    Type Aliases

    diff --git a/papi-dts/modules/_shared_models_web_view_factory_model_.html b/papi-dts/modules/_shared_models_web_view_factory_model_.html index d7e314df73..ae1e523b2e 100644 --- a/papi-dts/modules/_shared_models_web_view_factory_model_.html +++ b/papi-dts/modules/_shared_models_web_view_factory_model_.html @@ -1,2 +1,2 @@ -"shared/models/web-view-factory.model" | papi-dts

    Namespace"shared/models/web-view-factory.model"

    Index

    Classes

    WebViewFactory +"shared/models/web-view-factory.model" | papi-dts

    Namespace"shared/models/web-view-factory.model"

    Index

    Classes

    diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index 47ac8deed9..1132c8e684 100644 --- a/papi-dts/modules/_shared_models_web_view_model_.html +++ b/papi-dts/modules/_shared_models_web_view_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view.model" | papi-dts

    Namespace"shared/models/web-view.model"

    Index

    Enumerations

    WebViewContentType +"shared/models/web-view.model" | papi-dts

    Namespace"shared/models/web-view.model"

    Index

    Enumerations

    Type Aliases

    GetSavedWebViewDefinition GetWebViewOptions SavedWebViewDefinition diff --git a/papi-dts/modules/_shared_models_web_view_provider_model_.html b/papi-dts/modules/_shared_models_web_view_provider_model_.html index 13cc17c7ef..bc18a38bae 100644 --- a/papi-dts/modules/_shared_models_web_view_provider_model_.html +++ b/papi-dts/modules/_shared_models_web_view_provider_model_.html @@ -1,4 +1,4 @@ -"shared/models/web-view-provider.model" | papi-dts

    Namespace"shared/models/web-view-provider.model"

    Index

    Interfaces

    IDisposableWebViewProvider +"shared/models/web-view-provider.model" | papi-dts
    diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index 491dd1ebb2..a1822f0954 100644 --- a/papi-dts/modules/_shared_services_command_service_.html +++ b/papi-dts/modules/_shared_services_command_service_.html @@ -1,4 +1,4 @@ -"shared/services/command.service" | papi-dts

    Namespace"shared/services/command.service"

    Index

    Type Aliases

    moduleSummaryComments +"shared/services/command.service" | papi-dts

    Namespace"shared/services/command.service"

    Index

    Type Aliases

    Functions

    createSendCommandFunction registerCommand sendCommand diff --git a/papi-dts/modules/_shared_services_data_provider_service_.html b/papi-dts/modules/_shared_services_data_provider_service_.html index f12fda0bdf..d47cb00d31 100644 --- a/papi-dts/modules/_shared_services_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/data-provider.service" | papi-dts

    Namespace"shared/services/data-provider.service"

    Index

    Interfaces

    DataProviderService +"shared/services/data-provider.service" | papi-dts

    Namespace"shared/services/data-provider.service"

    Index

    Interfaces

    Variables

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index 1ae124ae06..d533f84199 100644 --- a/papi-dts/modules/_shared_services_dialog_service_.html +++ b/papi-dts/modules/_shared_services_dialog_service_.html @@ -1,2 +1,2 @@ -"shared/services/dialog.service" | papi-dts

    Namespace"shared/services/dialog.service"

    Index

    Variables

    default +"shared/services/dialog.service" | papi-dts

    Namespace"shared/services/dialog.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index 42542db3a6..e7bcbcc916 100644 --- a/papi-dts/modules/_shared_services_dialog_service_model_.html +++ b/papi-dts/modules/_shared_services_dialog_service_model_.html @@ -1,3 +1,3 @@ -"shared/services/dialog.service-model" | papi-dts

    Namespace"shared/services/dialog.service-model"

    Index

    Interfaces

    DialogService +"shared/services/dialog.service-model" | papi-dts

    Namespace"shared/services/dialog.service-model"

    Index

    Interfaces

    Variables

    diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index f1e8a947ec..8c9216fa0a 100644 --- a/papi-dts/modules/_shared_services_internet_service_.html +++ b/papi-dts/modules/_shared_services_internet_service_.html @@ -1,3 +1,3 @@ -"shared/services/internet.service" | papi-dts

    Namespace"shared/services/internet.service"

    Index

    Interfaces

    InternetService +"shared/services/internet.service" | papi-dts

    Namespace"shared/services/internet.service"

    Index

    Interfaces

    Variables

    diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index 9a22ef1848..a43aabcc0b 100644 --- a/papi-dts/modules/_shared_services_localization_service_.html +++ b/papi-dts/modules/_shared_services_localization_service_.html @@ -1,2 +1,2 @@ -"shared/services/localization.service" | papi-dts

    Namespace"shared/services/localization.service"

    Index

    Variables

    default +"shared/services/localization.service" | papi-dts

    Namespace"shared/services/localization.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index cb463341c4..aaf06873dc 100644 --- a/papi-dts/modules/_shared_services_localization_service_model_.html +++ b/papi-dts/modules/_shared_services_localization_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/localization.service-model" | papi-dts

    Namespace"shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService +"shared/services/localization.service-model" | papi-dts

    Namespace"shared/services/localization.service-model"

    Index

    Type Aliases

    ILocalizationService LocalizationData LocalizationDataDataTypes LocalizationSelector diff --git a/papi-dts/modules/_shared_services_logger_service_.html b/papi-dts/modules/_shared_services_logger_service_.html index a4bf8c5314..25da44ef11 100644 --- a/papi-dts/modules/_shared_services_logger_service_.html +++ b/papi-dts/modules/_shared_services_logger_service_.html @@ -1,4 +1,4 @@ -"shared/services/logger.service" | papi-dts

    Namespace"shared/services/logger.service"

    Index

    Variables

    default +"shared/services/logger.service" | papi-dts

    Namespace"shared/services/logger.service"

    Index

    Variables

    Functions

    diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index 8a520b87a1..cb525298b2 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_.html @@ -1,2 +1,2 @@ -"shared/services/menu-data.service" | papi-dts

    Namespace"shared/services/menu-data.service"

    Index

    Variables

    default +"shared/services/menu-data.service" | papi-dts

    Namespace"shared/services/menu-data.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_menu_data_service_model_.html b/papi-dts/modules/_shared_services_menu_data_service_model_.html index 330fe362fb..c34b4692f1 100644 --- a/papi-dts/modules/_shared_services_menu_data_service_model_.html +++ b/papi-dts/modules/_shared_services_menu_data_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/menu-data.service-model" | papi-dts

    Namespace"shared/services/menu-data.service-model"

    Index

    Type Aliases

    IMenuDataService +"shared/services/menu-data.service-model" | papi-dts

    Namespace"shared/services/menu-data.service-model"

    Index

    Type Aliases

    Variables

    menuDataServiceObjectToProxy menuDataServiceProviderName diff --git a/papi-dts/modules/_shared_services_network_object_service_.html b/papi-dts/modules/_shared_services_network_object_service_.html index e0a3146a06..44dc46eccf 100644 --- a/papi-dts/modules/_shared_services_network_object_service_.html +++ b/papi-dts/modules/_shared_services_network_object_service_.html @@ -1,4 +1,4 @@ -"shared/services/network-object.service" | papi-dts

    Namespace"shared/services/network-object.service"

    Index

    Interfaces

    MinimalNetworkObjectService +"shared/services/network-object.service" | papi-dts

    Namespace"shared/services/network-object.service"

    Index

    Interfaces

    Variables

    default minimalNetworkObjectService diff --git a/papi-dts/modules/_shared_services_network_object_status_service_.html b/papi-dts/modules/_shared_services_network_object_status_service_.html index 420b29a23a..349c467e17 100644 --- a/papi-dts/modules/_shared_services_network_object_status_service_.html +++ b/papi-dts/modules/_shared_services_network_object_status_service_.html @@ -1,2 +1,2 @@ -"shared/services/network-object-status.service" | papi-dts

    Namespace"shared/services/network-object-status.service"

    Index

    Variables

    default +"shared/services/network-object-status.service" | papi-dts

    Namespace"shared/services/network-object-status.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 7cdd9e4142..0535577c23 100644 --- a/papi-dts/modules/_shared_services_network_service_.html +++ b/papi-dts/modules/_shared_services_network_service_.html @@ -1,4 +1,4 @@ -"shared/services/network.service" | papi-dts

    Namespace"shared/services/network.service"

    Index

    Interfaces

    PapiNetworkService +"shared/services/network.service" | papi-dts

    Namespace"shared/services/network.service"

    Index

    Interfaces

    Variables

    Functions

    createNetworkEventEmitter createRequestFunction diff --git a/papi-dts/modules/_shared_services_project_data_provider_service_.html b/papi-dts/modules/_shared_services_project_data_provider_service_.html index db990008a4..846d1b5f1a 100644 --- a/papi-dts/modules/_shared_services_project_data_provider_service_.html +++ b/papi-dts/modules/_shared_services_project_data_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/project-data-provider.service" | papi-dts

    Namespace"shared/services/project-data-provider.service"

    Index

    Interfaces

    PapiBackendProjectDataProviderService +"shared/services/project-data-provider.service" | papi-dts

    Namespace"shared/services/project-data-provider.service"

    Index

    Interfaces

    Variables

    papiBackendProjectDataProviderService papiFrontendProjectDataProviderService diff --git a/papi-dts/modules/_shared_services_project_lookup_service_.html b/papi-dts/modules/_shared_services_project_lookup_service_.html index 52a68687e9..4699df1f5b 100644 --- a/papi-dts/modules/_shared_services_project_lookup_service_.html +++ b/papi-dts/modules/_shared_services_project_lookup_service_.html @@ -1,2 +1,2 @@ -"shared/services/project-lookup.service" | papi-dts

    Namespace"shared/services/project-lookup.service"

    Index

    Variables

    default +"shared/services/project-lookup.service" | papi-dts

    Namespace"shared/services/project-lookup.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index f284aa2c73..e4f99b224c 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_.html @@ -1,3 +1,3 @@ -"shared/services/project-settings.service" | papi-dts

    Namespace"shared/services/project-settings.service"

    Index

    Variables

    default +"shared/services/project-settings.service" | papi-dts
    diff --git a/papi-dts/modules/_shared_services_project_settings_service_model_.html b/papi-dts/modules/_shared_services_project_settings_service_model_.html index 90a2c5742d..9104b21921 100644 --- a/papi-dts/modules/_shared_services_project_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_project_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/project-settings.service-model" | papi-dts

    Namespace"shared/services/project-settings.service-model"

    Index

    Interfaces

    IProjectSettingsService +"shared/services/project-settings.service-model" | papi-dts

    Namespace"shared/services/project-settings.service-model"

    Index

    Interfaces

    Type Aliases

    AllProjectSettingsValidators ProjectSettingValidator SimultaneousProjectSettingsChanges diff --git a/papi-dts/modules/_shared_services_rpc_handler_factory_.html b/papi-dts/modules/_shared_services_rpc_handler_factory_.html index bfd5da630b..129f498655 100644 --- a/papi-dts/modules/_shared_services_rpc_handler_factory_.html +++ b/papi-dts/modules/_shared_services_rpc_handler_factory_.html @@ -1,2 +1,2 @@ -"shared/services/rpc-handler.factory" | papi-dts

    Namespace"shared/services/rpc-handler.factory"

    Index

    Functions

    createRpcHandler +"shared/services/rpc-handler.factory" | papi-dts

    Namespace"shared/services/rpc-handler.factory"

    Index

    Functions

    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_.html b/papi-dts/modules/_shared_services_scroll_group_service_.html index f2467aaa1a..530582cce4 100644 --- a/papi-dts/modules/_shared_services_scroll_group_service_.html +++ b/papi-dts/modules/_shared_services_scroll_group_service_.html @@ -1,2 +1,2 @@ -"shared/services/scroll-group.service" | papi-dts

    Namespace"shared/services/scroll-group.service"

    Index

    Variables

    default +"shared/services/scroll-group.service" | papi-dts

    Namespace"shared/services/scroll-group.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_model_.html b/papi-dts/modules/_shared_services_scroll_group_service_model_.html index 9ebdff464c..26f043f893 100644 --- a/papi-dts/modules/_shared_services_scroll_group_service_model_.html +++ b/papi-dts/modules/_shared_services_scroll_group_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/scroll-group.service-model" | papi-dts

    Namespace"shared/services/scroll-group.service-model"

    Index

    Interfaces

    IScrollGroupRemoteService +"shared/services/scroll-group.service-model" | papi-dts

    Namespace"shared/services/scroll-group.service-model"

    Index

    Interfaces

    Type Aliases

    ScrollGroupScrRef ScrollGroupUpdateInfo diff --git a/papi-dts/modules/_shared_services_settings_service_.html b/papi-dts/modules/_shared_services_settings_service_.html index 51d87f2d69..9b3299cf9f 100644 --- a/papi-dts/modules/_shared_services_settings_service_.html +++ b/papi-dts/modules/_shared_services_settings_service_.html @@ -1,2 +1,2 @@ -"shared/services/settings.service" | papi-dts

    Namespace"shared/services/settings.service"

    Index

    Variables

    default +"shared/services/settings.service" | papi-dts

    Namespace"shared/services/settings.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index d0e0645cbb..05b2ea3d60 100644 --- a/papi-dts/modules/_shared_services_settings_service_model_.html +++ b/papi-dts/modules/_shared_services_settings_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/settings.service-model" | papi-dts

    Namespace"shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData +"shared/services/settings.service-model" | papi-dts

    Namespace"shared/services/settings.service-model"

    Index

    Type Aliases

    AllSettingsData AllSettingsValidators ISettingsService SettingDataTypes diff --git a/papi-dts/modules/_shared_services_web_view_provider_service_.html b/papi-dts/modules/_shared_services_web_view_provider_service_.html index c12548c73c..c689fd5c64 100644 --- a/papi-dts/modules/_shared_services_web_view_provider_service_.html +++ b/papi-dts/modules/_shared_services_web_view_provider_service_.html @@ -1,4 +1,4 @@ -"shared/services/web-view-provider.service" | papi-dts

    Namespace"shared/services/web-view-provider.service"

    Index

    Interfaces

    PapiWebViewProviderService +"shared/services/web-view-provider.service" | papi-dts

    Namespace"shared/services/web-view-provider.service"

    Index

    Interfaces

    Variables

    default papiWebViewProviderService diff --git a/papi-dts/modules/_shared_services_web_view_service_.html b/papi-dts/modules/_shared_services_web_view_service_.html index ae1d94c33b..a4c1ca550c 100644 --- a/papi-dts/modules/_shared_services_web_view_service_.html +++ b/papi-dts/modules/_shared_services_web_view_service_.html @@ -1,2 +1,2 @@ -"shared/services/web-view.service" | papi-dts

    Namespace"shared/services/web-view.service"

    Index

    Variables

    default +"shared/services/web-view.service" | papi-dts

    Namespace"shared/services/web-view.service"

    Index

    Variables

    diff --git a/papi-dts/modules/_shared_services_web_view_service_model_.html b/papi-dts/modules/_shared_services_web_view_service_model_.html index 8f5564fea6..2b48404462 100644 --- a/papi-dts/modules/_shared_services_web_view_service_model_.html +++ b/papi-dts/modules/_shared_services_web_view_service_model_.html @@ -1,4 +1,4 @@ -"shared/services/web-view.service-model" | papi-dts

    Namespace"shared/services/web-view.service-model"

    Index

    Interfaces

    WebViewServiceType +"shared/services/web-view.service-model" | papi-dts

    Namespace"shared/services/web-view.service-model"

    Index

    Interfaces

    Type Aliases

    CloseWebViewEvent OpenWebViewEvent UpdateWebViewEvent diff --git a/papi-dts/modules/_shared_utils_internal_util_.html b/papi-dts/modules/_shared_utils_internal_util_.html index 2ba7b76141..08c6b31702 100644 --- a/papi-dts/modules/_shared_utils_internal_util_.html +++ b/papi-dts/modules/_shared_utils_internal_util_.html @@ -1,4 +1,4 @@ -"shared/utils/internal-util" | papi-dts

    Namespace"shared/utils/internal-util"

    Index

    Functions

    getProcessType +"shared/utils/internal-util" | papi-dts

    Namespace"shared/utils/internal-util"

    Index

    Functions

    getProcessType isClient isExtensionHost isRenderer diff --git a/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html b/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html index 8dc3f1ae66..277ae93490 100644 --- a/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html +++ b/papi-dts/modules/_shared_utils_project_settings_document_combiner_.html @@ -1,4 +1,4 @@ -"shared/utils/project-settings-document-combiner" | papi-dts

    Namespace"shared/utils/project-settings-document-combiner"

    Index

    Classes

    default +"shared/utils/project-settings-document-combiner" | papi-dts

    Namespace"shared/utils/project-settings-document-combiner"

    Index

    Classes

    Type Aliases

    AllProjectSettingsInfo LocalizedProjectSettingsContributionInfo ProjectSettingInfo diff --git a/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html b/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html index 209a11a568..2672e75690 100644 --- a/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html +++ b/papi-dts/modules/_shared_utils_settings_document_combiner_base_.html @@ -1,4 +1,4 @@ -"shared/utils/settings-document-combiner-base" | papi-dts

    Namespace"shared/utils/settings-document-combiner-base"

    Index

    Classes

    default +"shared/utils/settings-document-combiner-base" | papi-dts

    Namespace"shared/utils/settings-document-combiner-base"

    Index

    Classes

    Type Aliases

    AllSettingsInfo LocalizedSettingsContributionInfo SettingInfo diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index 7a7d0f03ed..9141702ce6 100644 --- a/papi-dts/modules/_shared_utils_util_.html +++ b/papi-dts/modules/_shared_utils_util_.html @@ -1,4 +1,4 @@ -"shared/utils/util" | papi-dts

    Namespace"shared/utils/util"

    Index

    Type Aliases

    RequestType +"shared/utils/util" | papi-dts

    Namespace"shared/utils/util"

    Index

    Type Aliases

    Variables

    MODULE_SIMILAR_APIS REQUEST_TYPE_SEPARATOR diff --git a/papi-dts/types/__papi_frontend_.Papi.html b/papi-dts/types/__papi_frontend_.Papi.html index 9069fa095f..e1896eacb1 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts
    +Papi | papi-dts
    diff --git a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html index 0d36c9f5b5..ce235f59c5 100644 --- a/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html +++ b/papi-dts/types/_client_services_web_socket_interface_.IWebSocket.html @@ -3,4 +3,4 @@ ClientNetworkConnector. For now, we are just using the browser WebSocket type. We may need specific functionality that don't line up between the ws library's implementation and the browser implementation. We can adjust as needed at that point.

    -
    +
    diff --git a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html index 599c68c51e..d01edb99c5 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html +++ b/papi-dts/types/_extension_host_extension_types_extension_activation_context_model_.ExecutionActivationContext.html @@ -9,4 +9,4 @@
  • executionToken: ExecutionToken

    Used to save and load data by the storage service.

  • name: string

    Canonical name of the extension

  • registrations: UnsubscriberAsyncList

    Tracks all registrations made by an extension so they can be cleaned up when it is unloaded

    -
  • +
    diff --git a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html index 6f524e2572..a6482bd41e 100644 --- a/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html +++ b/papi-dts/types/_extension_host_extension_types_extension_manifest_model_.ExtensionManifest.html @@ -23,4 +23,4 @@ for more information about extension type declaration files.

  • version: string

    Extension version - expected to be semver like "0.1.3".

    Note: semver may become a hard requirement in the future, so we recommend using it now.

    -
  • +
    diff --git a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html index a5151de37d..70cd74842a 100644 --- a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html +++ b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html @@ -1 +1 @@ -PropagateEventMethod | papi-dts
    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)
    +PropagateEventMethod | papi-dts
    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)
    diff --git a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html index 0eb9c71629..83916ba1c9 100644 --- a/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html +++ b/papi-dts/types/_node_models_execution_token_model_.ExecutionTokenType.html @@ -1,2 +1,2 @@ ExecutionTokenType | papi-dts
    ExecutionTokenType

    For now this is just for extensions, but maybe we will want to expand this in the future

    -
    +
    diff --git a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html index e88a00f294..5cfade9835 100644 --- a/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html +++ b/papi-dts/types/_node_services_node_file_system_service_.DirectoryEntries.html @@ -1,2 +1,2 @@ DirectoryEntries | papi-dts
    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

    All entries in a directory, mapped from entry type to array of uris for the entries

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index 73f25b4fc8..683b9ccb5c 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -3,4 +3,4 @@
    'platform.quit';
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index c000d1d50d..267e847f7a 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -3,4 +3,4 @@
    'platform.placeholder'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 5c16d4b4b7..03e34975ee 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -4,4 +4,4 @@
    DataProviderTypes['helloSomeone.people'] => {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    People: DataProviderDataType<undefined, PeopleData, never>;
    }
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index 41c1426079..5816e3d79e 100644 --- a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html +++ b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html @@ -2,4 +2,4 @@ returned from papi.dataProviders.registerEngine - only the one who registers a data provider engine is allowed to dispose of the data provider.

    Automatically includes all extensions' data providers that are added to DataProviders.

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html index 56b5552d45..97c56a32d0 100644 --- a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html @@ -19,4 +19,4 @@
  • callback: ((value: ProjectSettingTypes[ProjectSettingName]) => void)

    Function to run with the updated project setting value

  • options: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index a7f81ca300..337152de4b 100644 --- a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html +++ b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html @@ -10,4 +10,4 @@ IBaseProjectDataProvider, which imposes additional requirements.

    See more information, including the difference between Base and Layering PDPs, at ProjectDataProviderInterfaces.

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 3c1424b583..3dfbbb3a10 100644 --- a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html @@ -1,2 +1,2 @@ NotesOnlyProjectDataTypes | papi-dts

    Type AliasNotesOnlyProjectDataTypes

    NotesOnlyProjectDataTypes: MandatoryProjectDataTypes & {
        Notes: DataProviderDataType<string, string | undefined, string>;
    }

    This is just a simple example so we have more than one. It's not intended to be real.

    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 8f00467a5b..6bf242ddf8 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }
    +PlaceholderDataTypes | papi-dts
    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index 3a30357d31..59b77a5bb3 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -8,4 +8,4 @@
    ProjectInterfaceDataTypes['MyExtensionProjectInterfaceName'] => MandatoryProjectDataTypes & {
    MyProjectData: DataProviderDataType<string, string, string>;
    }
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index 8608df980c..3ab6706de3 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -7,4 +7,4 @@
    'platform.notesOnly'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index 973db6896b..b1e45065c4 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -4,4 +4,4 @@
    'platform.fullName'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 309397abfa..93255ebaa5 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -3,4 +3,4 @@
    'platform.verseRef'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index e99a795552..06431fa164 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }
    +StuffDataTypes | papi-dts
    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }
    diff --git a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html index 6c1cd1f1ff..fc48bff2f5 100644 --- a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html +++ b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html @@ -4,4 +4,4 @@
    'platform.placeholderWebView'
     
    -
    +
    diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index 9abfa80e5e..3f5e41b198 100644 --- a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html +++ b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html @@ -25,4 +25,4 @@
  • newSetting: ProjectSettingTypes[ProjectSettingName]

    The value that is to be set to the project setting.

  • Returns Promise<DataProviderUpdateInstructions<TProjectDataTypes & MandatoryProjectDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html index bbc6cc0ef4..65783adb2e 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogDefinitionBase.html @@ -14,4 +14,4 @@

    TODO: preserve requests between refreshes - save the dialog info in such a way that it works when loading again after refresh

  • OptionaltabType?: string

    Overwritten in DialogDefinition. Must be specified by all DialogDefinitions

    -
  • +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html index a375d3cc8b..d3f47c3226 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_base_data_.DialogProps.html @@ -1,7 +1,7 @@ DialogProps | papi-dts
    DialogProps<TData>: DialogData & {
        cancelDialog(): void;
        rejectDialog(errorMessage: string): void;
        submitDialog(data: TData): void;
    }

    Props provided to the dialog component

    Type Parameters

    • TData = unknown

    Type declaration

    • cancelDialog:function
      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • Rejects the dialog request with the specified message and closes the dialog

        Parameters

        • errorMessage: string

          Message to explain why the dialog request was rejected

          -

        Returns void

    • submitDialog:function
      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • Sends the data as a resolved response to the dialog request and closes the dialog

      Parameters

      • data: TData

        Data with which to resolve the request

        -

      Returns void

  • +

    Returns void

    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html index eb14ed9c34..89832d3c4f 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDataTypes.html @@ -5,4 +5,4 @@ as props

  • props: DialogProps<TReturnType> & TOptions

    Props provided to the dialog component

  • responseType: TReturnType

    The type of the response to the dialog request

    -
  • +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html index 74d538c3ca..43a082ff71 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogDefinition.html @@ -1 +1 @@ -DialogDefinition | papi-dts
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    +DialogDefinition | papi-dts
    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html index 9ee313541a..578bf6b1ae 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.DialogTabTypes.html @@ -1,2 +1,2 @@ DialogTabTypes | papi-dts
    DialogTabTypes: keyof DialogTypes

    Each type of dialog. These are the tab types used in the dock layout

    -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html index e4bcbb7114..1dc6a6c4ae 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.ProjectDialogOptionsBase.html @@ -1 +1 @@ -ProjectDialogOptionsBase | papi-dts
    +ProjectDialogOptionsBase | papi-dts
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html index 83079b48fc..43bab11306 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectBooksDialogOptions.html @@ -1,3 +1,3 @@ SelectBooksDialogOptions | papi-dts
    SelectBooksDialogOptions: DialogOptions & {
        selectedBookIds?: string[];
    }

    Options to provide when showing the Select Books dialog

    Type declaration

    • OptionalselectedBookIds?: string[]

      Books IDs that should start selected in the dialog

      -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html index 4b1ca88c44..52c21d64bc 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectMultipleProjectsDialogOptions.html @@ -1,3 +1,3 @@ SelectMultipleProjectsDialogOptions | papi-dts
    SelectMultipleProjectsDialogOptions: ProjectDialogOptionsBase & {
        selectedProjectIds?: string[];
    }

    Options to provide when showing the Select Multiple Project dialog

    Type declaration

    • OptionalselectedProjectIds?: string[]

      Project IDs that should start selected in the dialog

      -
    +
    diff --git a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html index 74c90f43dd..5bb419519f 100644 --- a/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html +++ b/papi-dts/types/_renderer_components_dialogs_dialog_definition_model_.SelectProjectDialogOptions.html @@ -1,2 +1,2 @@ SelectProjectDialogOptions | papi-dts
    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -
    +
    diff --git a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html index e5869ecc4b..f42c404af9 100644 --- a/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html +++ b/papi-dts/types/_renderer_hooks_papi_hooks_use_dialog_callback_hook_.UseDialogCallbackOptions.html @@ -1,4 +1,4 @@ UseDialogCallbackOptions | papi-dts
    UseDialogCallbackOptions: {
        maximumOpenDialogs?: number;
    }

    Type declaration

    • OptionalmaximumOpenDialogs?: number

      How many dialogs are allowed to be open at once from this dialog callback. Calling the callback when this number of maximum open dialogs has been reached does nothing. Set to -1 for unlimited. Defaults to 1.

      -
    +
    diff --git a/papi-dts/types/_shared_data_file_system_model_.Uri.html b/papi-dts/types/_shared_data_file_system_model_.Uri.html index f15a444585..ea9d2a5beb 100644 --- a/papi-dts/types/_shared_data_file_system_model_.Uri.html +++ b/papi-dts/types/_shared_data_file_system_model_.Uri.html @@ -29,4 +29,4 @@

    Note: projects are stored in the production version of app://projects regardless of whether you are in production or development

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html index 3db019348c..300d4f2370 100644 --- a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html +++ b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html @@ -1,2 +1,2 @@ EventHandler | papi-dts
    EventHandler: (<T>(eventType: string, event: T) => void)

    Function that processes an event received locally or over the network

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html index 8fc6b52047..4e633bcb19 100644 --- a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html +++ b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html @@ -1,4 +1,4 @@ InternalRequestHandler | papi-dts
    InternalRequestHandler: ((...requestParams: RequestParams) => any)

    Function to call internally when a request is received. The return value is sent back as the response to the request. If the request was received over the network, the response will be packaged into a JSONRPCSuccessResponse message.

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestId.html b/papi-dts/types/_shared_data_rpc_model_.RequestId.html index d41120c324..e5f9d5ed44 100644 --- a/papi-dts/types/_shared_data_rpc_model_.RequestId.html +++ b/papi-dts/types/_shared_data_rpc_model_.RequestId.html @@ -1,3 +1,3 @@ RequestId | papi-dts
    RequestId: number | string

    ID of an individual request. It must be unique between an RPC client and server for a single connection. Once a connection has closed and reopens, IDs can be reused.

    -
    +
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html index f6afed1c88..08d4e71c17 100644 --- a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html +++ b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html @@ -1,2 +1,2 @@ RequestParams | papi-dts
    RequestParams: any[]

    Parameters provided to an RPC request message

    -
    +
    diff --git a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html index 76b833db36..e5cd78f799 100644 --- a/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_base_project_data_provider_engine_model_.IBaseProjectDataProviderEngine.html @@ -30,4 +30,4 @@
    class MyPDPE implements IBaseProjectDataProviderEngine<['MyProjectData']> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html b/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html index f9efa99286..c4c001c0d9 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.CreateProcess.html @@ -1 +1 @@ -CreateProcess | papi-dts
    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }
    +CreateProcess | papi-dts
    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html b/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html index e6b8016f39..cc43612b63 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.OperatingSystemData.html @@ -2,4 +2,4 @@

    Type declaration

    • platform: string

      Value of os.platform() in Node

    • release: string

      Value of os.release() in Node

    • type: string

      Value of os.type() in Node

      -
    +
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html index ed24093384..794e48b630 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformFork.html @@ -19,4 +19,4 @@ createProcess.fork(executionToken, 'assets/childProcess.js'); -
    +
    diff --git a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html index c9d98738cb..d6d79f51bd 100644 --- a/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html +++ b/papi-dts/types/_shared_models_create_process_privilege_model_.PlatformSpawn.html @@ -31,4 +31,4 @@ } -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html index e2a2818c2f..0646606f8b 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.DataProviderEngineNotifyUpdate.html @@ -22,4 +22,4 @@

    @see DataProviderUpdateInstructions for more info on the updateInstructions parameter

    WARNING: Do not update a data type in its get<data_type> method (unless you make a base case)! It will create a destructive infinite loop.

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html index c32f8fec2a..c037147c6b 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.WithNotifyUpdate.html @@ -29,4 +29,4 @@
  • DataProviderEngineNotifyUpdate for more information on notifyUpdate.
  • IDataProviderEngine for more information on using this type.
  • -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html index 7d0b41d183..ffe311d42e 100644 --- a/papi-dts/types/_shared_models_data_provider_engine_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_engine_model_.default.html @@ -26,4 +26,4 @@
    class MyDPE implements IDataProviderEngine<MyDataTypes> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<MyDataTypes>) {}
    ...
    }
    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html index eec84168c4..b68f797f63 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.IDisposableDataProvider.html @@ -2,4 +2,4 @@ data provider (only the service that set it up should dispose of it) with dataProviderService.registerEngine

    Type Parameters

    +
    diff --git a/papi-dts/types/_shared_models_data_provider_interface_.default.html b/papi-dts/types/_shared_models_data_provider_interface_.default.html index 324551c148..f4bfb3aff7 100644 --- a/papi-dts/types/_shared_models_data_provider_interface_.default.html +++ b/papi-dts/types/_shared_models_data_provider_interface_.default.html @@ -3,4 +3,4 @@ getting a data provider with papi.dataProviders.get.

    Note: each set<data_type> method has a corresponding get<data_type> and subscribe<data_type> method.

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html index 854d90effa..be353765f5 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataType.html @@ -7,4 +7,4 @@ wants at this data type.

  • setData: TSetData

    The type of data ingested by this data provider when you run set<data_type> based on a provided selector

    -
  • +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html index dec407a642..07d70362a7 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderDataTypes.html @@ -8,4 +8,4 @@
    {
    Greeting: DataProviderDataType<string, string | undefined, string>;
    Age: DataProviderDataType<string, number | undefined, number>;
    All: DataProviderDataType<undefined, { greeting: string, age: number }, never>;
    }
    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html index d667b518a8..5930ad3f0f 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetter.html @@ -4,4 +4,4 @@ up-to-date.

    Type Parameters

    Type declaration

      • (selector): Promise<TDataType["getData"]>
      • Parameters

        • selector: TDataType["selector"]

          Tells the provider what subset of data to get

        Returns Promise<TDataType["getData"]>

        The subset of data represented by the selector

        -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html index 86cae0d6f2..83c13ddf57 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderGetters.html @@ -1,3 +1,3 @@ DataProviderGetters | papi-dts

    Type AliasDataProviderGetters<TDataTypes>

    DataProviderGetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `get${DataType & string}`]: DataProviderGetter<TDataTypes[DataType]>
    }

    Set of all get<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    DataProviderGetter for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html index 28fee772e2..904004d105 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetter.html @@ -6,4 +6,4 @@

    Returns Promise<DataProviderUpdateInstructions<TDataTypes>>

    Information that papi uses to interpret whether to send out updates. Defaults to true (meaning send updates only for this data type).

    DataProviderUpdateInstructions for more info on what to return

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html index 539e94b51a..493f3ecf67 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSetters.html @@ -1,3 +1,3 @@ DataProviderSetters | papi-dts

    Type AliasDataProviderSetters<TDataTypes>

    DataProviderSetters<TDataTypes>: {
        [DataType in keyof TDataTypes as `set${DataType & string}`]: DataProviderSetter<TDataTypes, DataType>
    }

    Set of all set<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    DataProviderSetter for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html index 1fccb674e4..1eac0bd9e0 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriber.html @@ -8,4 +8,4 @@
  • callback: PlatformEventHandler<TDataType["getData"]>

    Function to run with the updated data for this selector

  • Optionaloptions: DataProviderSubscriberOptions

    Various options to adjust how the subscriber emits updates

  • Returns Promise<UnsubscriberAsync>

    Unsubscriber to stop listening for updates

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html index cd8b95dd99..4724a64fd2 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscriberOptions.html @@ -25,4 +25,4 @@
    'deeply-equal'
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html index 3ef85b66b0..268d58bd36 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderSubscribers.html @@ -1,4 +1,4 @@ DataProviderSubscribers | papi-dts

    Type AliasDataProviderSubscribers<TDataTypes>

    DataProviderSubscribers<TDataTypes>: {
        [DataType in keyof TDataTypes as `subscribe${DataType & string}`]: DataProviderSubscriber<TDataTypes[DataType]>
    }

    Set of all subscribe<data_type> methods that a data provider provides according to its data types.

    Type Parameters

    DataProviderSubscriber for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html index afa0cc92e0..972f079679 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataProviderUpdateInstructions.html @@ -21,4 +21,4 @@

    false (or falsy) do not update subscriptions

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html index af931692c4..b0631d61ab 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html +++ b/papi-dts/types/_shared_models_data_provider_model_.DataTypeNames.html @@ -1,4 +1,4 @@ DataTypeNames | papi-dts
    DataTypeNames<TDataTypes>: keyof TDataTypes & string

    Names of data types in a DataProviderDataTypes type. Indicates the data types that a data provider can handle (so it will have methods with these names like set<data_type>)

    Type Parameters

    DataProviderDataTypes for more information

    -
    +
    diff --git a/papi-dts/types/_shared_models_data_provider_model_.default.html b/papi-dts/types/_shared_models_data_provider_model_.default.html index f077a97050..158ededf97 100644 --- a/papi-dts/types/_shared_models_data_provider_model_.default.html +++ b/papi-dts/types/_shared_models_data_provider_model_.default.html @@ -2,4 +2,4 @@ object layers over the data provider engine and runs its methods along with other methods. This object is transformed into an IDataProvider by networkObjectService.set.

    Type Parameters

    IDataProvider

    -
    +
    diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html index 3ce20bd4d7..01f0e96935 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogData.html @@ -1,2 +1,2 @@ DialogData | papi-dts
    DialogData: DialogOptions & {
        isDialog: true;
    }

    Data in each tab that is a dialog. Added to DialogOptions in dialog.service-host.ts

    -
    +
    diff --git a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html index 1f7e0c313c..b77a1bbd9e 100644 --- a/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html +++ b/papi-dts/types/_shared_models_dialog_options_model_.DialogOptions.html @@ -6,4 +6,4 @@
  • Optionaltitle?: string | LocalizeKey

    Dialog title to display in the header. If you provide a LocalizeKey, it will be localized before displaying.

    Default depends on the dialog

    -
  • +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html index 5061e3b50c..bdd2d4a7bd 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatPosition.html @@ -4,4 +4,4 @@ window
  • center - center the window in the dock layout
  • -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html index 38b470fe5f..665ac396af 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.FloatSize.html @@ -1,2 +1,2 @@ FloatSize | papi-dts
    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html index cd277ea0d8..80164d6eeb 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.Layout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.Layout.html @@ -1,2 +1,2 @@ Layout | papi-dts

    Information about how a Paranext tab fits into the dock layout

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html index 4298f84201..59591a38b8 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.OnLayoutChangeRCDock.html @@ -7,4 +7,4 @@
  • OptionalwebViewDefinition: WebViewDefinition

    The web view definition if the edit was on a web view; undefined otherwise

  • Returns Promise<void>

    Promise that resolves when finished doing things

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html index 7483dfbb17..9d7b6d9b34 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PanelDirection.html @@ -1 +1 @@ -PanelDirection | papi-dts
    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"
    +PanelDirection | papi-dts
    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html index 18749629b1..03c0ddf37a 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.PapiDockLayout.html @@ -27,4 +27,4 @@
  • updateInfo: WebViewDefinitionUpdateInfo

    Properties to update on the WebView. Any unspecified properties will stay the same

  • Returns boolean

    True if successfully found the WebView to update; false otherwise

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html index a58bbd4d80..14a3ff5ae0 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.SavedTabInfo.html @@ -7,4 +7,4 @@
  • id: string

    Tab ID - a unique identifier that identifies this tab. If this tab is a WebView, this ID will match the WebViewDefinition.id

  • tabType: string

    Type of tab - indicates what kind of built-in tab this info represents

    -
  • +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html index dce0e21980..319501e3db 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabInfo.html @@ -11,4 +11,4 @@
  • tabTitle: string | LocalizeKey

    Text to show (or a localizeKey that will automatically be localized) on the title bar of the tab

  • OptionaltabTooltip?: string

    Text to show when hovering over the title bar of the tab

    -
  • +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html index 3ebca574f7..4a1097723f 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabLoader.html @@ -1,4 +1,4 @@ TabLoader | papi-dts
    TabLoader: ((savedTabInfo: SavedTabInfo) => TabInfo)

    Function that takes a SavedTabInfo and creates a Paranext tab out of it. Each type of tab must provide a TabLoader.

    For now all tab creators must do their own data type verification

    -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html index 9c43875a18..102b53f147 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.TabSaver.html @@ -3,4 +3,4 @@ stripped from TabInfo by saveTabInfoBase before saving (so it is just a SavedTabInfo).

    Type declaration

      • (tabInfo): SavedTabInfo | undefined
      • Parameters

        • tabInfo: TabInfo

          The Paranext tab to save

        Returns SavedTabInfo | undefined

        The saved tab info for Paranext to persist. If undefined, does not save the tab

        -
    +
    diff --git a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html index 574ad15fc6..87e75fe548 100644 --- a/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html +++ b/papi-dts/types/_shared_models_docking_framework_model_.WebViewTabProps.html @@ -1,2 +1,2 @@ WebViewTabProps | papi-dts
    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -
    +
    diff --git a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html index 3d79b22221..c9e5460a68 100644 --- a/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html +++ b/papi-dts/types/_shared_models_elevated_privileges_model_.ElevatedPrivileges.html @@ -1,4 +1,4 @@ ElevatedPrivileges | papi-dts
    ElevatedPrivileges: {
        createProcess: CreateProcess | undefined;
        manageExtensions: ManageExtensions | undefined;
    }

    Object that contains properties with special capabilities for extensions that required them

    Type declaration

    • createProcess: CreateProcess | undefined

      Functions that can be run to start new processes

    • manageExtensions: ManageExtensions | undefined

      Functions that can be run to manage what extensions are running

      -
    +
    diff --git a/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html b/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html index b9079c6355..3b022a40e8 100644 --- a/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html +++ b/papi-dts/types/_shared_models_extension_basic_data_model_.ExtensionBasicData.html @@ -1,3 +1,3 @@ ExtensionBasicData | papi-dts
    ExtensionBasicData: {
        name: string;
    }

    Represents an object that contains the most basic information about an extension

    Type declaration

    • name: string

      Name of an extension

      -
    +
    diff --git a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html index 010248d8ed..7fcd0ca536 100644 --- a/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html +++ b/papi-dts/types/_shared_models_extract_data_provider_data_types_model_.default.html @@ -3,4 +3,4 @@

    Works with generic types IDataProvider, DataProviderInternal, IDisposableDataProvider, and IDataProviderEngine along with the papi-shared-types extensible interfaces DataProviders and DisposableDataProviders

    -

    Type Parameters

    • TDataProvider
    +

    Type Parameters

    • TDataProvider
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html index d31cb29864..5c2bd16e1d 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.DisableExtensionFunction.html @@ -1,4 +1,4 @@ DisableExtensionFunction | papi-dts
    DisableExtensionFunction: ((extensionIdentifier: ExtensionIdentifier) => Promise<void>)

    Stop running an extension that had been previously downloaded and enabled

    Type declaration

      • (extensionIdentifier): Promise<void>
      • Parameters

        Returns Promise<void>

        Promise that resolves when the extension has been enabled, throws if enabling fails

        -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html index 74c717dbac..390c69b7cf 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.EnableExtensionFunction.html @@ -1,4 +1,4 @@ EnableExtensionFunction | papi-dts
    EnableExtensionFunction: ((extensionIdentifier: ExtensionIdentifier) => Promise<void>)

    Start running an extension that had been previously downloaded and disabled

    Type declaration

      • (extensionIdentifier): Promise<void>
      • Parameters

        Returns Promise<void>

        Promise that resolves when the extension has been enabled, throws if enabling fails

        -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html index a69dae009a..40f51ed06e 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ExtensionIdentifier.html @@ -1,2 +1,2 @@ ExtensionIdentifier | papi-dts
    ExtensionIdentifier: {
        extensionName: string;
        extensionVersion: string;
    }

    Represents an extension that can be enabled or disabled

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html index fb693ff918..ec5ca5e09d 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.GetInstalledExtensionsFunction.html @@ -1,2 +1,2 @@ GetInstalledExtensionsFunction | papi-dts
    GetInstalledExtensionsFunction: (() => Promise<InstalledExtensions>)

    Get extension identifiers of all extensions on the system

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html index f3b68cd826..85ce34a8d8 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.HashValues.html @@ -1,2 +1,2 @@ HashValues | papi-dts
    HashValues: Partial<{
        sha256: string;
        sha512: string;
    }>

    Base64 encoded hash values

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html index db1e9b5a4c..4846ac8e42 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstallExtensionFunction.html @@ -6,4 +6,4 @@ validation. For example, if you provide a sha256 hash value and a sha512 hash value, the installer may only use the sha512 hash value for validation.

    Returns Promise<void>

    Promise that resolves when the extension has been installed

    -
    +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html index ca461b176e..12c927ae09 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.InstalledExtensions.html @@ -8,4 +8,4 @@ or removed from the set of enabled extensions.

  • packaged: ExtensionIdentifier[]

    Extensions that are explicitly bundled to be part of the application. They cannot be disabled. At runtime no extensions can be added or removed from the set of packaged extensions.

    -
  • +
    diff --git a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html index 76d35a352d..d0a12fd1fb 100644 --- a/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html +++ b/papi-dts/types/_shared_models_manage_extensions_privilege_model_.ManageExtensions.html @@ -3,4 +3,4 @@
  • enableExtension: EnableExtensionFunction

    Function to start running an extension that had been previously downloaded and disabled

  • getInstalledExtensions: GetInstalledExtensionsFunction

    Function to retrieve details about all installed extensions

  • installExtension: InstallExtensionFunction

    Function to download an extension and enable it

    -
  • +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html index 00d0167bd6..07d5ba87f0 100644 --- a/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.DisposableNetworkObject.html @@ -1,3 +1,3 @@ DisposableNetworkObject | papi-dts
    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

    An object of this type is returned from networkObjectService.set.

    Type Parameters

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html index 381946e09a..2d1c48b215 100644 --- a/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html +++ b/papi-dts/types/_shared_models_network_object_model_.LocalObjectToProxyCreator.html @@ -9,4 +9,4 @@ (probably has to do with that it's a wrapped and layered type). Functions that implement this type should return Partial

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html index 43156edc23..0e687bd014 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObject.html @@ -5,4 +5,4 @@ call that method. This is because we don't want users of network objects to dispose of them. Only the caller of networkObjectService.set should be able to dispose of the network object.

    Type Parameters

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html index 4ecde0c352..14b0b0c41b 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkObjectDetails.html @@ -8,4 +8,4 @@ Data Providers => pdp) should be the same across all process on the network regardless of what programming language they use. For generic network objects, networkObject is appropriate.

    -
    +
    diff --git a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html index a55f1c00fa..77d198facd 100644 --- a/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html +++ b/papi-dts/types/_shared_models_network_object_model_.NetworkableObject.html @@ -1,3 +1,3 @@ NetworkableObject | papi-dts
    NetworkableObject<T>: T & CannotHaveOnDidDispose

    An object of this type is passed into networkObjectService.set.

    Type Parameters

    • T = object

    networkObjectService

    -
    +
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Components.html b/papi-dts/types/_shared_models_openrpc_model_.Components.html index dbf0f346be..2e6e79542b 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Components.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Components.html @@ -1 +1 @@ -Components | papi-dts
    Components: {
        contentDescriptors?: {
            [key: string]: ContentDescriptor;
        };
        errors?: {
            [key: string]: Error;
        };
        examples?: {
            [key: string]: Example;
        };
        links?: {
            [key: string]: Link;
        };
        schemas?: {
            [key: string]: Schema;
        };
        tags?: {
            [key: string]: Tag;
        };
    }
    +Components | papi-dts
    Components: {
        contentDescriptors?: {
            [key: string]: ContentDescriptor;
        };
        errors?: {
            [key: string]: Error;
        };
        examples?: {
            [key: string]: Example;
        };
        links?: {
            [key: string]: Link;
        };
        schemas?: {
            [key: string]: Schema;
        };
        tags?: {
            [key: string]: Tag;
        };
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.ComponentsReference.html b/papi-dts/types/_shared_models_openrpc_model_.ComponentsReference.html index 288f437f48..2018fcbf06 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.ComponentsReference.html +++ b/papi-dts/types/_shared_models_openrpc_model_.ComponentsReference.html @@ -1 +1 @@ -ComponentsReference | papi-dts
    ComponentsReference: `#/components/${string}`
    +ComponentsReference | papi-dts
    ComponentsReference: `#/components/${string}`
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Contact.html b/papi-dts/types/_shared_models_openrpc_model_.Contact.html index 55a8203181..2a53cb7f92 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Contact.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Contact.html @@ -1 +1 @@ -Contact | papi-dts
    Contact: {
        email?: string;
        name?: string;
        url?: string;
    }
    +Contact | papi-dts
    Contact: {
        email?: string;
        name?: string;
        url?: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.ContentDescriptor.html b/papi-dts/types/_shared_models_openrpc_model_.ContentDescriptor.html index ec9a4e169d..e39a6eada5 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.ContentDescriptor.html +++ b/papi-dts/types/_shared_models_openrpc_model_.ContentDescriptor.html @@ -1 +1 @@ -ContentDescriptor | papi-dts
    ContentDescriptor: {
        deprecated?: boolean;
        description?: string;
        name: string;
        required?: boolean;
        schema: Schema;
        summary?: string;
    }
    +ContentDescriptor | papi-dts
    ContentDescriptor: {
        deprecated?: boolean;
        description?: string;
        name: string;
        required?: boolean;
        schema: Schema;
        summary?: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Error.html b/papi-dts/types/_shared_models_openrpc_model_.Error.html index 7f14b581ff..bb4e8449f6 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Error.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Error.html @@ -1 +1 @@ -Error | papi-dts
    Error: {
        code: number;
        data?: any;
        message: string;
    }
    +Error | papi-dts
    Error: {
        code: number;
        data?: any;
        message: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Example.html b/papi-dts/types/_shared_models_openrpc_model_.Example.html index 2d260aa9c3..f9548018a4 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Example.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Example.html @@ -1 +1 @@ -Example | papi-dts
    Example: {
        description?: string;
        name: string;
        summary?: string;
        value: any;
    }
    +Example | papi-dts
    Example: {
        description?: string;
        name: string;
        summary?: string;
        value: any;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.ExamplePairingObject.html b/papi-dts/types/_shared_models_openrpc_model_.ExamplePairingObject.html index 55b3e3c07f..ca3303331b 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.ExamplePairingObject.html +++ b/papi-dts/types/_shared_models_openrpc_model_.ExamplePairingObject.html @@ -1 +1 @@ -ExamplePairingObject | papi-dts
    ExamplePairingObject: {
        description?: string;
        name: string;
        params: (Example | Reference)[];
        result: Example | Reference;
    }
    +ExamplePairingObject | papi-dts
    ExamplePairingObject: {
        description?: string;
        name: string;
        params: (Example | Reference)[];
        result: Example | Reference;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.ExternalDocumentation.html b/papi-dts/types/_shared_models_openrpc_model_.ExternalDocumentation.html index 8412b945a9..cf556eda7f 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.ExternalDocumentation.html +++ b/papi-dts/types/_shared_models_openrpc_model_.ExternalDocumentation.html @@ -1 +1 @@ -ExternalDocumentation | papi-dts
    ExternalDocumentation: {
        description?: string;
        url: string;
    }
    +ExternalDocumentation | papi-dts
    ExternalDocumentation: {
        description?: string;
        url: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Info.html b/papi-dts/types/_shared_models_openrpc_model_.Info.html index d6033b7d5b..f588f38916 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Info.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Info.html @@ -1 +1 @@ -Info | papi-dts
    Info: {
        contact?: Contact;
        description?: string;
        license?: License;
        termsOfService?: string;
        title: string;
        version: string;
    }
    +Info | papi-dts
    Info: {
        contact?: Contact;
        description?: string;
        license?: License;
        termsOfService?: string;
        title: string;
        version: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.License.html b/papi-dts/types/_shared_models_openrpc_model_.License.html index 9f09ae7cbf..a0b6fbcede 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.License.html +++ b/papi-dts/types/_shared_models_openrpc_model_.License.html @@ -1 +1 @@ -License | papi-dts
    License: {
        name: string;
        url?: string;
    }
    +License | papi-dts
    License: {
        name: string;
        url?: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Link.html b/papi-dts/types/_shared_models_openrpc_model_.Link.html index 1225914d92..06493c6a59 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Link.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Link.html @@ -1 +1 @@ -Link | papi-dts
    Link: {
        description?: string;
        method?: string;
        name?: string;
        params?: {
            [key: string]: any;
        };
        server?: "shared/models/openrpc.model".Server;
        summary?: string;
    }
    +Link | papi-dts
    Link: {
        description?: string;
        method?: string;
        name?: string;
        params?: {
            [key: string]: any;
        };
        server?: "shared/models/openrpc.model".Server;
        summary?: string;
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Method.html b/papi-dts/types/_shared_models_openrpc_model_.Method.html index 0942c719e9..f3ae0358a8 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Method.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Method.html @@ -3,4 +3,4 @@
  • Optionalerrors?: (Error | Reference)[]
  • Optionalexamples?: (ExamplePairingObject | Reference)[]
  • OptionalexternalDocs?: ExternalDocumentation
  • Optionallinks?: (Link | Reference)[]
  • name: string

    The canonical name for the method. The name MUST be unique within the methods array.

  • params: (ContentDescriptor | Reference)[]
  • OptionalparamStructure?: "by-name" | "by-position" | "either"

    Format the server expects the params. Defaults to 'either'.

  • result: ContentDescriptor | Reference
  • Optionalservers?: "shared/models/openrpc.model".Server[]
  • Optionalsummary?: string

    A short summary of what the method does.

    -
  • Optionaltags?: (Tag | Reference)[]
  • +
  • Optionaltags?: (Tag | Reference)[]
  • diff --git a/papi-dts/types/_shared_models_openrpc_model_.MethodDocumentationWithoutName.html b/papi-dts/types/_shared_models_openrpc_model_.MethodDocumentationWithoutName.html index 4f1d7b364b..48e82cc0f3 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.MethodDocumentationWithoutName.html +++ b/papi-dts/types/_shared_models_openrpc_model_.MethodDocumentationWithoutName.html @@ -1 +1 @@ -MethodDocumentationWithoutName | papi-dts
    MethodDocumentationWithoutName: Omit<Method, "name">
    +MethodDocumentationWithoutName | papi-dts
    MethodDocumentationWithoutName: Omit<Method, "name">
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.NetworkObjectDocumentation.html b/papi-dts/types/_shared_models_openrpc_model_.NetworkObjectDocumentation.html index 76ad681397..1fa8139482 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.NetworkObjectDocumentation.html +++ b/papi-dts/types/_shared_models_openrpc_model_.NetworkObjectDocumentation.html @@ -1,2 +1,2 @@ NetworkObjectDocumentation | papi-dts
    NetworkObjectDocumentation: {
        components?: Components;
        description?: string;
        methods?: Method[];
        summary?: string;
    }

    Documentation about all methods on a network object

    -
    +
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.OpenRpc.html b/papi-dts/types/_shared_models_openrpc_model_.OpenRpc.html index 118b636fd7..c2cb7eae67 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.OpenRpc.html +++ b/papi-dts/types/_shared_models_openrpc_model_.OpenRpc.html @@ -7,4 +7,4 @@ very good. For example, all the properties of Components are of type any instead of the specific types they should be, and they redefine types for JSON Schema. So we're using our own types here instead.

    -
    +
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Reference.html b/papi-dts/types/_shared_models_openrpc_model_.Reference.html index 9f6018eaa0..a1408d2045 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Reference.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Reference.html @@ -1 +1 @@ -Reference | papi-dts
    +Reference | papi-dts
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Schema.html b/papi-dts/types/_shared_models_openrpc_model_.Schema.html index 2946877a17..056d9c9f03 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Schema.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Schema.html @@ -1 +1 @@ -Schema | papi-dts
    Schema: JSONSchema7
    +Schema | papi-dts
    Schema: JSONSchema7
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Server.html b/papi-dts/types/_shared_models_openrpc_model_.Server.html index e8bff60ee1..91d397d401 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Server.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Server.html @@ -1 +1 @@ -Server | papi-dts
    Server: {
        description?: string;
        name?: string;
        summary?: string;
        url: string;
        variables?: {
            [key: string]: ServerVariable;
        };
    }
    +Server | papi-dts
    Server: {
        description?: string;
        name?: string;
        summary?: string;
        url: string;
        variables?: {
            [key: string]: ServerVariable;
        };
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.ServerVariable.html b/papi-dts/types/_shared_models_openrpc_model_.ServerVariable.html index 6b1d0d9d59..14955f83ef 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.ServerVariable.html +++ b/papi-dts/types/_shared_models_openrpc_model_.ServerVariable.html @@ -1 +1 @@ -ServerVariable | papi-dts
    ServerVariable: {
        default: string;
        description?: string;
        enum?: string[];
    }
    +ServerVariable | papi-dts
    ServerVariable: {
        default: string;
        description?: string;
        enum?: string[];
    }
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.SingleMethodDocumentation.html b/papi-dts/types/_shared_models_openrpc_model_.SingleMethodDocumentation.html index 36164ca536..b70d75e518 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.SingleMethodDocumentation.html +++ b/papi-dts/types/_shared_models_openrpc_model_.SingleMethodDocumentation.html @@ -1,2 +1,2 @@ SingleMethodDocumentation | papi-dts
    SingleMethodDocumentation: {
        components?: Components;
        method: MethodDocumentationWithoutName;
    }

    Documentation about a single method

    -
    +
    diff --git a/papi-dts/types/_shared_models_openrpc_model_.Tag.html b/papi-dts/types/_shared_models_openrpc_model_.Tag.html index 71d33adec0..970be5f699 100644 --- a/papi-dts/types/_shared_models_openrpc_model_.Tag.html +++ b/papi-dts/types/_shared_models_openrpc_model_.Tag.html @@ -1 +1 @@ -Tag | papi-dts
    Tag: {
        description?: string;
        externalDocs?: ExternalDocumentation;
        name: string;
    }
    +Tag | papi-dts
    Tag: {
        description?: string;
        externalDocs?: ExternalDocumentation;
        name: string;
    }
    diff --git a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html index 5604f6de96..de4c5a94f7 100644 --- a/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html +++ b/papi-dts/types/_shared_models_project_data_provider_engine_model_.IProjectDataProviderEngine.html @@ -29,4 +29,4 @@
    class MyPDPE implements IProjectDataProviderEngine<['MyProjectData']> {
    notifyUpdate(updateInstructions?: DataProviderEngineNotifyUpdate<ProjectDataTypes['MyProjectData']>) {}
    ...
    }
    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html index ee2147cff6..24e87814f3 100644 --- a/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html +++ b/papi-dts/types/_shared_models_project_data_provider_factory_interface_.ProjectMetadataFilterOptions.html @@ -1,3 +1,3 @@ ProjectMetadataFilterOptions | papi-dts
    ProjectMetadataFilterOptions: ModifierProject & {
        excludeProjectIds?: string | string[];
        includeProjectIds?: string | string[];
    }

    Type declaration

    • OptionalexcludeProjectIds?: string | string[]

      Project IDs to exclude

    • OptionalincludeProjectIds?: string | string[]

      Project IDs to include

      -
    +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html index d12dbc88fe..7793d3c16f 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.ExtensionDataScope.html @@ -9,4 +9,4 @@

    This is the smallest level of granularity provided by a PDP for accessing extension data. There is no way to get or set just a portion of data identified by a single dataQualifier value.

  • extensionName: string

    Name of an extension as provided in its manifest

    -
  • +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html index b92b6e29b2..90752f6011 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.MandatoryProjectDataTypes.html @@ -54,4 +54,4 @@ so following this interface ensures your PDP will not break if such a requirement is implemented. -
    +
    diff --git a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html index 5451a6fc9f..bc04454048 100644 --- a/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html +++ b/papi-dts/types/_shared_models_project_data_provider_model_.WithProjectDataProviderEngineExtensionDataMethods.html @@ -7,11 +7,11 @@ to this Project Data Provider

    Returns Promise<undefined | string>

    Extension project data in this project for an extension to use in serving its extension project data

    -
  • setExtensionData:function
  • setExtensionData:function
  • +
    diff --git a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html index 954c17b46e..469b319549 100644 --- a/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html +++ b/papi-dts/types/_shared_models_project_lookup_service_model_.ProjectLookupServiceType.html @@ -8,8 +8,8 @@ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/Collator:

    Only strings that differ in base letters or accents and other diacritic marks compare as unequal. Examples: a ≠ b, a ≠ á, a = A.

    -

    Parameters

    Returns boolean

  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function
  • filterProjectsMetadata:function
  • getMetadataForAllProjects:function

    Returns Promise<ProjectMetadata[]>

    ProjectMetadata for all projects stored on the local system

    -
  • getMetadataForProject:function
  • getMetadataForProject:function

    Returns Promise<ProjectMetadata>

    ProjectMetadata for the given project

    -
  • getMinimalMatchPdpFactoryId:function
  • getMinimalMatchPdpFactoryId:function

    Returns undefined | string

    PDP Factory id whose projectInterfaces minimally match the provided projectInterface if at least one PDP Factory was found that supports the projectInterface provided

    -
  • mergeMetadataFilters:function
  • +
  • mergeMetadataFilters:function
  • diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html index 791a387724..9f8df64ea1 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectDataProviderFactoryMetadataInfo.html @@ -1,4 +1,4 @@ ProjectDataProviderFactoryMetadataInfo | papi-dts
    ProjectDataProviderFactoryMetadataInfo: {
        projectInterfaces: ProjectInterfaces[];
    }

    Type declaration

    • projectInterfaces: ProjectInterfaces[]

      Which projectInterfaces (aka standardized sets of methods on a PDP) the Project Data Provider for this project created by this Project Data Provider Factory supports. Indicates what sort of project data should be available on this project from this PDP Factory.

      -
    +
    diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html index 6bc3b6d2f7..53718f2e6a 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadata.html @@ -12,4 +12,4 @@

    The keys of this object are ids of the PDP Factories that provide the metadata, namely the projectInterfaces for this project (meaning this PDPF can provide a Project Data Provider for this project with these projectInterfaces)

    -
    +
    diff --git a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html index 3724314b6d..7014a12392 100644 --- a/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html +++ b/papi-dts/types/_shared_models_project_metadata_model_.ProjectMetadataWithoutFactoryInfo.html @@ -6,4 +6,4 @@
  • projectInterfaces: ProjectInterfaces[]

    All projectInterfaces (aka standardized sets of methods on a PDP) that Project Data Providers for this project support. Indicates what sort of project data should be available on this project.

    -
  • +
    diff --git a/papi-dts/types/_shared_models_rpc_interface_.RegisteredRpcMethodDetails.html b/papi-dts/types/_shared_models_rpc_interface_.RegisteredRpcMethodDetails.html index 25a5929abe..b17d6bb5a1 100644 --- a/papi-dts/types/_shared_models_rpc_interface_.RegisteredRpcMethodDetails.html +++ b/papi-dts/types/_shared_models_rpc_interface_.RegisteredRpcMethodDetails.html @@ -1 +1 @@ -RegisteredRpcMethodDetails | papi-dts
    RegisteredRpcMethodDetails: {
        handler: IRpcHandler;
        methodDocs?: SingleMethodDocumentation;
    }
    +RegisteredRpcMethodDetails | papi-dts
    RegisteredRpcMethodDetails: {
        handler: IRpcHandler;
        methodDocs?: SingleMethodDocumentation;
    }
    diff --git a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html index bc30fd1cbc..cb452f5dc0 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetSavedWebViewDefinition.html @@ -1,4 +1,4 @@ GetSavedWebViewDefinition | papi-dts
    GetSavedWebViewDefinition: (() => SavedWebViewDefinition | undefined)

    Gets the saved properties on this WebView's WebView definition

    @returns saved properties this WebView's WebView definition or undefined if not found for some reason

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html index b3839e3262..e0318ca6ad 100644 --- a/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html +++ b/papi-dts/types/_shared_models_web_view_model_.GetWebViewOptions.html @@ -11,4 +11,4 @@

    Note: setting existingId to undefined counts as providing in this case (providing is tested with 'existingId' in options, not just testing if existingId is truthy). Not providing an existingId at all is the only way to specify we are not looking for an existing webView

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html index b3785c9085..94131b9cfe 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinition.html @@ -1,4 +1,4 @@ SavedWebViewDefinition | papi-dts

    Saved WebView information that does not contain the actual content of the WebView. Saved into layouts. Could have as little as the type and ID. WebView providers load these into actual WebViewDefinitions and verify any existing properties on the WebViews.

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html index 6a6949bc20..a13a5b63b9 100644 --- a/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html +++ b/papi-dts/types/_shared_models_web_view_model_.SavedWebViewDefinitionOmittedKeys.html @@ -1,3 +1,3 @@ SavedWebViewDefinitionOmittedKeys | papi-dts
    SavedWebViewDefinitionOmittedKeys: typeof SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS[number]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html index defdf816ff..6445d2839f 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.UpdateWebViewDefinition.html @@ -7,4 +7,4 @@
    updateWebViewDefinition({ title: `Hello ${name}` });
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html index d8a81576da..25d8f8c078 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewScrollGroupScrRefHook.html @@ -16,4 +16,4 @@
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html index 455799fbdb..5d1049eaae 100644 --- a/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html +++ b/papi-dts/types/_shared_models_web_view_model_.UseWebViewStateHook.html @@ -25,4 +25,4 @@
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html index 954433fe35..dd4375ef7c 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinition.html @@ -1,2 +1,2 @@ WebViewDefinition | papi-dts

    Properties defining a type of WebView created by extensions to show web content

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html index 3ae3fa3cb6..87a4826ccd 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionBase.html @@ -106,4 +106,4 @@ WebView

  • Optionaltooltip?: string

    Tooltip that is shown when hovering over the webview title

  • webViewType: WebViewType

    What type of WebView this is. Unique to all other WebView definitions

    -
  • +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html index a625d5d54f..0412562667 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionHtml.html @@ -1,3 +1,3 @@ WebViewDefinitionHtml | papi-dts
    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html index 23ce96162e..12264dec2f 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionReact.html @@ -1,4 +1,4 @@ WebViewDefinitionReact | papi-dts
    WebViewDefinitionReact: WebViewDefinitionBase & {
        contentType?: React;
        styles?: string;
    }

    WebView representation using React

    Type declaration

    • OptionalcontentType?: React

      Indicates this WebView uses React

    • Optionalstyles?: string

      String of styles to be loaded into the iframe for this WebView

      -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html index 06f3d3c692..860ae86f94 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionURL.html @@ -1,4 +1,4 @@ WebViewDefinitionURL | papi-dts
    WebViewDefinitionURL: WebViewDefinitionBase & {
        contentType: URL;
    }

    WebView representation using a URL.

    Note: you can only use papi-extension: and https: urls

    Type declaration

    • contentType: URL

      Indicates this WebView uses a URL

      -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html index 0f0f95698e..7b6cd71bec 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdatableProperties.html @@ -1,2 +1,2 @@ WebViewDefinitionUpdatableProperties | papi-dts
    WebViewDefinitionUpdatableProperties: Pick<WebViewDefinitionBase, typeof WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS[number]>

    The properties on a WebViewDefinition that may be updated when that webview is already displayed

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html index 41b35de847..ee390c66cd 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewDefinitionUpdateInfo.html @@ -1,3 +1,3 @@ WebViewDefinitionUpdateInfo | papi-dts
    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html index 9e4b2d9ab3..04968073ac 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewId.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewId.html @@ -1,2 +1,2 @@ WebViewId | papi-dts
    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html index bf7773000d..3b517ba0c6 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewProps.html @@ -53,4 +53,4 @@
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
     
    -
    +
    diff --git a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html index 693be78cc9..a63a8a58f5 100644 --- a/papi-dts/types/_shared_models_web_view_model_.WebViewType.html +++ b/papi-dts/types/_shared_models_web_view_model_.WebViewType.html @@ -1,2 +1,2 @@ WebViewType | papi-dts
    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -
    +
    diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index fd472eb756..1a2bcc1945 100644 --- a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html +++ b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html @@ -1,4 +1,4 @@ moduleSummaryComments | papi-dts
    moduleSummaryComments: {}

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -
    +
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html index 5f6df2b4cb..444521410b 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -11,10 +11,10 @@

    Returns Promise<LocalizationData>

    Object whose keys are localizeKeys and values are localized strings

  • setAvailableInterfaceLanguages:function
  • setLocalizedString:function
  • setLocalizedString:function
  • setLocalizedStrings:function
  • setLocalizedStrings:function
  • Type declaration

    Type declaration

    +

    Parameters

    Returns Promise<string>

    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html index 655bdab5eb..4025aff2ba 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationData.html @@ -1 +1 @@ -LocalizationData | papi-dts
    LocalizationData: LanguageStrings
    +LocalizationData | papi-dts
    LocalizationData: LanguageStrings
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html index 7bfe547791..1a01301446 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationDataDataTypes.html @@ -1 +1 @@ -LocalizationDataDataTypes | papi-dts
    LocalizationDataDataTypes: {
        AvailableInterfaceLanguages: DataProviderDataType<undefined, Record<string, LanguageInfo>, never>;
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }
    +LocalizationDataDataTypes | papi-dts
    LocalizationDataDataTypes: {
        AvailableInterfaceLanguages: DataProviderDataType<undefined, Record<string, LanguageInfo>, never>;
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html index 30e335220b..e5f96e3aec 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelector.html @@ -1 +1 @@ -LocalizationSelector | papi-dts
    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }
    +LocalizationSelector | papi-dts
    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }
    diff --git a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html index 32e4a8dd3d..67b1df8aaf 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html +++ b/papi-dts/types/_shared_services_localization_service_model_.LocalizationSelectors.html @@ -1 +1 @@ -LocalizationSelectors | papi-dts
    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }
    +LocalizationSelectors | papi-dts
    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }
    diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html index 1fff090a2f..e0ce9c9e12 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.IMenuDataService.html @@ -2,21 +2,21 @@

    Type declaration

    +
    diff --git a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html index bb6b0955c3..9a2a5e22c9 100644 --- a/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html +++ b/papi-dts/types/_shared_services_menu_data_service_model_.MenuDataDataTypes.html @@ -1 +1 @@ -MenuDataDataTypes | papi-dts
    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }
    +MenuDataDataTypes | papi-dts
    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html index 86c2890184..570e36f5bd 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.AllProjectSettingsValidators.html @@ -1,3 +1,3 @@ AllProjectSettingsValidators | papi-dts
    AllProjectSettingsValidators: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
    }

    Validators for all project settings. Keys are setting keys, values are functions to validate new settings

    -
    +
    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html index ec769531cf..b7c1341f9e 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.ProjectSettingValidator.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    +

    Returns Promise<boolean>

    diff --git a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html index 954019731e..501059f263 100644 --- a/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html +++ b/papi-dts/types/_shared_services_project_settings_service_model_.SimultaneousProjectSettingsChanges.html @@ -1,4 +1,4 @@ SimultaneousProjectSettingsChanges | papi-dts
    SimultaneousProjectSettingsChanges: {
        [ProjectSettingName in ProjectSettingNames]?: {
            currentValue: ProjectSettingTypes[ProjectSettingName];
            newValue: ProjectSettingTypes[ProjectSettingName];
        }
    }

    All project settings changes being set in one batch

    Project settings may be circularly dependent on one another, so multiple project settings may need to be changed at once in some cases

    -
    +
    diff --git a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html index 90c8a37550..b269161b7e 100644 --- a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html +++ b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupScrRef.html @@ -2,4 +2,4 @@ that means this should be synced with the scroll group sharing that number. If this value is an object, that means it is an independent Scripture reference and should not be synced with any scroll group.

    -
    +
    diff --git a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html index 9bf3166530..9bc3622265 100644 --- a/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html +++ b/papi-dts/types/_shared_services_scroll_group_service_model_.ScrollGroupUpdateInfo.html @@ -1,3 +1,3 @@ ScrollGroupUpdateInfo | papi-dts
    ScrollGroupUpdateInfo: {
        scrollGroupId: ScrollGroupId;
        scrRef: ScriptureReference;
    }

    Information about an update to a scroll group. Informs about the new ScriptureReference at a ScrollGroupId

    -
    +
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html index 483802d9c6..b2d0fce81a 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsData.html @@ -1 +1 @@ -AllSettingsData | papi-dts
    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }
    +AllSettingsData | papi-dts
    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html index 284be13cd9..a1825989ec 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html +++ b/papi-dts/types/_shared_services_settings_service_model_.AllSettingsValidators.html @@ -1,2 +1,2 @@ AllSettingsValidators | papi-dts
    AllSettingsValidators: {
        [SettingName in SettingNames]: SettingValidator<SettingName>
    }

    Validators for all settings. Keys are setting keys, values are functions to validate new settings

    -
    +
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html index 0c881cd82a..53fee6e162 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html +++ b/papi-dts/types/_shared_services_settings_service_model_.ISettingsService.html @@ -3,30 +3,30 @@

    Returns Promise<SettingTypes[SettingName]>

    The value of the specified setting, parsed to an object. Returns default setting if setting does not exist

    If no default value is available for the setting.

    -
  • getLocalizedSettingsContributionInfo:function
  • getLocalizedSettingsContributionInfo:function
  • registerValidator:function
  • registerValidator:function
  • reset:function
  • reset:function
  • set:function
  • set:function
  • subscribe:function
  • subscribe:function
  • validateSetting:function
  • validateSetting:function
  • +
  • OptionalallChanges: Partial<SettingTypes>
  • Returns Promise<boolean>

    diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html index 76cb823943..b803a60d5e 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingDataTypes.html @@ -10,4 +10,4 @@
    '': DataProviderDataType<SettingName, SettingTypes[SettingName], SettingTypes[SettingName]>;
     
    -
    +
    diff --git a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html index e4d4f7cf9b..e9d575104c 100644 --- a/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html +++ b/papi-dts/types/_shared_services_settings_service_model_.SettingValidator.html @@ -1,2 +1,2 @@ SettingValidator | papi-dts
    SettingValidator<SettingName>: ((newValue: SettingTypes[SettingName], currentValue: SettingTypes[SettingName], allChanges: Partial<SettingTypes>) => Promise<boolean>)

    Function that validates whether a new setting value should be allowed to be set

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html index f5e29c30f7..586f70a5ce 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.CloseWebViewEvent.html @@ -1,2 +1,2 @@ CloseWebViewEvent | papi-dts
    CloseWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are closed

    -
    +
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html index 967476547a..de5b64c1ef 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.OpenWebViewEvent.html @@ -1,2 +1,2 @@ OpenWebViewEvent | papi-dts
    OpenWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -
    +
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html b/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html index 90929b9389..7d57ff4935 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.UpdateWebViewEvent.html @@ -1,2 +1,2 @@ UpdateWebViewEvent | papi-dts
    UpdateWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are updated

    -
    +
    diff --git a/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html b/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html index b3c3815b6f..4c41dafbc1 100644 --- a/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html +++ b/papi-dts/types/_shared_services_web_view_service_model_.WebViewMessageRequestHandler.html @@ -1,4 +1,4 @@ WebViewMessageRequestHandler | papi-dts
    WebViewMessageRequestHandler: ((webViewNonce: string, message: unknown, targetOrigin?: string) => Promise<void>)

    Type of function to receive messages sent to a web view.

    See web-view-provider.service.ts's postMessageToWebView and web-view.component for information on this type

    -
    +
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html index 43cbc593ea..f49a40b106 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.AllProjectSettingsInfo.html @@ -1,2 +1,2 @@ AllProjectSettingsInfo | papi-dts
    AllProjectSettingsInfo: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingInfo<ProjectSettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -
    +
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html index 28a36227b6..68ea4bab39 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.LocalizedProjectSettingsContributionInfo.html @@ -1 +1 @@ -LocalizedProjectSettingsContributionInfo | papi-dts
    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>
    +LocalizedProjectSettingsContributionInfo | papi-dts
    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>
    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html index 355e20a356..e9db384178 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingInfo.html @@ -1,3 +1,3 @@ ProjectSettingInfo | papi-dts
    ProjectSettingInfo<ProjectSettingName>: ProjectSetting & {
        default: ProjectSettingTypes[ProjectSettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html index 3fe6b2a849..0366039d76 100644 --- a/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_project_settings_document_combiner_.ProjectSettingsContributionInfo.html @@ -1,4 +1,4 @@ ProjectSettingsContributionInfo | papi-dts
    ProjectSettingsContributionInfo: {
        contributions: {
            [extensionName: string]: ProjectSettingsGroup[] | undefined;
        };
        settings: Partial<AllProjectSettingsInfo>;
    }

    Type declaration

    • contributions: {
          [extensionName: string]: ProjectSettingsGroup[] | undefined;
      }

      Map of extension name to that extension's provided settings groups if provided

      • [extensionName: string]: ProjectSettingsGroup[] | undefined
    • settings: Partial<AllProjectSettingsInfo>

      Map of setting name to setting definition. For type specificity and ease of accessing settings since they're a bit hard to find in contributions

      -
    +
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html index 8d3beb353b..a4bd4269ce 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.AllSettingsInfo.html @@ -1,2 +1,2 @@ AllSettingsInfo | papi-dts
    AllSettingsInfo: {
        [SettingName in SettingNames]: SettingInfo<SettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -
    +
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html index d17bfbdfeb..1893d8e135 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.LocalizedSettingsContributionInfo.html @@ -1 +1 @@ -LocalizedSettingsContributionInfo | papi-dts
    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>
    +LocalizedSettingsContributionInfo | papi-dts
    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>
    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html index 6dc51d1594..5369f5e4d8 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingInfo.html @@ -1,3 +1,3 @@ SettingInfo | papi-dts
    SettingInfo<SettingName>: Setting & {
        default: SettingTypes[SettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html index 3bce26852c..fd7a3bbfd9 100644 --- a/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html +++ b/papi-dts/types/_shared_utils_settings_document_combiner_base_.SettingsContributionInfo.html @@ -1,4 +1,4 @@ SettingsContributionInfo | papi-dts
    SettingsContributionInfo: {
        contributions: {
            [extensionName: string]: SettingsGroup[] | undefined;
        };
        settings: Partial<AllSettingsInfo>;
    }

    Type declaration

    • contributions: {
          [extensionName: string]: SettingsGroup[] | undefined;
      }

      Map of extension name to that extension's provided settings groups if provided

      • [extensionName: string]: SettingsGroup[] | undefined
    • settings: Partial<AllSettingsInfo>

      Map of setting name to setting definition. For type specificity and ease of accessing settings since they're a bit hard to find in contributions

      -
    +
    diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index fdf3395043..e72d8e9f42 100644 --- a/papi-dts/types/_shared_utils_util_.RequestType.html +++ b/papi-dts/types/_shared_utils_util_.RequestType.html @@ -1,4 +1,4 @@ RequestType | papi-dts
    RequestType: {
        category: string;
        directive: string;
    }

    Information about a request that tells us what to do with it

    Type declaration

    • category: string

      The general category of request

    • directive: string

      Specific identifier for this type of request

      -
    +
    diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 2582b043d7..586c8ebed9 100644 --- a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html +++ b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html @@ -1,3 +1,3 @@ SerializedRequestType | papi-dts

    Type AliasSerializedRequestType

    SerializedRequestType: `${string}${typeof REQUEST_TYPE_SEPARATOR}${string}`

    String version of a request type that tells us what to do with a request.

    Consists of two strings concatenated by a colon

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index fc95e5982a..d3228b5a53 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    IBaseProjectDataProviderEngine for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index 834e507104..7b13aa055e 100644 --- a/papi-dts/variables/__papi_backend_.DataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.DataProviderEngine.html @@ -2,4 +2,4 @@ data provider engine class extends this class, it doesn't have to specify its own notifyUpdate function in order to use notifyUpdate.

    IDataProviderEngine for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index 929c56b263..7881794fa2 100644 --- a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html +++ b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html @@ -5,4 +5,4 @@ highly recommend extending this class. Please see IProjectDataProviderEngineFactory.getAvailableProjects for more information on the requirements.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 944baa6c78..d61a150462 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    IProjectDataProviderEngine for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.WebViewFactory.html b/papi-dts/variables/__papi_backend_.WebViewFactory.html index ff41fb8221..c7ebc07ef1 100644 --- a/papi-dts/variables/__papi_backend_.WebViewFactory.html +++ b/papi-dts/variables/__papi_backend_.WebViewFactory.html @@ -13,4 +13,4 @@ want to overwrite this class's getWebView because that will eliminate most of the benefits associated with using this class.

    IWebViewProvider for more information on extending this class.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index 98fc97116b..bfca623fe2 100644 --- a/papi-dts/variables/__papi_backend_.commands.html +++ b/papi-dts/variables/__papi_backend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

    VariablecommandsConst

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index 3a0ff06136..d6883c3a71 100644 --- a/papi-dts/variables/__papi_backend_.dataProviders.html +++ b/papi-dts/variables/__papi_backend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

    VariabledataProvidersConst

    dataProviders: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index f93ca71d65..5ba7e245b3 100644 --- a/papi-dts/variables/__papi_backend_.default.html +++ b/papi-dts/variables/__papi_backend_.default.html @@ -89,4 +89,4 @@
  • webViews: WebViewServiceType

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
  • +
    diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index f5d8420e89..02e54be69a 100644 --- a/papi-dts/variables/__papi_backend_.dialogs.html +++ b/papi-dts/variables/__papi_backend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

    VariabledialogsConst

    dialogs: DialogService

    Prompt the user for responses with dialogs

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 9df19be225..20fa67a109 100644 --- a/papi-dts/variables/__papi_backend_.internet.html +++ b/papi-dts/variables/__papi_backend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

    VariableinternetConst

    internet: InternetService

    Service that provides a way to call fetch since the original function is not available

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index 77d15397cb..da89532a8b 100644 --- a/papi-dts/variables/__papi_backend_.localization.html +++ b/papi-dts/variables/__papi_backend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

    VariablelocalizationConst

    localization: ILocalizationService

    Service that allows to get and store localizations

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index f41ab4b323..d096a0f612 100644 --- a/papi-dts/variables/__papi_backend_.logger.html +++ b/papi-dts/variables/__papi_backend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

    VariableloggerConst

    logger: MainLogger & {
        default: MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index 1674616a11..b8fe8ff00d 100644 --- a/papi-dts/variables/__papi_backend_.menuData.html +++ b/papi-dts/variables/__papi_backend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

    VariablemenuDataConst

    Service that allows to get and store menu data

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index 51da18489e..36dde70d4b 100644 --- a/papi-dts/variables/__papi_backend_.network.html +++ b/papi-dts/variables/__papi_backend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

    VariablenetworkConst

    Service that provides a way to send and receive network events

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.networkObjectStatus.html b/papi-dts/variables/__papi_backend_.networkObjectStatus.html index a2352d606b..d02fbfe363 100644 --- a/papi-dts/variables/__papi_backend_.networkObjectStatus.html +++ b/papi-dts/variables/__papi_backend_.networkObjectStatus.html @@ -1,2 +1,2 @@ networkObjectStatus | papi-dts

    VariablenetworkObjectStatusConst

    networkObjectStatus: NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.networkObjects.html b/papi-dts/variables/__papi_backend_.networkObjects.html index 67abffa225..2f65e0f2e2 100644 --- a/papi-dts/variables/__papi_backend_.networkObjects.html +++ b/papi-dts/variables/__papi_backend_.networkObjects.html @@ -18,4 +18,4 @@

    When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index 13f30356ac..b9925aa9d5 100644 --- a/papi-dts/variables/__papi_backend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_backend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

    VariableprojectDataProvidersConst

    Service that registers and gets project data providers

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index aa933c9540..e1868d19e7 100644 --- a/papi-dts/variables/__papi_backend_.projectLookup.html +++ b/papi-dts/variables/__papi_backend_.projectLookup.html @@ -2,4 +2,4 @@

    Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index ab0df7b6a7..9333863e0a 100644 --- a/papi-dts/variables/__papi_backend_.projectSettings.html +++ b/papi-dts/variables/__papi_backend_.projectSettings.html @@ -1,2 +1,2 @@ projectSettings | papi-dts

    VariableprojectSettingsConst

    projectSettings: IProjectSettingsService

    Provides utility functions that project data providers should call when handling project settings

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.scrollGroups.html b/papi-dts/variables/__papi_backend_.scrollGroups.html index 54deb1bf0b..18d6c3122d 100644 --- a/papi-dts/variables/__papi_backend_.scrollGroups.html +++ b/papi-dts/variables/__papi_backend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

    VariablescrollGroupsConst

    scrollGroups: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index 054443c4d4..70800430de 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts
    +settings | papi-dts
    diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 39069b3907..3b88efe996 100644 --- a/papi-dts/variables/__papi_backend_.storage.html +++ b/papi-dts/variables/__papi_backend_.storage.html @@ -1,4 +1,4 @@ storage | papi-dts

    VariablestorageConst

    This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index 86cc89ba65..8d1a607862 100644 --- a/papi-dts/variables/__papi_backend_.webViewProviders.html +++ b/papi-dts/variables/__papi_backend_.webViewProviders.html @@ -1,3 +1,3 @@ webViewProviders | papi-dts

    VariablewebViewProvidersConst

    webViewProviders: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -
    +
    diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 209e083bda..1ef05379d1 100644 --- a/papi-dts/variables/__papi_backend_.webViews.html +++ b/papi-dts/variables/__papi_backend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

    VariablewebViewsConst

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    +
    diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index 3e43186468..7fcbb3d90d 100644 --- a/papi-dts/variables/__papi_core_.default.html +++ b/papi-dts/variables/__papi_core_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    VariabledefaultConst

    default: {}

    Exporting empty object so people don't have to put 'type' in their import statements

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index c4a110ec14..1c40bb2832 100644 --- a/papi-dts/variables/__papi_frontend_.WebSocket.html +++ b/papi-dts/variables/__papi_frontend_.WebSocket.html @@ -2,4 +2,4 @@ better control over internet access. It is isomorphic with the standard WebSocket, so it should act as a drop-in replacement.

    Note that the Node WebSocket implementation is different and not wrapped here.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index 9b2fa4a9d8..156b34ad4b 100644 --- a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html +++ b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html @@ -2,4 +2,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

    Note that Node doesn't have a native implementation, so this is only for the renderer.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 05065f89c2..4dfded6d5f 100644 --- a/papi-dts/variables/__papi_frontend_.commands.html +++ b/papi-dts/variables/__papi_frontend_.commands.html @@ -1,4 +1,4 @@ commands | papi-dts

    VariablecommandsConst

    The command service allows you to exchange messages with other components in the platform. You can register a command that other services and extensions can send you. You can send commands to other services and extensions that have registered commands.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index eb82f3427b..fed5cca30c 100644 --- a/papi-dts/variables/__papi_frontend_.dataProviders.html +++ b/papi-dts/variables/__papi_frontend_.dataProviders.html @@ -1,2 +1,2 @@ dataProviders | papi-dts

    VariabledataProvidersConst

    dataProviders: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index 2c64d29d8e..e07127c208 100644 --- a/papi-dts/variables/__papi_frontend_.default.html +++ b/papi-dts/variables/__papi_frontend_.default.html @@ -27,4 +27,4 @@ provide better control over internet access. It is isomorphic with the standard XMLHttpRequest, so it should act as a drop-in replacement.

    Note that Node doesn't have a native implementation, so this is only for the renderer.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index e11ca9baf8..23ce6dcdac 100644 --- a/papi-dts/variables/__papi_frontend_.dialogs.html +++ b/papi-dts/variables/__papi_frontend_.dialogs.html @@ -1,2 +1,2 @@ dialogs | papi-dts

    VariabledialogsConst

    dialogs: DialogService

    Prompt the user for responses with dialogs

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index b99ec3f588..4fc598c843 100644 --- a/papi-dts/variables/__papi_frontend_.internet.html +++ b/papi-dts/variables/__papi_frontend_.internet.html @@ -1,2 +1,2 @@ internet | papi-dts

    VariableinternetConst

    internet: InternetService

    Service that provides a way to call fetch since the original function is not available

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index ce2aa7661e..55b893a7a6 100644 --- a/papi-dts/variables/__papi_frontend_.localization.html +++ b/papi-dts/variables/__papi_frontend_.localization.html @@ -1,2 +1,2 @@ localization | papi-dts

    VariablelocalizationConst

    localization: ILocalizationService

    Service that allows to get and store localizations

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 78bcde1e88..1b527202d0 100644 --- a/papi-dts/variables/__papi_frontend_.logger.html +++ b/papi-dts/variables/__papi_frontend_.logger.html @@ -1,2 +1,2 @@ logger | papi-dts

    VariableloggerConst

    logger: MainLogger & {
        default: MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index 2d65fea220..4e1c520427 100644 --- a/papi-dts/variables/__papi_frontend_.menuData.html +++ b/papi-dts/variables/__papi_frontend_.menuData.html @@ -1,2 +1,2 @@ menuData | papi-dts

    VariablemenuDataConst

    Service that allows to get and store menu data

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index 1a9d368f66..22a2908972 100644 --- a/papi-dts/variables/__papi_frontend_.network.html +++ b/papi-dts/variables/__papi_frontend_.network.html @@ -1,2 +1,2 @@ network | papi-dts

    VariablenetworkConst

    Service that provides a way to send and receive network events

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 22ae6fc412..a6ef8e884f 100644 --- a/papi-dts/variables/__papi_frontend_.projectDataProviders.html +++ b/papi-dts/variables/__papi_frontend_.projectDataProviders.html @@ -1,2 +1,2 @@ projectDataProviders | papi-dts

    VariableprojectDataProvidersConst

    Service that registers and gets project data providers

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index b24bf433a8..c0952688ba 100644 --- a/papi-dts/variables/__papi_frontend_.projectLookup.html +++ b/papi-dts/variables/__papi_frontend_.projectLookup.html @@ -2,4 +2,4 @@

    Note: this service runs locally everywhere in the TypeScript processes. It is also exposed on the PAPI websocket. Note these functions are all asynchronous on the PAPI websocket regardless of if their types are synchronous locally.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 5bfeb76933..f40509227c 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

    React hooks that enable interacting with the papi in React components more easily.

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.scrollGroups.html b/papi-dts/variables/__papi_frontend_.scrollGroups.html index 6e8998e82c..c6e688fa49 100644 --- a/papi-dts/variables/__papi_frontend_.scrollGroups.html +++ b/papi-dts/variables/__papi_frontend_.scrollGroups.html @@ -1,2 +1,2 @@ scrollGroups | papi-dts

    VariablescrollGroupsConst

    scrollGroups: IScrollGroupService

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    +
    diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index 3419cf0b31..a7a893de53 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts
    +settings | papi-dts
    diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index d889a92d0e..ba2d95ee57 100644 --- a/papi-dts/variables/__papi_frontend_.webViews.html +++ b/papi-dts/variables/__papi_frontend_.webViews.html @@ -1,4 +1,4 @@ webViews | papi-dts

    VariablewebViewsConst

    Service exposing various functions related to using webViews

    WebViews are iframes in the Platform.Bible UI into which extensions load frontend code, either HTML or React components.

    -
    +
    diff --git a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html index f35555250c..dabc9fb60a 100644 --- a/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html +++ b/papi-dts/variables/_extension_host_services_extension_storage_service_.default.html @@ -1,4 +1,4 @@ default | papi-dts

    This service provides extensions in the extension host the ability to read/write data based on the extension identity and current user (as identified by the OS). This service will not work within the renderer.

    -
    +
    diff --git a/papi-dts/variables/_node_services_execution_token_service_.default.html b/papi-dts/variables/_node_services_execution_token_service_.default.html index ec948e7ba0..098bc86a8a 100644 --- a/papi-dts/variables/_node_services_execution_token_service_.default.html +++ b/papi-dts/variables/_node_services_execution_token_service_.default.html @@ -1 +1 @@ -default | papi-dts
    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }
    +default | papi-dts
    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }
    diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index d137f2a879..30562c2f54 100644 --- a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html @@ -1 +1 @@ -FILE_PROTOCOL | papi-dts

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'
    +FILE_PROTOCOL | papi-dts

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'
    diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index 3b2e9e3a6b..e725ce72a5 100644 --- a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html +++ b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html @@ -1 +1 @@ -RESOURCES_PROTOCOL | papi-dts

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'
    +RESOURCES_PROTOCOL | papi-dts

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html index 23106b6631..90a2773111 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_base_data_.default.html @@ -5,4 +5,4 @@ we would not be able to use the default loadDialog because it would be using a static reference to a nonexistent Component. Instead of inheriting this as a class, any dialog definition can spread this { ...DIALOG_BASE }

    -
    +
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html index 2b78c04df4..8504af28ce 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_BOOKS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_BOOKS_DIALOG_TYPE | papi-dts
    SELECT_BOOKS_DIALOG_TYPE: "platform.selectBooks" = 'platform.selectBooks'

    The tabType for the select books dialog in select-books.dialog.tsx

    -
    +
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html index 2aa8685351..3edaaa1157 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE | papi-dts
    SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

    The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

    -
    +
    diff --git a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html index 5a7cf86d4f..1e81bb8ce9 100644 --- a/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html +++ b/papi-dts/variables/_renderer_components_dialogs_dialog_definition_model_.SELECT_PROJECT_DIALOG_TYPE.html @@ -1,2 +1,2 @@ SELECT_PROJECT_DIALOG_TYPE | papi-dts
    SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

    The tabType for the select project dialog in select-project.dialog.tsx

    -
    +
    diff --git a/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html b/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html index e0681dacaa..63d5c5196d 100644 --- a/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html +++ b/papi-dts/variables/_renderer_services_scroll_group_service_host_.availableScrollGroupIds.html @@ -1,4 +1,4 @@ availableScrollGroupIds | papi-dts
    availableScrollGroupIds: (number | undefined)[]

    All Scroll Group IDs that are intended to be shown in scroll group selectors. This is a placeholder and will be refactored significantly in https://github.com/paranext/paranext-core/issues/788

    -
    +
    diff --git a/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html b/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html index e30e97fce2..735fae768c 100644 --- a/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html +++ b/papi-dts/variables/_shared_data_platform_data_.DEV_MODE_RENDERER_INDICATOR.html @@ -1,2 +1,2 @@ DEV_MODE_RENDERER_INDICATOR | papi-dts
    DEV_MODE_RENDERER_INDICATOR: "?noisyDevMode" = '?noisyDevMode'

    Query string passed to the renderer when starting if it should enable noisy dev mode

    -
    +
    diff --git a/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html b/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html index 533846a5e1..e7093159a0 100644 --- a/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html +++ b/papi-dts/variables/_shared_data_platform_data_.PLATFORM_NAMESPACE.html @@ -1,3 +1,3 @@ PLATFORM_NAMESPACE | papi-dts
    PLATFORM_NAMESPACE: "platform" = 'platform'

    Namespace to use for features like commands, settings, etc. on the PAPI that are provided by Platform.Bible core

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html b/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html index 2895490b77..b771c8d3a6 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html +++ b/papi-dts/variables/_shared_data_rpc_model_.CATEGORY_COMMAND.html @@ -1,2 +1,2 @@ CATEGORY_COMMAND | papi-dts
    CATEGORY_COMMAND: "command" = 'command'

    Prefix on requests that indicates that the request is a command

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html index 34788a3e6f..50c9d0bc9a 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html +++ b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html @@ -1,3 +1,3 @@ GET_METHODS | papi-dts
    GET_METHODS: "rpc.discover" = 'rpc.discover'

    Get all methods that are currently registered on the network. Required to be 'rpc.discover' by the OpenRPC specification.

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html b/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html index 9fd129a685..761c05138f 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html +++ b/papi-dts/variables/_shared_data_rpc_model_.REGISTER_METHOD.html @@ -1,3 +1,3 @@ REGISTER_METHOD | papi-dts
    REGISTER_METHOD: "network:registerMethod" = 'network:registerMethod'

    Register a method on the network so that requests of the given type are routed to your request handler.

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html b/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html index 6194105850..d82c458078 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html +++ b/papi-dts/variables/_shared_data_rpc_model_.UNREGISTER_METHOD.html @@ -1,3 +1,3 @@ UNREGISTER_METHOD | papi-dts
    UNREGISTER_METHOD: "network:unregisterMethod" = 'network:unregisterMethod'

    Unregister a method on the network so that requests of the given type are no longer routed to your request handler.

    -
    +
    diff --git a/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html b/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html index 86c950ef32..977f04f695 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html +++ b/papi-dts/variables/_shared_data_rpc_model_.WEBSOCKET_PORT.html @@ -1,2 +1,2 @@ WEBSOCKET_PORT | papi-dts
    WEBSOCKET_PORT = 8876

    Port to use for the WebSocket

    -
    +
    diff --git a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html index aac04e7d37..c635c9f089 100644 --- a/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_dialog_options_model_.DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS.html @@ -1,2 +1,2 @@ DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS | papi-dts
    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS: readonly ["title", "prompt"]

    Keys of properties on DialogOptions that should be localized if they are LocalizeKeys

    -
    +
    diff --git a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html index f3dec79b72..c4906c5823 100644 --- a/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_models_network_object_status_service_model_.networkObjectStatusServiceNetworkObjectName.html @@ -1 +1 @@ -networkObjectStatusServiceNetworkObjectName | papi-dts
    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
    +networkObjectStatusServiceNetworkObjectName | papi-dts
    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'
    diff --git a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html index 90a719ff00..7c0e17f827 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_factory_interface_.PDP_FACTORY_OBJECT_TYPE.html @@ -1 +1 @@ -PDP_FACTORY_OBJECT_TYPE | papi-dts
    PDP_FACTORY_OBJECT_TYPE: string
    +PDP_FACTORY_OBJECT_TYPE | papi-dts
    PDP_FACTORY_OBJECT_TYPE: string
    diff --git a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html index f5ef9343f3..a1b7cf3ae7 100644 --- a/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html +++ b/papi-dts/variables/_shared_models_project_data_provider_model_.PROJECT_INTERFACE_PLATFORM_BASE.html @@ -1,3 +1,3 @@ PROJECT_INTERFACE_PLATFORM_BASE | papi-dts
    PROJECT_INTERFACE_PLATFORM_BASE: "platform.base" = 'platform.base'

    The name of the projectInterface representing the essential methods every Base Project Data Provider must implement

    -
    +
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html index dcff207447..87167be489 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
    +NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html index 5d54f79322..d798382399 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.projectLookupServiceBase.html @@ -1,2 +1,2 @@ projectLookupServiceBase | papi-dts
    projectLookupServiceBase: ProjectLookupServiceType

    Local object of functions to run locally on each process as part of the project lookup service

    -
    +
    diff --git a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html index 76cea40e97..de5b71d8e2 100644 --- a/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html +++ b/papi-dts/variables/_shared_models_project_lookup_service_model_.testingProjectLookupService.html @@ -1,2 +1,2 @@ testingProjectLookupService | papi-dts
    testingProjectLookupService: {
        compareProjectDataProviderFactoryMetadataInfoMinimalMatch: typeof compareProjectDataProviderFactoryMetadataInfoMinimalMatch;
        internalGetMetadata: typeof internalGetMetadata;
        LOAD_TIME_GRACE_PERIOD_MS: number;
        transformGetMetadataForProjectParametersToFilter: typeof transformGetMetadataForProjectParametersToFilter;
    }

    This is an internal-only export for testing purposes and should not be used in development

    -
    +
    diff --git a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html index f6d67ea6db..4df504f93f 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS.html @@ -1,3 +1,3 @@ SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS | papi-dts

    VariableSAVED_WEBVIEW_DEFINITION_OMITTED_KEYSConst

    SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS: readonly ["content", "styles", "allowScripts", "allowSameOrigin", "allowedFrameSources", "allowPopups"]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -
    +
    diff --git a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html index 4d1475d988..37aa6a92c6 100644 --- a/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html +++ b/papi-dts/variables/_shared_models_web_view_model_.WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS.html @@ -1,3 +1,3 @@ WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS | papi-dts

    VariableWEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYSConst

    WEBVIEW_DEFINITION_UPDATABLE_PROPERTY_KEYS: readonly ["iconUrl", "title", "tooltip", "projectId", "scrollGroupScrRef"]

    The keys of properties on a WebViewDefinition that may be updated when that webview is already displayed

    -
    +
    diff --git a/papi-dts/variables/_shared_services_data_provider_service_.default.html b/papi-dts/variables/_shared_services_data_provider_service_.default.html index 158648f931..bdd7f2f2c6 100644 --- a/papi-dts/variables/_shared_services_data_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_data_provider_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Service that allows extensions to send and receive data to/from other extensions

    -
    +
    diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 2326aed02d..27d337f06b 100644 --- a/papi-dts/variables/_shared_services_dialog_service_.default.html +++ b/papi-dts/variables/_shared_services_dialog_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html index d5ed7bc2bf..ff4b670e39 100644 --- a/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html +++ b/papi-dts/variables/_shared_services_dialog_service_model_.CATEGORY_DIALOG.html @@ -1,2 +1,2 @@ CATEGORY_DIALOG | papi-dts
    CATEGORY_DIALOG: "dialog" = 'dialog'

    Prefix on requests that indicates that the request is related to dialog operations

    -
    +
    diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index e51fc9fb02..70d51b6f25 100644 --- a/papi-dts/variables/_shared_services_internet_service_.default.html +++ b/papi-dts/variables/_shared_services_internet_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Service that provides a way to call fetch since the original function is not available

    -
    +
    diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index b87a8182f2..bc863083e1 100644 --- a/papi-dts/variables/_shared_services_localization_service_.default.html +++ b/papi-dts/variables/_shared_services_localization_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html index 9d125086fb..afc112f78b 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceObjectToProxy.html @@ -1,3 +1,3 @@ localizationServiceObjectToProxy | papi-dts
    localizationServiceObjectToProxy: Readonly<{
        dataProviderName: "platform.localizationDataServiceDataProvider";
    }>

    Type declaration

    • dataProviderName: "platform.localizationDataServiceDataProvider"

      This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

      -
    +
    diff --git a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html index b79843f6a5..d26c4112a0 100644 --- a/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html +++ b/papi-dts/variables/_shared_services_localization_service_model_.localizationServiceProviderName.html @@ -1,3 +1,3 @@ localizationServiceProviderName | papi-dts
    localizationServiceProviderName: "platform.localizationDataServiceDataProvider" = 'platform.localizationDataServiceDataProvider'

    This name is used to register the localization data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -
    +
    diff --git a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html index ee7152fb73..b3cac5fcd2 100644 --- a/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html +++ b/papi-dts/variables/_shared_services_logger_service_.WARN_TAG.html @@ -1 +1 @@ -WARN_TAG | papi-dts
    WARN_TAG: "<WARN>" = '<WARN>'
    +WARN_TAG | papi-dts
    WARN_TAG: "<WARN>" = '<WARN>'
    diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index a6c8f89274..6dbb2975a8 100644 --- a/papi-dts/variables/_shared_services_logger_service_.default.html +++ b/papi-dts/variables/_shared_services_logger_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts
    default: log.MainLogger & {
        default: log.MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -
    +
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_.default.html b/papi-dts/variables/_shared_services_menu_data_service_.default.html index 140640bd6c..29e5d4674c 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_.default.html +++ b/papi-dts/variables/_shared_services_menu_data_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html index 8830468fd7..98a95bd45c 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceObjectToProxy.html @@ -1,3 +1,3 @@ menuDataServiceObjectToProxy | papi-dts
    menuDataServiceObjectToProxy: Readonly<{
        dataProviderName: "platform.menuDataServiceDataProvider";
    }>

    Type declaration

    • dataProviderName: "platform.menuDataServiceDataProvider"

      This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

      -
    +
    diff --git a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html index 16636c5b49..70f9ee500c 100644 --- a/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html +++ b/papi-dts/variables/_shared_services_menu_data_service_model_.menuDataServiceProviderName.html @@ -1,3 +1,3 @@ menuDataServiceProviderName | papi-dts
    menuDataServiceProviderName: "platform.menuDataServiceDataProvider" = 'platform.menuDataServiceDataProvider'

    This name is used to register the menu data data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_object_service_.default.html b/papi-dts/variables/_shared_services_network_object_service_.default.html index 93ca072869..5fd948fc17 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_service_.default.html @@ -18,4 +18,4 @@

    When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html index d588a50f22..1f1b756615 100644 --- a/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html +++ b/papi-dts/variables/_shared_services_network_object_service_.minimalNetworkObjectService-1.html @@ -18,4 +18,4 @@

    When an object is disposed by calling dispose, all functions registered with the onDidDispose event handler will be called. After an object is disposed, calls to its functions will no longer be proxied to the original object.

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_object_status_service_.default.html b/papi-dts/variables/_shared_services_network_object_status_service_.default.html index 5aa9b31f2e..73f183946b 100644 --- a/papi-dts/variables/_shared_services_network_object_status_service_.default.html +++ b/papi-dts/variables/_shared_services_network_object_status_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Provides functions related to the set of available network objects

    -
    +
    diff --git a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html index 0d540bdb51..6ecbd10158 100644 --- a/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html +++ b/papi-dts/variables/_shared_services_network_service_.papiNetworkService-1.html @@ -1,2 +1,2 @@ papiNetworkService | papi-dts
    papiNetworkService: PapiNetworkService

    Service that provides a way to send and receive network events

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html index b6b8d0b075..3fd30ab569 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiBackendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiBackendProjectDataProviderService | papi-dts
    papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

    Service that registers and gets project data providers

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html index 46ee75f299..2336743c1e 100644 --- a/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html +++ b/papi-dts/variables/_shared_services_project_data_provider_service_.papiFrontendProjectDataProviderService-1.html @@ -1,2 +1,2 @@ papiFrontendProjectDataProviderService | papi-dts
    papiFrontendProjectDataProviderService: {
        get: typeof get;
    }

    Service that gets project data providers

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_lookup_service_.default.html b/papi-dts/variables/_shared_services_project_lookup_service_.default.html index c500bb32ca..d01ecf513b 100644 --- a/papi-dts/variables/_shared_services_project_lookup_service_.default.html +++ b/papi-dts/variables/_shared_services_project_lookup_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_.default.html b/papi-dts/variables/_shared_services_project_settings_service_.default.html index a73a0c642c..4156143a7f 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_project_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html index bdf5902482..178f03f511 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR | papi-dts
    CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

    Name prefix for registered commands that call project settings validators

    -
    +
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html index 9addbc4ef0..e74d230dcf 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceNetworkObjectName.html @@ -1 +1 @@ -projectSettingsServiceNetworkObjectName | papi-dts
    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'
    +projectSettingsServiceNetworkObjectName | papi-dts
    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'
    diff --git a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html index 330db431f0..46ac25d192 100644 --- a/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_project_settings_service_model_.projectSettingsServiceObjectToProxy.html @@ -2,4 +2,4 @@
    +
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_.default.html b/papi-dts/variables/_shared_services_scroll_group_service_.default.html index 8a44aef2b3..ecfdc1ebb5 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_.default.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_.default.html @@ -1,2 +1,2 @@ default | papi-dts

    Provides functions related to scroll groups and Scripture references at those scroll groups

    -
    +
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html b/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html index fadb57c59c..6247bac065 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_model_.EVENT_NAME_ON_DID_UPDATE_SCR_REF.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_UPDATE_SCR_REF | papi-dts
    EVENT_NAME_ON_DID_UPDATE_SCR_REF: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -
    +
    diff --git a/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html b/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html index fb01a7b68a..1592761266 100644 --- a/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html +++ b/papi-dts/variables/_shared_services_scroll_group_service_model_.NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'
    +NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'
    diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index 2b793d3875..81e09010dc 100644 --- a/papi-dts/variables/_shared_services_settings_service_.default.html +++ b/papi-dts/variables/_shared_services_settings_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html index 5846396dfb..c075b1689a 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.CATEGORY_EXTENSION_SETTING_VALIDATOR.html @@ -1,2 +1,2 @@ CATEGORY_EXTENSION_SETTING_VALIDATOR | papi-dts
    CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

    Name prefix for registered commands that call settings validators

    -
    +
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html index bb4f8b4359..59960cb7ea 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceDataProviderName.html @@ -1,3 +1,3 @@ settingsServiceDataProviderName | papi-dts
    settingsServiceDataProviderName: "platform.settingsServiceDataProvider" = 'platform.settingsServiceDataProvider'

    This name is used to register the settings service data provider on the papi. You can use this name to find the data provider when accessing it using the useData hook

    -
    +
    diff --git a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html index c6b00e8bd8..a1ee74f1c1 100644 --- a/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html +++ b/papi-dts/variables/_shared_services_settings_service_model_.settingsServiceObjectToProxy.html @@ -4,4 +4,4 @@
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html index a4333f0ec8..c3e3f0e786 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html index 8338272471..ccd1b29613 100644 --- a/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html +++ b/papi-dts/variables/_shared_services_web_view_provider_service_.papiWebViewProviderService-1.html @@ -1,3 +1,3 @@ papiWebViewProviderService | papi-dts
    papiWebViewProviderService: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_.default.html b/papi-dts/variables/_shared_services_web_view_service_.default.html index 47764510ed..af4d843195 100644 --- a/papi-dts/variables/_shared_services_web_view_service_.default.html +++ b/papi-dts/variables/_shared_services_web_view_service_.default.html @@ -1 +1 @@ -default | papi-dts
    +default | papi-dts
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html index 22a5d22b2e..07b418e6c8 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_ADD_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_ADD_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

    13 November 2024. Renamed to EVENT_NAME_ON_DID_OPEN_WEB_VIEW

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html index 7a4c63698f..c35636af56 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_CLOSE_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_CLOSE_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_CLOSE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are closed

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html index 00be87a3c6..a80d89bb94 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_OPEN_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_OPEN_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_OPEN_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are created

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html index d95dd1c6b9..df11d4e6c1 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.EVENT_NAME_ON_DID_UPDATE_WEB_VIEW.html @@ -1,2 +1,2 @@ EVENT_NAME_ON_DID_UPDATE_WEB_VIEW | papi-dts
    EVENT_NAME_ON_DID_UPDATE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -
    +
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html index 48b4e71e4d..521011afc9 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE.html @@ -1 +1 @@ -NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'
    +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts
    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'
    diff --git a/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html b/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html index 0cc98a08cb..e76be0843c 100644 --- a/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html +++ b/papi-dts/variables/_shared_services_web_view_service_model_.WEB_VIEW_CONTROLLER_OBJECT_TYPE.html @@ -1,2 +1,2 @@ WEB_VIEW_CONTROLLER_OBJECT_TYPE | papi-dts
    WEB_VIEW_CONTROLLER_OBJECT_TYPE: "webViewController" = 'webViewController'

    Network object type for web view controllers

    -
    +
    diff --git a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html index d77b06cbd1..2e0f15bb78 100644 --- a/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html +++ b/papi-dts/variables/_shared_utils_util_.MODULE_SIMILAR_APIS.html @@ -1,3 +1,3 @@ MODULE_SIMILAR_APIS | papi-dts

    VariableMODULE_SIMILAR_APISConst

    MODULE_SIMILAR_APIS: Readonly<{
        [moduleName: string]: string | {
            [process in ProcessType | "default"]?: string
        } | undefined;
    }>

    Modules that someone might try to require in their extensions that we have similar apis for. When an extension requires these modules, an error throws that lets them know about our similar api.

    -
    +
    diff --git a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html index dfa972ddc6..3a589ad97c 100644 --- a/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html +++ b/papi-dts/variables/_shared_utils_util_.REQUEST_TYPE_SEPARATOR.html @@ -1,2 +1,2 @@ REQUEST_TYPE_SEPARATOR | papi-dts

    VariableREQUEST_TYPE_SEPARATORConst

    REQUEST_TYPE_SEPARATOR: ":" = ':'

    Separator between parts of a serialized request

    -
    +
    diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index f8bc08091c..c30c955e44 100644 --- a/papi-dts/variables/isNoisyDevModeEnabled.html +++ b/papi-dts/variables/isNoisyDevModeEnabled.html @@ -1,2 +1,2 @@ isNoisyDevModeEnabled | papi-dts

    VariableisNoisyDevModeEnabled

    isNoisyDevModeEnabled: boolean

    Indicates whether test code meant just for developers to see should be run

    -
    +
    diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 4be405870c..5ce05faf0b 100644 --- a/papi-dts/variables/isPackaged.html +++ b/papi-dts/variables/isPackaged.html @@ -1,2 +1,2 @@ isPackaged | papi-dts

    VariableisPackaged

    isPackaged: boolean

    Whether this process is packaged or running from sources

    -
    +
    diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index ff9777e7f2..c62c616688 100644 --- a/papi-dts/variables/logLevel.html +++ b/papi-dts/variables/logLevel.html @@ -1,2 +1,2 @@ logLevel | papi-dts

    VariablelogLevel

    logLevel: LogLevel

    How much logging should be recorded. Defaults to 'debug' if not packaged, 'info' if packaged

    -
    +
    diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 74fb646418..895ed1d737 100644 --- a/papi-dts/variables/processType.html +++ b/papi-dts/variables/processType.html @@ -1,2 +1,2 @@ processType | papi-dts

    VariableprocessType

    processType: ProcessType

    Type of process this is. Helps with running specific code based on which process you're in

    -
    +
    diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 51b5bd5b24..56fe47a47a 100644 --- a/papi-dts/variables/resourcesPath.html +++ b/papi-dts/variables/resourcesPath.html @@ -1,3 +1,3 @@ resourcesPath | papi-dts

    VariableresourcesPath

    resourcesPath: string

    Path to the app's resources directory. This is a string representation of the resources uri on frontend

    -
    +
    diff --git a/papi-dts/variables/webViewId.html b/papi-dts/variables/webViewId.html index 28d0864413..ee2499d962 100644 --- a/papi-dts/variables/webViewId.html +++ b/papi-dts/variables/webViewId.html @@ -1,2 +1,2 @@ webViewId | papi-dts

    VariablewebViewId

    webViewId: WebViewId

    The id of the current web view. Only used in WebView iframes.

    -
    +
    diff --git a/platform-bible-react/assets/search.js b/platform-bible-react/assets/search.js index 395d060878..4581573387 100644 --- a/platform-bible-react/assets/search.js +++ b/platform-bible-react/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA819bZPbNrL1f1G+zs6qW+/+tnHsjWsdJ+Vx8tQtV8qlkTgzvNaIcynKjjeV/34LICk1GgdiU5pbz36KMwQOmsBBA+jToP4clMXX3eDFxz8Hn/PtevBiOr4abJeP2eDF4Pui+PzyYflUZeXLYluVxWZwNdiXm8GLwd1+u6ryYrv7e1zo+qF6dCVXm+Vul+0GLwaDv64S8DfZJltVRZkAbh+fhBzxEfLnn//16ebV21cvP/z8/tPNh/dv3v3z079e/dfNAf/LssyXt5ts9/dk2ZONzYH5ebH9qVhnhzay7f5R2t88P4lL0wPwy1/fv3/17sMnZ6AJ8ztVQzRwNXhaltm2gvbi1n/8+eebVx7qxth6WKN/6zxczGjCkBhvi9Vyk/87W99UZb693x1Mqr49ZSFJdFErD39YVssPjhOAhIdnJ8H0C7wsNvvH7Q/ZnbL28PdeaO+Lr25mZdtKv7140gvxpiirH/KyHgyFGTzrher7KWFp8Mw6MG+2X7JtVZTfwMAcnlldw5t3v7169+Hn9//V4RZguV79cDCtg7vJcv3GclU8ZXoM3d+svXyfVW/zbbZ7XRaPv968/gl0ti7SA/rd/vE2K09jh2V6gLvZ/27/6Gq+WWPsoEgP6JtqWe13r4vyTZU9YuigyHkM8dPC+ZgUNQ4FTps+mYyOHvzTJwdiQ/zuUBi7bWCpWDWGfOyzvMoekwyHjV63VaxNXzfGJixYFftt1c+CtsozWbDzjOhnwqHOM9lQrFb7ssy2q6ynIWHF861Jkt1Nk58PjaSMC0s9G+0BrJn7yvBEx5fZXdb3zdq+l3V7GdNBhir7IzkjTpjTVLvQEuFQc1mn3gUBnwpKWT32oepLN6O7WxDFejdR+/3uNmQ5ayM/7TdVXm9oXxaPt8X3xR+gCVDK2sC75Zf8fulgmt3YTbYsVw+gkUTJvlvCf2Xffltu9u3mL94XqgKXzvgEYtdkB5Ym5tTn7FuvJq/rCtZmO2b0F1e0X/ttlWeyYNVnII8LbVvpfCsEi2+yqnI75Zt8nd0uUfRAlei3pQ7r/lIWT3otRUUuZW4Ss4u70N7UNm3ds9VrX8PecAd7sj+qbLvLi+3b5W22MXdra0xc/dkseyqL/85W1ZvtXdHXqrDqs1n0sNyuN1nt55tqwWnEaF0a5hJLn4HQKcuaxv5G55iYfN3Unt0XzNYXdDCGeP4p01b6Z1nsn/wEOHv6QKjnnkqX23sK6Nmsvd1XVbH9ZbNcZQ/FZp2VH+Jdc6elKZBLrNTr0i9JDyWeXLoKaaiuxUca1eFZ9dKTaOpalu9s1EbFd+7/erXe1Dij/Xg70biHcNChp0mWvHxzcRq6e4+RfolE12/gjDeZcb3pmORpFNsiH++CbHZ1U7OXbektbdfp7FRx61nwZlXmT9W+zN5nu/2m2v2WZ18zuJmGBfuJGHXNm0x71uODSymukLoYLSxKbQ2KfRmFc3Ar14eyXY11EHQdB4MTLTYl+7eXGppTb+ufPdcAHcGsY1SbZj3SJNs5dZYJK3UMUr572iy/gUUl3XRY5ywbYumnmZbOufyQVcs8crdxiZ7iEpr4dUgLHZQ6il+8iFnwO1eyrndKeYNjvSZYW9cBLOhj53UH7nkv0SVUtNWdPOZ31c/2Fhrx/8R+9+x5ej9C+j+xd+2n3u55TEZgz2W1zQHAiFi65Hku56Zcdfu1oFCPfU+x2XiSnsg/AqX6voiun+g3WOwZfGUa1+Ajse0Jfi+/LPONkwRFxTfrXq/asjsN1c/Ubg94RD/HTg3wrNYV25cPy+192AfnWJkCutTaZyIgts8Q/zttaOK1U+fU02k6pvcAGBd3cXw2fJvvqhNnQffY7ANFnR+z5Rqf+6JC58AnMmh0ESt0k2z63o9v2n2jYv2S+AAAcuDJcpd68NPAXS48bX46eaWsmlrnWHKtAHqa1RUE364vsS2o/ryWBXrDpX14Auxiq5+LckkjW789Otva9PsbOv/VZRRJQv1ndvzRxO7lsle3i3dPBVx2P+Q7t0XTWxLbWwTVn3curtqLCHEmoM02BXD50Mt1K1t93uAV/PCs5wrV1MLLknx4+VoUoXUvQIF11uBduqVT0TtVq4MlDgKcwk80Las8gwWbZs9jGLTDDlNUeQYLWs36bX9LUNVnsEj6oGjb2GlUovZ5dl00IaAplqUR2IRfK0XrMltWGdLZTxE7qPT/o7uEBZaVDPWSfAnse9O5lKYEyviCT13JN/nzE7hGA0pc7IMTkJ2OGBjbQ7LtaLZDqkW1O6OObSW4rslnZw3ayfGyDNWxv/5Z5uufsu0e8Kp91MvEthJ68eDZWahAsZGPLuVnhNVFzMCuBCMfXapzHbEOOvp0k9dxtW4TTu7eflw+3u7L+6x0pb/3yT5g0EGp0yM1OfbpT6HJv5TFl1yGZfJtlZV3y1XW5H/HRc336lbFNvkKx4f9rjQdqiHuqqfmbHg3Mjh61D4yd+/L4vFxuV3/6BdU2KthiV5v31rzNrEZj57b42guoeP7RIpz86xncnNTC6c1y4eX5xxFaN1pRoF1yfC4yovpau9a1LA0fGa6a2fzlsxWYMfR/FRa0zHv0G5UWOm8blFxgdf7zeb/5euqx8iElZ7BitTp7oQN3ae7TnqIKfuUb7c4nF4/6Tdd6zpwsopHVn/islJf59kG3ZY9POt3xaethUwMH158tSdG67zWE1pnDUKkWzoVhFC1uiZLIoh2qu3uyFkvGx6Wu1dlWWifccICUeNZ+iDlME52QrfD6NcL2eYJJn2f6gdZ5xlsQAevE82fPnP1ajm9dJxo37J09GTC++x/9nnZbzaIOs9gQ2rhOGFC98LRy4J1drfcb6rf0B2/tBGq1jPYAS8Zpg3ouGDYp+VWuLc3Lmo8S/uvi1V0hf9k822FZ2n9+82+xzQ8lD+vbbkvKIoNvkjZPOm3J6jrwB2BeGTdtPxjk5VINfF/7wXyIa/gZ36OD3vB/ZDVaY85PEnrIlbo75fre2Sk/7v5vOtLhyMgzrrHpycBlVco86XQ1dJw3x2LHmGr3fpv+e5v+fYhK/PKO+3j16GOxsIuuXXPf6tBd6Brgufmfk6FQHoGblDYQ/aNMe4RJtTtXj7kYpd+Au+7Y1nsBqR9Zwytbq732HY3v8v/nZnabgpe0rBklS9wilZBAXOC0rJExyv35z4Qyays48M+cK+LokrC1Q/7wKU86eFZH7DTflSV6AOsPzoRgpq+OKEE/FssIjWPzBHY7dMeWeX/bgUJlb4jSC2lGUHeL9d54dMRAdLxYX+4RNw2LGAPgz4ty2UiT7t9Zgbb5Il0x02fKPrN17zCV/P8A3NEZnmLXI/7cx+IRGpo+6gPVHrSiKd9AD+U+f097HHx1Ar4W1ZW+Wq5SfSbfHwOZKIfdZFzoNP9Ckqd00C6n0Ep8wAW9/ebLOUhxNMzABM+QpWwO9Vdtdxs0sqWfG4FfbV18bYkpnxshWxieEnM4LkV9Nen9bJKY8rHZvVtWX5eF1+377PtOishr3QRK/TrfFNl5Q9l8eRqA+CwwEnY4xd52+Kt2vZBhpDrT9iiIqd35dNw/bfifdeWxntyaCps1S+Y5lbb0me1qo/xbXGQiSUfXRrWj7C6gvqBXT0CqqmGOsKpQbWOMKZmXUfDovzFbRfbl5tcELSj6WPxc1q+YFjblru1UGDCwexu1oZLVmiTYcGyv+ARzErc2rQzmBs1ZaRuXa+buzpal2739LdbO9qNVoLkuiUfWxeXd8Wrw2eOXhf7LTqMR2XMi2JRZkEelVgMm0c9tm6u/R/zXeIb12GBXhHYpqozp3xcgny3uMCl0yGB2DUngKUpdWRZ9WvzuqlhbbhTnYmjFDYzgornW5MY5IYfYN2JC5g3aKloUb9IUT193W72fVZ/ISVxvsIFTzYjvu3++s3bD6/e/+P7t68+vX918/Ov71+++vT2zc2Hjk+9W6qZ99/52+X2fr88eScxLtRrUreVQR6nfHTpRI6wuqZwYFcqoL2viu03vY1MNXV9LN7dZMe03edOoNUrW7LlY/GLWy6qh6zs1XhQ45z2NWVixiFRLlHqUiKdgu3iVMrwRFd/3hZft8c6fV7w8JneGKKXaZ1fHssfl+W3tuoZBsYIz2nf3XKzuV2uPl/ShQjjOW10n31tkGGagMVGhHGhjc8zFWLLui8NnTYRvGuyY38JyXVB96aQ/lM6GdrXdvXk/K7G753OM9Fz5YIuT2P9p3R6wsLuGEBnt6fePXW6Pv2xD8vbmL/1cZ6TS6WhWUzrzkc7z6Z14seiLDbJupfSUezqdtmrL1hNaR9Zt+5t+X/svm1XJ/D88x6gv5TFY75DIvnxYa/9/6+HavUttYi8+vnFGzgI2Ll1i8xMbomyXVZ+yVC+48mmr3VNoyEnGbVC8aeVXdURsfWbh6KsVlDhR8XsaUHow5MG7O8sH5+EL9D5qh1mnNN7aRkTlDqngZSYGZU5B/yXoqyWKC0jLnQWtfa3XSO/vz0H+GQiCC7Yy3kpE5vhQ6fREyUvabER1g0typJnt2hs7lnacgJJV0OHMue/UZPkZGktKnt2q55ulibDgme357Onuto6FjqfkW3aUichg4Lnt9e49M7mZLkzPZTNgx8LntlMOqEGFzynGVsbFzSQyIHRRc6yXUzCrhcQRc9ePQztHMqd00gq4TEqcxafTqQYwnL23EV3poGJi+5BP5jUAi2e9gMM994a0D/tB5ie+8HzfqDpWRg87weaopN42g8w+aHL9mE/uNNJr0GJnsD+G6S/PiVVd1TsnCZ+KL6mPzSBC5qbKVKXrP2Dv1GPBFWYyN79q98aJJmwL572Avy+WKO0gMOzXmBJRVc87f26p162F9j74msK633xtRfUy2yDZvXhWT+wZepWgnyMIH+/GuTbdfbH4MWfgy+1Dj94MeDr0fVicDW4c9fydoMXH+vWrgar4vGx9nDrYrX3//y9KfabD4m5wnXpvw8HVx+HVxO+Xkx+//3qY1vX/93/oYU4/sXXo8HVRwL1KKpHQT0eXH1kUI+jehzUGw2uPo5AvVFUbxTUGw+uPo5BvXFUbxzUmwyuPk5AvUlUbxLUmw6uPk5BvWlUbxrUmw2uPs5AvVlUbxbUmw+uPs5BvXlUbx7UWwyuPi5AvUVUbxGOu6MBIcZQTBlSnPGkgawBtAl5Q44OhJhDMXUo5A45ShBiD8X0oZA/5GhBiEEUU4hCDpGjBiEWUUwjCnlEjh6EmEQxlSjkEjmKEGITxXSikE/kaEKIURRTikJOkaMKIVZRTCsKecWOKox4xTGvOOQVO6owXTFdz+eLsHJMLFYOyXskvhrPrudjDisDpxQyix1ZGDGLY2ZxyCx2ZGHELI6ZxSGz2JGFEbM4ZhaHzGJHFkbM4phZHDKLZ+mejqnFIbXYsYURLTmmFofUYscWRrTkmFocUmvkqYVoOYqpNQqpNXJkGSFajmJmjUJmjRxXRsjdjWJijdRy59c75O5GYMULiTVyXBnBxTIm1igk1shxZYRIOYqJNQqJNZomyTGKmTUKmTVyXBkhRo9iYo1CYo0cV0ZTNIVHMbNGIbNGjiwjxMpRzKxRyKyxI8sIsXIcM2scMmvsmYVYOY6ZNQ6ZNeZkT49jao1Dao0dW8bDqzFdL6bjsHLMrbHaTvn9FOL0GOyoQm6NHV3G0NOOY3KNQ3KNHV3GiNTjmFvjkFvjtNcax+Qah+QaO7qM4RYy5tY45NbY0WWMSD2OuTUOuTVxdBkjNz2JuTUJuTVxdBkjTk9ibk1Cbk04OUqTmFuTkFuTUbKnJzG3JiG3Jp5bc9hyTK6J2q97cqHpNAFb9pBbE0eXCXLyk5hbk5BbkzS3JjG3JiG3Jo4uE7oaza95Pg0rx+SahOSaLNLdFbNrErJr6ggzQevLNGbXNGTX1BFmgqbiNGbXNGTX1PFlgmbTNCbXNCTXNE2uaUyuaUiuqaPLBE3FacytacitqT8MwlNdzK2pOg96bqGpOAVHwpBb0zS3pjG3piG3pvOkm5/G3JqG3Jo6tkwgt6Yxt6Yht2aeW2gqzmJuzUJuzRxdpmgqzmJuzUJuzdKr4iwm1ywk18zRZYoWtlnMrVnIrZmjyxRNplnMrVnIrZmjyxRNplnMrVnIrZkPNqDJNIu5NVPxBseWKZoPMxByCKk1c2SZovkwi5k1C5k1c1yZwkhHTKxZSKy548oURjtiYs1DYs3TZ8R5zKx5yKy548oUMXoeE2seEmvuuDJDjJ7HxJqHxJo7rswQKecxseYhseaT9AvHzJqHzJo7sszgJmAeU2seUmvuY1mI0vOYWnMVznJsmSFKz0FEK6TW3LFlhig9j6k1D6m1cGyZIUovYmotQmotHFlmiNKLmFmLkFmLtM9axNRahNRaeGqh+bCIqbUIqbXw1IIRwJhai5BaC0eWOaL0ImbWImTWIn1IXMTMWoTMWjiyzNF8WMTMWoTMWszTDcfUWqhoqWPLHM6HBYiY6pCp48scxh+HKGiqoqZDR5k5DEEOQdx0qAKnQ0eaOYxCDkHodKhip8P0rqt+puur+OlwnNyH1M90fRVDHXqyTXF9EEYdqjjq0FFoDoOhQxBJHapQ6tBTDsZDhyCYOlTR1KGPz8OQ6BDEU4cqoDpcnOh8EFMdKub5APwCRutRuD6K16cXTYIhe0U9H4df4IA/oJ4O2/tQ/ALG/FHgXkfufTQ+ZT1gno7e+4g8Pp0RCuDrCL6Pyi/gtEcxfB3E94H5BZz2KIyv4/g+Nr+A0x5F8nUo34fnF1B/QMF8Fc0nH6FfwFkH4vmkAvp0IqJPIKRPKqZPPky/gLMWBPVJRfXJR+oXcNaCuD6pwD75YD0N4bQDsX1SwX3yAXsawnkD4vukAvzkg/Y0xGIZYJ4K8pOP29MQMheE+UnF+cnH7mkIqQtC/aRi/eTj9zSE3AXhflLxfhrVGiUkLwj5k4r5k4/j0xCyF4T9ScX9aZTe1BEI/ZOK/ZOP59MQ0heE/0nF/2l0wvEBCYCUBkCjmn8LtN0hoAOQEgLIx/aJhhgAMFCJAeQD/IlFH+gBpAQB8jF+wlIzkARIaQLk4/yE5WYgC5DSBcjH+glLzkAaIKUN0LhWyrHsDBio9AE6IRAQUAhISQR0QiMgIBKQUgnIR/7xfpmAUEBKKSAf/CcsnQOtgJRYQONTBASCASnFgLwIQFh/B5oBKdGAxunILgHdgJRwQOPFiSkIxANS6gFNagZCHwYEBFIKAnlVIDEDgYhASkUgLwwQTiQAOgIpIYG8NoA1PQJSAiktgbw8QDgZAagJpOQE8hIBwYQEAooCKUmBvExADD0QUBVIyQrklQJi6IGAsEBKWSAvFhBMTSCgLZASF8jrBQTTEwjIC6T0BfKaAcEUBQISAymNgbxuQDBNgYDMQEpnoGmdLwT5D6QGUloDefmAYMYBAbWBlNxAXkIgxhMYSA6kNAfyOgLB1AMCsgMp3YG8lkAw/YCA9EBKeyAvJxBMQSCgPpCSH8grCgTTEAgIEKQUCJouTnUgYKBSIcgrCwRzGQgIEaSUCPLqAsGUBAJiBCk1grzAQCPIYKBHkBIkaFZnreE0LsBAJUqQFxoIZicQ0CVICRM0qwkIPSjQJkiJE+QFBxpDAgN9gpRAQV50IJhrQECjICVSkBceaAwJDHQKUkIFefGBYMoBAa2ClFhBXoBIbAGAXkFKsCCvQRDMPCAgWZDSLMjrEASzDwjIFqR0C/JaBMEMBALSBSntguZ15iTkL5AvSOkX5CUJGuNURMA/JWHQvOYf5C8QMUipGOSVCYJpAQSEDFJKBnl1giaQv0DMIKVmkFcoCGr0BAQNUooGeZWCoE5PQNQgpWqQVyoIavUEhA1SygZ5sYKg5E5A2yAlbpAXLAjK7gT0DVICB3nRgqD0TkDjICVy0KLO3oX8AzoHKaGDvHZBUAcnIHWQ0jrI6xcEtXACcgcpvYO8hEFQ0iageJCSPMirGARlbQKiBynVg72MQVDaZiB7sJI92OsYBOVtBroHK92DvZBBUOJmIHywEj7YCxkEZW4Gwgcr4YO9kEFQ6mYgfLASPtgLGQTlbgbCByvhg4dppY2B8sFK+WAvZeD1i4H0wUr64GHNP8R/BtoHK+2DvZZBUDlnoH2w0j7YixmprHDAPyV+cH1bAarvDMQPVuIHUzoGw0D9YKV+sJczEv0P5A9W8gfX8gdObAfyByv5g+vbCzN4WQfIH6zkD65vMMA8AAb6Byv9g5tbDHD+AwGElQDC9U0GmA/AQAFhpYBwfZsB5gQwkEBYX2jgE/xDdxr0pQau+Qf9B7rWEN1r8P4PpgcwvNmg+OdVDYIpAoxuN+jrDbUKAtMEGN1w0FccahUEqv2Mbjnoaw61CjKH/EU3HfRVh1oFgbI9o8sO+rZDrYJA3Z7RhQd944HT2i+jSw9KBeFaBYHCPwMVhJUKwrUKMof8ByoIKxWEvapBUHlnoIKwUkG4VkGg9M5ABWGlgvAJFYSBCsJKBeFaBYHaPQMRhJUIwrUIAsV3BhoIKw2EvaZBUD1noIGw0kC41kCgfM5AA2GlgfDoBP+ABsJKA+FaA4H6NwMNhJUGwuMTt7qABsJKA2GvaRAU0BloIKw0EB6nE18YaCCsNBD2mgbOoWOggbDSQHicTnxhoIGw0kC41kBgBgADCYSVBMK1BAJTABhIIKwkEB7X/IPzH0ggrCQQriUQKOIzUEBYKSBcKyBQxWeggLBSQHhygn9AAWGlgLBXNBhmATBQQFgpIFzfpYBZAAwUEFYKCHtFg2EWAAMFhJUCwl7RwDngDBQQVgoIe0WDYRYBAwWElQLC9c0KmEXAQAFhpYCwVzQYZhEwUEBYKSDsFQ2GWQQMFBBWCghP6xutkP9AAWGlgLBXNBhmATBQQFgpIDyt+Qf5DxQQVgoIN9ctIH+BAsJKAeFpvf5C/gIBhJUAwtM6gRnyFwggrAQQntbnX8g/IICwEkC4uX0B+QcEEFYCCE/rhFPIPyCAsBJAeFqvv/iiLuCf0j94Vp8/IP+A/sFK/+BZ7f8g/4D+wUr/4OY6BuQf0D9Y6R/s9QzGV8KB/sFK/+BZff6F/AP6Byv9g72ewVCBZaB/sNI/2OsZjC+HA/2Dlf7BXs9gfEEc6B+s9A/2egbjS+JA/2Clf7DXMxhfFAf6Byv9g72ewYn73oB/Sv/g+sYGvvMN9A9W+gfP64v9kH9A/2Clf/C8vtsP+Qf0D1b6B3s9g6EAy0D/YKV/cH2BAwqwDPQPVvoHez2DoQDLQP9gpX+w1zMY6qcM9A9W+gd7PYOhfspA/2Clf7DXMxjqpwz0D1b6B3s9g6F+ykD/YKV/sNczGOqnDPQPVvoH11c7oH7KQP9gpX+w1zMY6qcM9A9W+gcv6u9LQP4B/YOV/sFez2ConzLQP1jpH1zf9ID6KQP9g5X+wV7PYKh/MtA/2r/5byV9ycoqW7+pv5n08ePhi9R/Dj41H1Jiaj/O9OeAafDiz7+uBjyr/zua1v8dc/Pf5u+TUfPf5v+nzf9Pm/+fNeXnDd58Uv930fx90eAu5vV/3V2J5h+L5h9E7T/GzT9a41yWaPOP9lFrnwvd1/+gYfuP9hG3f+GmCW6ruwN7/Y9x+/7jxh53lnnx519/HT8l5f/c9rV/5jp/ucnKSvYqHb8v/efA5QSZUYLftZKAUwE47WFWVf+ouISaSKihDWq3esg36wBnNJI4cxtO+xtEAmcu7HHRNxPOl2W+8b845b91d+8+0pivdxJ3ujjCztmEertc36u+msl37IHyVH8SVkLNJdTIDuV/XGtbhWijoUSb2NCK4vOnXfNzAJ92/pcWPn3OvgXILAbDjLp6WD5VWbkqtlVZbCScMNM2sg6utjEvto/FOhgPwThjBx7Q3CcfRf+J3usNdPixil37YxWCdUfgqQ24+ZajHFtp3bQPzNNmucoeis3a+f0/Apc0Fkw2urUGM2LyiKV9sx5YmMrSH81spq2WpXJG0j/ObMx1IKv2K6gCayz7f2Z7P4eV8t1jOVdntvF0eHfN5yXla0onMhuboR6a72hKKOnaZrbp5KDiBWW0kEg2X3TwGPuw8+dyURnaXEaDVbrfqEGTfSa4sTgfMpoIM9GDCyNv61+wFp03Fcbx0DgMzZelQ5bJWTmzLcceaON/PlIMgdy7DHu8lwOKOkmu7u5SrQ2tKHbZJ+9zJZaAMrLMfTzUV5EWSVcxnLS7yWbzSpPDLtDYRjDZXaD6OJ4T43gWm/3jdp3dBWaK7YsR5fG2UKxYSFdGxt5vcPzPIBeRO1tInpH1BWtIgCbJRkZf26BFXFtI50FGR1s8Pi6364fldr1RHnIobWPrIETriXS0I9tRIHKLLN6MjX1eZssqa37LWvSRXIzI6A33pftBGz8hgz3FEcq2FK2X1TKY0HK7ZJtuDqKqvy8tPPERxkah+leMxVhLX85sc3rr7G6531Rf6s+9CzCSq/TENutSm4fZXBpmxaqW+WZXuxXt/qZi1IybEfFzY8KyhTy3ja1IOzd2YNM7lZ5qYZtszU8w6TeciC6btof7iZFezc8S3Nc/CiAHIoiUGBnSoOX+K/bybeWoDvuZ9uh/IkouOdI5TIwDIcDa7YS20gX9j8DGjV0KOHLWTpI6ohuPOQF67GqdTCIstjlKgAmMlaM/NXo7ARzxySmyYtSMhBeI8WhJE41nAw0IXlxywOqjFaoOOrpsZEF/o1MToNGqxjLgxsYzW4QI3l4aaoxxSdin5pfL5LjLDb8xNCghS/dzL4BO0qMYA4QRbMwpOUetqwVCBV0rR8wYRZDQu+NPeUiD5YAZT0EQFRgsB27af+B2h18wlMMmp9ek/6RtQYG5ckczs230AmT3q3jSUolnDBsrPOSxaSHN7O8KjrCgC+RqYAy5Kuyq/ekdCSunmjFghWFjk4eyO4wBZ4mN7JXnGJ7YZlq2Te3T5PlhYQVbNwGVYNMuXnVhY372R5Vt3c9+eHcd9JwM2o17ou12+Tq7XZbeq0Zry1i4lLFt2rc/2r45/mi73DjLhXpk68K7fFNlpRuTT2W2K/blKvvk4i2pML5L+BbnBpvnPjbStqFjQy4PXcDatgM1LODSTNpIfcBayofUlDw3Bq5AjHUuvQbbqHSfVe5wvN0/3rlfxw1j0/I0aFuR7rNqk2+znQPb7+7U2UFG361w2/3jbVZCvCAObMXbVctqv7sryuhoI4PBttlyX+ZrfaiRh0uy9lqDk2/vigBLviHbVq4WK44xye43vuDD8vF2X95npUOM58FCdpkxulPHq+rQNHavcqYa/bQEdTNfj+1cGjq0DYrEbNyshh2LTaYxjhCgVsuyQh0g5vHC5lwelrusLJVUKM8AZAwKP2Sbp1iDo2Dujm2Dkq+KLfCdMs5MRkd8hIpFPbkRJeN6Efo5KXO1GRTTQ4rHIVnDxu98+7RXqpwM7s5sEy/f7iq3FMfdNwnclPF1t+4n64vyW6jry37rh5NcvOWrWvurwfSh4zryFwShxeCMbEvjAdLN1xiRRQ8aszYCxGJVh5VXYT5ScMjqh3pKl5enTbKt6Qfceq0DfSqm4Kjn0PsQtg6HB9ErY5fumpBqMBXl5m/R5lQZd8X57m6/2XzN19VD6Lvkxr9NDSOjv853ZfY/+7wMzaRg7zExvnGVPYZnpmCnW9di6xjD6JQ8gxmXuc9Z4BVkToNxh/95W3zd7nN8ZJArr7thZwGMDjITwddJ65ipFUDH7V/mbarccNZ2ps0Htabr/RdJRZmNQlq7/wjFZMmXoY16p7yCPIDM2+RB4zx5XJaf3RGkzLbrrFRniKmMmxnTGFBQl2Rsn9jGpBYI6vEk487EtnX0sSjjUZ3JUTWeHB73myqvPWm045fHJKPQpeCeyuJLrvNchtJvGY9zHrfeXSJVXSZAjWxzY7v8kt8vnYbWRKt22bJcBR5W5lOObHZui2MM467Yb0PvOpMkNB4Vj6ty6GMDscKGtL3d7MOhkAoFGYWqYrt6cFk44bohd2/GqGkLFGSMBs5AWDc3Y25yldAzCxZx2/wqtlHECLy1zJXgsW2GFNu7YrVXmahyRhh1URdyO2GZXIJHNgfvDiH547L81gIjXMngsc2NFtt4apFUR8g4ZYvqIStdJbUUyzi4cdsn8jJDsySPR4eV2EaapzLbZeWXLMo/YOny2Jh/oAYjHAaJN7LN26ey+G+XNBAeEcUwTJoToVECa/HUKiSz3sZNB5rf2CPq7IGxGBPj5GiQOsLI4mRj3Op69SzcV0jyDW1OCguG7ot6IixpOxIeoaKNioySkzHfvszusvgEKF/R5krKbLffVLtdFkQMJuIFjUpKC+Rj3wGWMMqYqlAWX9ulPtjmiJOZCWe3KtT5RPa0jaB1atG+zFyQ2o9flBUk5pExd+AA6rhQpxwFXSbe1Cg/HhAPxEikMImV2pjkIaD9EH/Js6+hM56Itcaon2PQ2mbtqKRuZtQMMXy0o5fJFMbMhwPyrlzh0ZNpyUYZPb2xEq8+Nw9Xi4UyuqUbNIYCAWLckzLn1khZv9e4Xap1XcZ5jcGxAxI4ssljrzF6V79kGCeRsTVrtzWHoFi4lxFFtg5rrVes8eFe7tGGRiI3gLusqtzhPqEwTIStxnPHATmhWcjcV+P88Ihx5k644FnJ4m9I6XQdeTDluXFtqOWeKKNKRjfZeB5qBBk/1VxsJA68s4yMubvOfWH3TwhUnozmfaiDs4jkUZznfQiD8i9kpJyNW6MaLd7ay1uEbNy1wXckuR8l8/ytp5lOC5CRBnP3H6Hi20kytmQmyRFQT4yZIN3c6vgCjxIEasQYGA+lCi0ZA5qICWzMsVLQ0eohb2eNjYTJ/61ueMmzgnUzt4lCcfIOIlldSrHdqvkk7/qxdTiLssJp7DIYYnyz+Hgg+GVMDt495frFSCYZkzGM0uDEm4ZAmDTeO0lJ6fISwsLoKrxoFoxbEL6ygXzNKxXJGQfZNLYlrlrefs6+eWeK7ucIu4zSSnQBheUlHzZeMvQot8X6W4gkV4uFbbXwSKtldHuE5TaFjVkgNVi2CbcDUn5no2BeI4FDcEB0m0/yWHG2FsusAzZy02O5RSdEkhseY0LiAUm7KLlMG++Geqyy+BoaJXd0xiyWanmrtG8ZZjRuZxwIuhwtRUQyLs0OK8oklHtyMm4aHBDYYZFcNsm4IujknGBnZYe4yzP1XYwge8O4PzggAT8eZC4YqVTc32+yOOYnw1hkpfgRKwr6yZtWZGVnUWz0eVlK+GTMUG5wwIc2ZP8bL9a4HIBErEmgGa9ACREffXpCXnFno6QbQ8bvLc/PbNQ49jkQOOT2yhht2D+5G5UoXVyO7MI2rfa7LPui/Y7Mu2Rj6lwLtNx9265CNLlcG8/v7m6IS+7dKXFEdrtRujlC1TeiVX643AEYpYLopCg3yaM2tcN4H735TEc4q+QaMm2z+YzXYL5kpdOoH/JdlD4nj2ZsTPQN4aL8HXmxgI35tA2ki9qWj8v4Fq5knzHr1318K18tN9FyLCPNZNwrSjC4LEtRwLhrlJjx8iyXHeMORgLCZVqGHCx7td+vBk/5U+Zy4QcvPv7+11//C3sBi9tbFwEA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA819bZPbNrL1f1G+zs6qW+/+tnHsTWqdl7KdPHXLlXJxJM4MrzXiXIqy403lv98CSEqNxoHY1MytZz/FGQIHTeCgAfRpUH+OqvLLfvTiw5+jT8VuM3oxn16NdtlDPnox+rYsP728zx7rvHpZ7uqq3I6uRodqO3oxuj3s1nVR7vZ/jwtd39cPruR6m+33+X70YjT66yoB/y7f5uu6rBLA3eOzkBM+Qf78878+vnv15tXL9z+//fju/dsffvrnx3+9+q93R/zPWVVkN9t8//dk2bONLYH5Rbn7sdzkxzby3eFB2t8+P4tL8yPwy1/fvn310/uPzkAT5jeqhmjgavSYVfmuhvbi1r//+ed3rzzUO2PrYY3hrfN4taAZQ2K8KdfZtvh3vnlXV8Xubn80qf76mIck0UWtPPwuq7P3jhOAhMdnZ8H0C7wst4eH3Xf5rbL2+PdBaG/LL25m5btav714MgjxXVnV3xVVMxgKM3g2CNX3U8LS4Jl1YH7Yfc53dVl9BQNzfGZ1DT/89Nurn97//Pa/etwCLDeoH46m9XA3WW7YWK7Lx1yPofubtZfv8vpNscv3r6vy4dd3r38Ena2LDID+6fBwk1fnscMyA8Dd7P/p8OBq/rDB2EGRAdDv6qw+7F+X1Q91/oChgyKXMcRPC+djUtQ4Fjhv+mw2OXnwjx8diA3xm2Nh7LaBpWLVGPOpz4o6f0gyHDZ63VWxNn3dGpuwYF0edvUwC7oqz2TB3jNimAnHOs9kQ7leH6oq363zgYaEFS+3Jkl2N01+PjaSMi4s9Wy0B7Bm7ivDEx1f5bf50Dfr+l7WHWRMDxnq/I/kjDhjTlvtiZYIh1rIOs0uCPhUUMrqsY9VX7oZ3d+CKDa4icbv97chy1kb+fGwrYtmQ/uyfLgpvy3/AE2AUtYGfso+F3eZg2l3Y+/yrFrfg0YSJYduCf+Vf/0t2x66zV+8L1QFnjrjE4h9kx1YmphTn/Kvg5q8bipYm+2Z0Z9d0WHtd1WeyYL1kIE8LbRdpcutECx+l9e12ym/Kzb5TYaiB6rEsC11WPeXqnzUaykq8lTmJjH7uAvtTW3TNgNbvfY17A33sCf/o853+6Lcvclu8q25Wztj4urPZtljVf53vq5/2N2WQ60Kqz6bRffZbrPNGz/fVgtOI0br0jBPsfQZCJ2yrG3sb3SJicnXTe3ZfcF884QOxhDPP2W6Sv+sysOjnwAXTx8I9dxT6en2ngN6NmtvDnVd7n7ZZuv8vtxu8up9vGvutTQF8hQr9br0S9JDiSdPXYU0VN/iI43q8ax66Uk0dS3L9zZqo+JP7v8Gtd7WuKD9eDvRuodw0KGnSZZ8+ubiPHT/HiP9Eomu38IZbzLjetszydMotkU+3gXZ7Oqn5iDb0lvavtPZueLWs+C7dVU81ocqf5vvD9t6/1uRf8nhZhoWHCZiNDXf5dqznh48leIKqY/RwqLU1qA8VFE4B7dyfSzb11gPQTdxMDjRYltyeHupoTn3tv7Zcw3QCcw6Ro1p1iNNsp1zZ5mwUs8gFfvHbfYVLCrppsM6F9kQSz/ttHTO5bu8zorI3cYlBopLaOI3IS10UOop/uRFzILfu5L1vVPKG5zqtcHapg5gwRA7r3twL3uJPqGiq+7kMb+rfra30Ij/J/a7Z8/T+xHS/4m9Gz/19s9jMgJ7LqttDgBGxNIlL3M576p1v18LCg3Y95TbrSfpmfwjUGroi+j6iX6DxZ7BV6ZxDT4S257gd/Y5K7ZOEhQVf9gMetWO3WmoYab2e8AT+iV2aoBnta7cvbzPdndhH1xiZQroqdY+EwGxfYb433lDE6+dOqeeT9MxvQfAeHIXx2fDN8W+PnMWdI/NPlDU+T7PNvjcFxW6BD6RQaOLWKHbZNO3fnzT7hsVG5bEBwCQA0+We6oHPw/c58LT5qeTV6q6rXWJJdcKYKBZfUHw3eYptgXVn9eyQG94ah+eAXuy1c9FuaSRnd+eXGxt+v0Nnf/qaRRJQv1ndvzJxP7lclC3i3dPBVz23xV7t0XTWxLbWwTVn3curruLCHEmoM02BfD0oZfrVr7+tMUr+PHZwBWqrYWXJfnw6WtRhNa/AAXWWYN36ZbORe9UrR6WOAhwCj/TtKzyDBZs2z2PYdCOO0xR5Rks6DTrN8MtQVWfwSLpg6JtY69RidqX2fWkCQFNsSyNwCb8WilaV3lW50hnP0fsoNL/j+4SFlhWMtRL8iWw703nUpoSKOMLPk0l3+TPj+AaDSjxZB+cgOx1xMDYAZJtT7M9Ui2q3Rt17CrBdU0+u2jQzo6XZahO/fXPqtj8mO8OgFfdo0EmdpXQiwfPLkIFio189FR+Rlh9xAzsSjDywaU6NxHroKPPN3kdV+s34ezu7fvs4eZQ3eWVK/2tT/YBgw5KnR+p2alPfwxN/qUqPxcyLFPs6ry6zdZ5m/8dFzXfq1uXu+QrnB4Ou9J0rIa4q56as+HdyODoUffI3L0vy4eHbLf53i+osFfDEoPevrPmTWIzHj23x9FcQse3iRTn9tnA5Oa2Fk5rlg+fnnMUofWnGQXWJcPjKi+mr71rUcPS8IXprr3NWzJbgR0n81NpTae8Q7tRYaXLukXFBV4fttv/V2zqASMTVnoGK1KnuzM29J/ueukhpuxjsdvhcHrzZNh0berAySoeWf2Jy0p9XeRbdFv2+GzYFZ+uFjIxfPjkqz0xWu+1ntA6axAi3dK5IISq1TdZEkG0c233R84G2XCf7V9VVal9xhkLRI1n6YOUwzjbCf0OY1gv5NtHmPR9rh9knWewAR28zjR//sw1qOX00nGmfcvSMZAJb/P/ORTVsNkg6jyDDamF44wJ/QvHIAs2+W122Na/oTt+aSNUrWewA14yTBvQc8FwSMudcG9vXNR4lvZfl+voCv/Z5rsKz9L6t9vDgGl4LH9Z23JfUJZbfJGyfTJsT9DUgTsC8ci6afnHNq+QauL/PgjkfVHDz/ycHg6C+y5v0h4LeJLWRazQ32abO2Sk/7v5vOtLhyMgzrqnp2cBlVeoikzoamm4b05FT7D1fvO3Yv+3YnefV0Xtnfbp61AnY2GX3LjnvzWge9A1wXNzP6dCIAMDNyjsIfvGGPcIE+r2L+8LsUs/g/fNqSx2A9K+C4ZWNzd4bPub3xf/zk1ttwWf0rBklS9wjlZBAXOCUlah45X78xCIZFbW6eEQuNdlWSfhmodD4FKe9PhsCNh5P6pKDAHWH50IQU1fnFAC/g0WkdpH5gjs7vGArPJ/t4KESt8JpJHSjCBvs01R+nREgHR6OBwuEbcNC9jDoI9ZlSXytLtnZrBtkUh33A6Jor/7UtT4ap5/YI7IZDfI9bg/D4FIpIZ2j4ZApSeNeDoE8H1V3N3BHhdPrYC/5VVdrLNtot/k40sgE/2oi1wCne5XUOqSBtL9DEqZB7C8u9vmKQ8hnl4AmPARqoTdqe7rbLtNK1vyuRX01c7F25KY8rEVso3hJTGD51bQXx83WZ3GlI/N6ltWfdqUX3Zv890mryCvdBEr9OtiW+fVd1X56GoD4LDAWdjTF3m74p3a9l6GkJtP2KIi53fl83D9t+J905XGe3JoKmzVL5jmVrvSF7Wqj/FdcZCJJR89NawfYfUF9QO7BgRUUw31hFODaj1hTM26noZF+Se3Xe5ebgtB0J6mT8UvafkJw9q13K+FAhOOZvezNlyyQpsMC5b9BU9gVuI2pl3A3KgpI3Wbev3c1dG6dLvnv93a0260EiTXLfnYurj8VL46fubodXnYocN4VMa8KJZVHuRRicWwfTRg6+ba/77YJ75xHRYYFIFtqzpzqocM5LvFBZ46HRKIfXMCWJpSR7J6WJvXbQ1rw73qTBylsJkRVLzcmsQgt/wA605cwLxBS0WLhkWKmunrdrNv8+YLKYnzFS54thnxbffXP7x5/+rtP7598+rj21fvfv717ctXH9/88O59z6feLdXM++/iTba7O2Rn7yTGhQZN6q4yyOOUj546kSOsvikc2JUKaB/qcvdVbyNTTV2fivc32TNtD4UTaPXKlmz5VPzJLZf1fV4NajyocUn7mjIx45Aolyj1VCKdg+3jVMrwRFd/2pVfdqc6Q17w+JneGGKQab1fHisesuprV/UCA2OE57TvNttub7L1p6d0IcJ4ThvdZ19bZJgmYLERYTzRxueZCrFl/ZeGzpsI3jXZsb+E5HpC96aQ/lM6GdrXdfXs8q7G753OM9Fz5Qldnsb6T+n0hIX9MYDebk+9e+p0ff5jH5a3MX/r4zInl0pDs5jWn49mH3qxg9rnrz5j5aJ7ZN0md+X/sf+6W5/B888HgP5SlQ/FHgnSp4eD9tq/Hqs1N8IioujnT94sQcDebVJkZnL7ke/z6nOOcgvPNn2taxoNOcuoNYr1rO0Kiohjv7svq3oN1XRUzJ6Cgz7yaMD+xvKhR/gCva/aY8YlvZeWDEGpSxpICYdRmUvAfymrOkMpEHGhi6h1uOkb+cPNJcBnky5wwUHOS5nYDh86+Z0p+ZQWWxHb0KIseXGLxuaepS0nRvQ1dCxz+Ru1CUWW1qKyF7fq6WZpMix4cXs+U6mvrVOhyxnZpQj1EjIoeHl7rUvvbU6Wu9BD2Tz4qeCFzaSTV3DBS5qxtfGEBhL5JrrIRbaLSdj3AqLoxauHoZ1juUsaSSUXRmUu4tOZdD5Yzp4n6M40MEnQPRgGk1qgxdNhgOHeWwP6p8MA03M/eD4MND0Lg+fDQFN0Ek+HASY/Ktk9HAZ3PsE0KDEQ2H/v89fHpMKNil3SxHfll/RHHXBBczNl6kKzf/A3GpAMCpPG+39hW4Mkk+PF00GA35YbJMEfnw0CS6qn4ung1z33soPA3pZfUlhvyy+DoF7mWzSrj8+GgWWpGwDyMYL8/WpU7Db5H6MXf44+N5r36MWIryfXq9HV6NZdgduPXnxoWrsarcuHh8bDbcr1wf/z97bYbz4k5go3pf8+Hl19GF/N+HpF899/v/rQVfYP/B86jNNffEUaXX0gVJGiihRU5NHVB0YVOarIQcXJ6OrDBFWcRBUnQcXp6OrDFFWcRhWnQcXZ6OrDDFWcRRVnQcX56OrDHFWcRxXnQcXF6OrDAlVcRBUXQcXl6OrDElVcRhWXQcXV6OrDClVcRRVXIQEcHwhyh2LykGKPpw/mDyBQyCByvCDIIYpJRCGLyHGDII8oJhKFTCLHD4JcophMFLKJHEcI8oliQlHIKHI8IcgpiklFIavIcYUgrygmFoXMIscXgtyimFwUsoscZwjyi2KCUcgwdpxhyDCOGcYhw9hxhumK6Xo5m4WVY4ax8lHeSfHVdHG9HC/DysBNhQxjxxmGDOOYYRwyjB1nGDKMY4ZxyDB2nGHIMI4ZxiHD2HGGIcM4ZhiHDONFurdjhnHIMHacYUhPjhnGIcPYcYYhPTlmGIcMm3iGQXpOYoZNQoZNHGcmkJ6TmGGTkGETx5kJdICTmGETtRL6pRA6wAlYDEOGTRxnJnghjRk2CRk2cZyZQHpOYoZNQoZN5kmSTGKGTUKGTRxnJpDbk5hhk5BhE8eZyRzN50nMsEnIsInjzATScxIzbBIybOo4M4H0nMYMm4YMm3qGQXpOY4ZNQ4ZNOdnb05hh05BhU8eZ6fhqSterSVg3JthUbbf8fgtSewp2XCHBpo4yU+h5pzHBpiHBpo4yU0jtaUywaUiwadqFTWOCTUOCTR1lpniTGRNsGhJs6igzhdSexgSbhgSbOcpModuexQSbhQSbOcpMIbVnMcFmIcFmnByqWUywWUiw2STZ27OYYbOQYTPPsCVsOWbYTG3qPcPgpJqBfX3IsJnjzAz6/FnMsFnIsFmaYbOYYbOQYTPHmRldTZbXPAun5Cxm2Cxk2GyV7rCYYbOQYXPHmRlcbeYxw+Yhw+aOMzM4Jecxw+Yhw+aOMzM4q+Yxw+Yhw+Zphs1jhs1Dhs0dZ2ZwSs5jhs1Dhs39uRGf/2KGzdXR0TMMTsk5OD2GDJunGTaPGTYPGTZfpnz+PCbYPCTY3FFmBgk2jwk2Dwm28ASDM3IRE2wREmzhKDOHM3IRE2wREmyRXiMXMcEWIcEWjjJzuM4tYoItQoItHGXmcFItYoItQoItHGXmcFItYoItQoItfHACTqpFTLCFik84yszhvFiAEEVIsIXjzBzOi0XMsEXIsIXjzBzHRmKGLUKGLR1n5jg+EjNsGTJsmT5JLmOGLUOGLR1n5pDby5hhy5BhS8eZBeT2MmbYMmTY0nFmAem5jBm2DBm2nKXfOWbYMmTY0nFmATcGy5hhy5BhSx8Cg9xexgxbqiiY48wCcnsJAmEhw5aOMwvI7WXMsGXIsJXjzAJyexUzbBUybOU4s4DcXsUMW4UMW6V92Cpm2Cpk2MozDE6MVcywVciwlWcYDh7GDFuFDFs5ziwht1cxw1Yhw1bpk+QqZtgqZNjKcWYJJ8YqZtgqZNhqmW45ZthKxVodZ5ZwYqxAuFXHWx1pljhyOUYRVxVyHTveLHHwcgyCrmMVdR076ixx/HIM4q5jFXgdpzdkzTNdX8Vex9PU/qR5pKur6OvYE24Oq4Pw61jFX8eOREscQx2DCOxYhWDHnnU4jDoGQdixisKOfYQfR1LHIA47VoHY8epM74NQ7FixzwfwVzjcj+L9UcA/vYoSDPkr9vkw/iqhGAD26bC/j+SvsGiAAv868u+D+Sn7Af108N/H8/H5jVD4X8f/fUh/hWc/UgC0BOCj+is8+5EIoFUAH9hf4dmPdAAtBPjY/goLGEgKUFoA+fD+Cs8/oAaQkgPojB5AQBAgpQiQD/Kv8PwFmgApUYB8nH+F5y+QBUjpAuRD/TTGExBIA6S0AfLhfhrjGQTkAVL6APmQP40TuhugoNIIyIf9aYw5DGQCUjoB+dA/jTGJgVRASisgH/6nMWYxkAtI6QU0aURPTGMgGZDSDMjLADTGPAayASndgCbp7R4B5YCUdEBeDaAxJjJQD0jJBzQ54wiBgEBKQaBJw8MV2gUREBFIqQjkhQGiMQYAPFRKAnlxAO8EgJRASksgLw9QQrwGcgIpPYG8REAJARtICqQ0BfIyASVEbCArkNIVaNrI7wkhG7BQaQt0RlwgoC6QkhcorS8QEBhIKQzkRQO8kSagMZASGcjrBpTQ4oHOQEpooOk5DgKtgZTYQF4/oISgD/QGUoIDTdPxYAKSAynNgaarM9MQyA6kdAeaNSTEngxID6S0B/JyAp6GQHwgpT6QFxQokZgABAhSCgR5UQGLggQ0CFIiBHldgRLJDUCHICVEkNcWCCc4ENAiSIkR5PUFYuyJgB5BSpAgrzEQY08ENAlSogR5nYFwsgMBXYKUMEFeayCc8EBAmyAlTpDXGwgnPRDQJ0gJFOQ1B8KJDwQ0ClIiBc2bdCQ8EYBOQUqoIK89EM5hIKBVkBIryOsPxHguA72ClGBBXoMgnMtAQLMgJVqQ1yEI5zMQ0C1ICRfktQjCOQ0EtAtS4gV5QYJwXgMBAYOUgkHz1blOBExUKgZ5YYJwcgQBIYOUkkFenCCc40BAzCClZpAXKGiCqQwEDVKKBi2a5LhEphhgolI1yAsVhPMdCAgbpJQNWjRMxE4ViBuk1A3yggVNMZWBwEFK4SAvWhDOXyAgcpBSOcgLFzTFVAZCBymlg7x4QTiPgYDYQUrtIC9gJPYGQO8gJXiQ1zAIpzMQ0DxIiR7kdQzCKQ0EdA9Swgd5LYNwWgMB7YOU+EHLJlMTMxnoH6QEEPKaBk0TeY+AiEoEoWVDRMxkoIOQEkLIaxuEkw0IaCGkxBDy+gbNMJOBHkJKECGvcRCW/gloIqREEfI6B2H5n4AuQkoYIa91EE4BIKCNkBJHyOsdhJV8AvoIKYGEvOZBWM0noJGQEknI6x6EFX0COgkpoYRWTd4wZiLQSkiJJeT1D8ICOwG9hJRgQl4DISyyE9BMSIkm5HUQwlo5Ad2ElHBCXgshrJcT0E5IiSfsxRDCmjkD9YSVesJeDSGsmzOQT1jJJ+zlEMLaOQP9hJV+wl4PIayfMxBQWAko7BURwho6AwmFlYTCXhMhrKMzEFFYiSg8Tut2DEQUViIKe1EEL2wMRBRWIgqPGx7CmcBARWGlorBXRQhL8gxkFFYyCntZJJWWDmioZBRuLk5gWZ+BjsJKR2FKR24Y6CisdBT2ukhiCICOwkpH4UZHwan1QEdhpaNwc4tigW8QASGFlZDCzU0KnGHAQElhpaRwe5sCewIgpbCSUri5UYEzDRhoKay0FG5uVeBsAwZiCuuLFXyGhehqhb5bwQ0LsSdB1yui+xXeGeLEA4ZXLBQNvTxCOPmA0TULfc+i0VNwAgKjqxb6rkWjp+A8AkbXLfR9i0ZPWWImoysX+s5Fo6fgjABG1y70vYtGT8EpAYyuXui7F5wWlRndvlByCjdyCs4pYCCnsJJTuJFTlngmADmFlZzCXh4hrOsz0FNY6Snc6ClY2Gegp7DSU/iMnsJAT2Glp3Cjp+DMAAZ6Cis9hRs9BUv7DPQUVnoKe4GEsDbPQFFhpahwo6hgcZ6BosJKUeHJGR4CQYWVoMKNoILVdQaCCitBhadnbpsBPYWVnsJeHyEszzMQVFgJKjxNJ9cwUFRYKSrsFRKcs8dAUWGlqPA0mV3DQE9hpadwo6fg9AIGegorPYUbPQXnFzDQU1jpKTxtOIgdARBUWAkq3AgqOEOAgaDCSlDh2ZlFGegprPQU9gIJ4RQDBooKK0WFvUDCOMWAgaLCSlHh5lIHTjFgIKmwklTYKyQ4jZyBosJKUWEvkDBOUWCgqLBSVNgLJIxTFBgoKqwUFW7ueOAUBQaKCitFhb1AwjhFgYGiwkpRYS+QME5RYKCosFJUeN5cu8UzASgqrBQV9gIJ4xQDBooKK0WF5w0RMZOBosJKUeH27gdmMlBUWCkqPG8WZcxkoKiwUlR43iRQYyYCRYWVosLz5qiMmQgUFVaKCrd3QTATgaLCSlHheZPqipkIFBVWigrPm1U5caUYMFEpKrxoPCJmIlBUWCkqvGiWZcxEoKiwUlS4vSCCmQgUFVaKCnuBhBOX2IGiwkpR4UVzXsZMBIoKK0WFvUDCWONloKiwUlTYCyScuNAOFBVWigp7gYQTl9qBosJKUWEvkHDiYjtQVFgpKuwFEk5cbgeKCitFhb1Cwqk76oCJSlLh5hJJ4p46kFRYSSq8bD5JgJkIJBVWkgovm88SYCYCSYWVpMJeIWGs8TKQVFhJKtxcKsEaLwNJhZWkwl4hYazxMpBUWEkq7BUSxhItA0mFlaTCXiFhLNEykFRYSSrsFRLGEi0DSYWVpMJeIWEs0TKQVFhJKuwVEsYSLQNJhZWkws2FEyzRMpBUWEkq7BUSxhItA0mFlaTCq+YjGZiJQFJhJamwV0gYS7QMJBVWkgo3F1CwRMtAUun+5r/k9Dmv6nzzQ/NFpw8fjt/L/nP0sf3ME1P36ag/R0yjF3/+dTXiRfPfybz575Tb/7Z/n03a/7b/P2//f97+/6Itv2zxlrPmv6v276sWd7Vs/uvuX7T/WLX/IOr+MW3/0Rnn0kzbf3SPOvtcEL/5B427f3SPuPsLt01wV90d0Zt/TLv3n7b2uIPPiz//+uv0oSv/566v/TPX+dk2r2rZq3T6+vWfI5dIZEYJfuFKAs4F4JzsgHXz8+ISaiahjG+4X98X202AM5lInKUNp/s1IoGzFPa4sJsJ53NWbP1vT/kv8d25T0gWm73Ena9OsEs2od5kmzvVVwv5jgNQHpsP1kqopYSa2KH8z2zt6hBtMpZoMxtaWX76uG9/rODj3v/mwsdP+dcAmcVgmFHX99ljnVfrcldX5VbCCTNtI+vgGhuLcvdQboLxEIwzduARzX2QUvSf6L3BQMefrdh3P1shWHcCntuA2y9NyrGV1s2HwDxus3V+X243zu//EbikqWDyzPjODWbE5AlL+xYDsDCVpT9a2ExbZ5VyRtI/LmzMdSDr7hutAmsq+39hez+HlfLdUzlXF7bxdHi37ccv5WtKJ7KYmqHu2698Sijp2ha26eSg4gVlspJINl909BiHsPOXclEZ21xGi1W5X6tBk30huLG6HDKaCAvRgysjb5vfshadNxfG8dg4DO13r0OWyVm5sC3HHmjrf0hSDIHcu4wHvJcDijpJru7uoq4NrSz3+UfvcyWWgDKyzH3a1FeRFklXMZ51u8l280qz4y7Q2EYw2V1Q+zSeM+P7ltvDw26T3wZmiu2LEeXhplSsWElXRlZrGhz/g8hl5M5WkmdkJGwLCdAk2cjoa1u0iGsr6TzI6GjLh4dst7nPdput8pBjaRtbByFaT6SjndiOApFbZPFmbOzzKs/qvP1Va9FHcjEiozc8VO7ndvyEDPYUJyjbUrTJ6iyY0HK7ZJtuDqJuvn4tPPEJxkah5veMxVhLX85sc3qb/DY7bOvPzcfoBRjJVdroA1Kbh8VSGmbFqrNiu2/cinZ/czFqxs3Ipti7Hgdb1bn0LyvbFGl/1knbNRMvOu+O5DMjr9qfOrhrfmhAdl8Q3zCOa4tW+C/jy7eVYzE28rUFe/A/OyUXCnnSmg0H6zYB2koOQjrGPWIKOHKxTmg6oVvnrESPHaRTPYTFRo7HmMBYuRgbz9wSOOITyzWBZ0ZnIxDj0ZImGrfhGhC8uOTAfDgHHKoOFbqMYkH/4cMUrUUcLGtWZ6QRwdvLQTIeUCXsY/traHLc5bvPjI5OQFbuJ2QAneSyY4zFRbAxp+QcNR7IICroWjlixtiEhN6ffh5EGiwHzHjihqjAYDlwxihlAH38VUQ5bHJ6zYZP2g4UmCuPg3PbbjFAdr+0Jy2VeMZAtMKDHluuhMaYDYaNu2AsVwNjzFVh193P+UiT5VRbDJ9qJ1hgsuwOY3ReYiN7x3KmzWwzLd+l9mly17+yTbB8t2nDIMFWW4zOyraw5H/U+c79lIh310HPyVDbdCDafl9s8pus8l41WlumYt5PbbzvfnR9e/rRddGF8ijNE1sX3hbbOq/cmHys8n15qNb5RxclSQXfXY622O3bBv3USNeGjui43HEBa1sQGljApYW0kYaAdZQPqSl9vzHcBCKjS7mPYhuV7vLaHWl3h4db94u7YURZnuFsy8ZdXm+LXb53YIf9rTo7yJi5FW53eLjJK4gXRG+tePs6qw/727KKjjYyhGubLXdVsdGHmpUM9ll7rcUpdrdlgCXfkG3+usOKI0Oy+40veJ893Byqu7xyiPE8WMkuM8ZkmihTE1DG7lXOVKOflqBu5uuxXUpDx7ZBkZitm9WwU7E+TW2MDlDrrKpRB4h5vLI5l/tsn1eVEvjkvo+Modz7fPsYK2cUzN2pbVCKdbkDvlNuHMnoiE9QsRQngwhkXC9CPyfFqS7vYX5MzDimWNj4XeweD0pLkyHZhW3iFbt97ZbiuPtmgZsyvu7uc76ry+prqMbLfhuGk1y85ata+6vF9AHfJl4XhI7F4ExsS+MR0s3XGJFFDxpzLQLEct0Eg9dhFlFwahmGek5Nlwd5sq3pR9xmrQN9KqbgZODQ+8CzDmIHERxjl+7bkGowFeXmb9VlQhl3xcX+9rDdfik29X3ou+TGv0voIqO/LvZV/j+HogrNpGDvYUyRctwJz0zBTrepxdYxhtEpeWw0LnOf8sAryEwE4w7/0678sjsU+MggV153Gc4CGB1kZoKvs84xUydbTru/LLsEt/Gi60ybD+pM1/svkjowG+Wvbv8RSsCSL2Mb9c55BXkAWXYpf8Z58pBVn9wRpMp3m7xSZ4i5PHIbkw9QUJfk2Z3YxqQOCKroJOOPxLZ19KGs4lFdyFE1nhweDtu6aDxptOOXxySjPKXgHqvyc6GzU6SMTsbjnMdtdpdIC5dpSxPb3Nhln4u7zGlybbRqn2fVOvCwMgtyYrNzV55iGLflYRd614UkofGoeFqVQx8bBK1tSLub7SEcCqknkTEQVe7W9y53Jlw35O7NqOx1QEGeZ+AMhHVLM+a2UGk4i2ARt82vchdFjMBbywwHntpmSLm7LdcHlT8qZ4RRL3QhtzOWySV4YnPw7hBSPGTV1w4Y4UoGT21utNzFU4tkWJWMU7as7/PKVVJLsYz+Grd9IpsyNEvyeHJciW2keazyfV59zuOsARlQYGOKphqMEE9SemKbt49V+d8u9TY8IophmLUnQqOU0OGpVUjmqk3bDjTmSbSIOntgKjrPODlapJ4wsjjZGLe6Xj0L9xWSfGObk8KCoftUnghL2khygoo2KjJKTsYs+Sq/zeMToHxFmyup8v1hW+/3eRAxmIkXNIo/HZCPfQdYwiijVlmVX7qlPtjmiJOZCWe/LtX5RPa0jaBNQtChyl2Q2o9flMsj5pEx0+MI6rjQJAoFXSbe1CiSHRGPxEgkHomV2pjoIKD9EH8u8i+hM56JtcYovGHQxmbtqKRuZpQ5MXy0o5fJFEbF+4i8r9Z49GQysTEFOL2xEq++NA9Xh4XysKUbNIYCAWLckzJT1khZv9e4ydS6LuO8xuDYEQkc2eSx1xi9a14yjJPITbx1UNtDUCzcy/gfGx1+q1ds8OFe7tHGRiK3gPu8rt3hPqEwzAQDjeeOI3JCs5AZq0O6Ms7cCUKeVjY395p0uo6MSLLxDNPKPVFGlYwYs3XaNoKMn2ouNhIH3t1FZgE7ZJQb2MMjApXnhOWQAcZZRPKAz0vjGuvxUP6FvK/Hxp1WgxZt7TncHVk9C3hHkvtRMo9vM810WoCMNJjH9AQV3ymSsaWldXqdAPXEWAjPt7TOsMCjBIEaMZ7GQ6lCS8aAZoJ4xiQ+BR2tHvJO1dRIvuLf6l6WPCtYN3PbKBQnbw6S1T2Vu52aTzK4zlZ2lFW9KarmMmi4uMpVx4gVHQ+ERcYc2f1joV+MZK4tGcMoLU68aQiESeNtkZSULq8OrIyuwotmwbgF4SsbyJeiVpGcaZBNY3PNdXbzKf/qnSm6VSPsMkor0bURlrdG2ehiPMpNufkaIsnVwngZ0COts+jOB0vRnI0ydwOWb8PtgAy0sDGdokECh+CA6ANeMc7WYuneeGXbhnost+iEbyg3PEaWH5G0VXKZNt4U9VhV+SU0Su7ojFmSdXajtG8ZZjRujxwIutIsRUQyOl+HFWUSyj05GTcNDgjssEgum2SdfSo5J9il2SFui1x9zSLI3jDuD45IwI8HmQvGyVLe3W3zOOYnw1hkZdMJKwr6yZtWZHUKZbnV52Up4ZPxLkyLAz6PIfvfeMHC5QAkYk0CzXgBQoj46IMR8mI6GyXdGDJ+b3l+ZqPGcSiAwCGXMmO04fDo7kGidHE5sivbtDrs8/yz9jsyIZSNWScdULb/uluHaPIdjYl47m6IS+7dK3FEunpjKOAE1dxjVvnhciCNYlB0UpQbkkmX2mG8YNJ+XCOcVXINmXfZfMZ7JZ/zymnU98U+Sp+TRzM2JvqGcFH+jrxYwMZ82hbSRW2rhyy+Oyv5Ysz6dZ/MKtbZNlqOZaSZjJsDCQaXZSkKGLdBEjNenuWyY9yGSkC4TMuQg2WH9fvV6LF4zF0u/OjFh9//+ut/Aa5Oo9sbFwEA"; \ No newline at end of file diff --git a/platform-bible-react/enums/BookSelectionMode.html b/platform-bible-react/enums/BookSelectionMode.html index e88a4cacf3..279f77420c 100644 --- a/platform-bible-react/enums/BookSelectionMode.html +++ b/platform-bible-react/enums/BookSelectionMode.html @@ -1,3 +1,3 @@ -BookSelectionMode | platform-bible-react

    EnumerationBookSelectionMode

    Enumeration Members

    CHOOSE_BOOKS +BookSelectionMode | platform-bible-react
    +

    Enumeration Members

    CHOOSE_BOOKS
    CURRENT_BOOK
    diff --git a/platform-bible-react/enums/DropdownMenuItemType.html b/platform-bible-react/enums/DropdownMenuItemType.html index b63d90ec16..7c4a870dfe 100644 --- a/platform-bible-react/enums/DropdownMenuItemType.html +++ b/platform-bible-react/enums/DropdownMenuItemType.html @@ -1,3 +1,3 @@ -DropdownMenuItemType | platform-bible-react

    EnumerationDropdownMenuItemType

    Enumeration Members

    Check +DropdownMenuItemType | platform-bible-react
    +

    Enumeration Members

    Check
    Radio
    diff --git a/platform-bible-react/functions/Alert.html b/platform-bible-react/functions/Alert.html index c957a5fc71..ee24521d9b 100644 --- a/platform-bible-react/functions/Alert.html +++ b/platform-bible-react/functions/Alert.html @@ -1,4 +1,4 @@ -Alert | platform-bible-react
    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof +Alert | platform-bible-react
    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertDescription.html b/platform-bible-react/functions/AlertDescription.html index 6bcec9e3aa..a3ee05ab13 100644 --- a/platform-bible-react/functions/AlertDescription.html +++ b/platform-bible-react/functions/AlertDescription.html @@ -1,4 +1,4 @@ -AlertDescription | platform-bible-react

    FunctionAlertDescription

    Properties

    $$typeof +AlertDescription | platform-bible-react

    FunctionAlertDescription

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/AlertTitle.html b/platform-bible-react/functions/AlertTitle.html index 0dc4627b2d..fd140bee98 100644 --- a/platform-bible-react/functions/AlertTitle.html +++ b/platform-bible-react/functions/AlertTitle.html @@ -1,4 +1,4 @@ -AlertTitle | platform-bible-react

    Properties

    $$typeof +AlertTitle | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Badge.html b/platform-bible-react/functions/Badge.html index 602e8ec33a..bb9544abb7 100644 --- a/platform-bible-react/functions/Badge.html +++ b/platform-bible-react/functions/Badge.html @@ -1 +1 @@ -Badge | platform-bible-react
    +Badge | platform-bible-react
    diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index 93c3c6f0e8..e3d6e38a53 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    +BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    diff --git a/platform-bible-react/functions/BookSelector.html b/platform-bible-react/functions/BookSelector.html index 14e41eaf0c..b8bcd7850e 100644 --- a/platform-bible-react/functions/BookSelector.html +++ b/platform-bible-react/functions/BookSelector.html @@ -1 +1 @@ -BookSelector | platform-bible-react
    +BookSelector | platform-bible-react
    diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index f408a6f1a3..bd1e1f2c32 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ -Button | platform-bible-react

    Properties

    $$typeof +Button | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Card.html b/platform-bible-react/functions/Card.html index 2d2cf6cd52..6b792cd2a3 100644 --- a/platform-bible-react/functions/Card.html +++ b/platform-bible-react/functions/Card.html @@ -1,4 +1,4 @@ -Card | platform-bible-react

    Properties

    $$typeof +Card | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardContent.html b/platform-bible-react/functions/CardContent.html index 18a3b1358e..c0dc87ec40 100644 --- a/platform-bible-react/functions/CardContent.html +++ b/platform-bible-react/functions/CardContent.html @@ -1,4 +1,4 @@ -CardContent | platform-bible-react

    Properties

    $$typeof +CardContent | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardDescription.html b/platform-bible-react/functions/CardDescription.html index 5263c921ad..f733c65ef6 100644 --- a/platform-bible-react/functions/CardDescription.html +++ b/platform-bible-react/functions/CardDescription.html @@ -1,4 +1,4 @@ -CardDescription | platform-bible-react

    FunctionCardDescription

    Properties

    $$typeof +CardDescription | platform-bible-react

    FunctionCardDescription

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardFooter.html b/platform-bible-react/functions/CardFooter.html index 6b85b8578d..dbe92e0593 100644 --- a/platform-bible-react/functions/CardFooter.html +++ b/platform-bible-react/functions/CardFooter.html @@ -1,4 +1,4 @@ -CardFooter | platform-bible-react

    Properties

    $$typeof +CardFooter | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardHeader.html b/platform-bible-react/functions/CardHeader.html index 3e84b7760c..37c21a8f36 100644 --- a/platform-bible-react/functions/CardHeader.html +++ b/platform-bible-react/functions/CardHeader.html @@ -1,4 +1,4 @@ -CardHeader | platform-bible-react

    Properties

    $$typeof +CardHeader | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardTitle.html b/platform-bible-react/functions/CardTitle.html index 1d38ae7d2c..1fa4516387 100644 --- a/platform-bible-react/functions/CardTitle.html +++ b/platform-bible-react/functions/CardTitle.html @@ -1,4 +1,4 @@ -CardTitle | platform-bible-react

    Properties

    $$typeof +CardTitle | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index cd4c9dbf86..fd07d9aa27 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    +ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index eeac5e51bf..7bc15ad93b 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,4 +1,4 @@ -Checkbox | platform-bible-react

    Properties

    $$typeof +Checkbox | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index f3b5f0a5b5..f3e64707c8 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,2 +1,2 @@ Checklist | platform-bible-react
    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index bc8ed49b52..d69ea469fb 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react
    +

    Type Parameters

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/DataTable.html b/platform-bible-react/functions/DataTable.html index fff0671bab..196161e15d 100644 --- a/platform-bible-react/functions/DataTable.html +++ b/platform-bible-react/functions/DataTable.html @@ -1,3 +1,3 @@ DataTable | platform-bible-react
    +

    Type Parameters

    • TData
    • TValue

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/DisableButton.html b/platform-bible-react/functions/DisableButton.html index ae107fdcff..8e0051d8bd 100644 --- a/platform-bible-react/functions/DisableButton.html +++ b/platform-bible-react/functions/DisableButton.html @@ -1,4 +1,4 @@ DisableButton | platform-bible-react

    FunctionDisableButton

    +
    diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index 0071086a59..71616f7480 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,5 +1,5 @@ DropdownMenu | platform-bible-react

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index d6026779d3..214c6f4de5 100644 --- a/platform-bible-react/functions/DropdownMenuCheckboxItem.html +++ b/platform-bible-react/functions/DropdownMenuCheckboxItem.html @@ -1,4 +1,4 @@ -DropdownMenuCheckboxItem | platform-bible-react

    FunctionDropdownMenuCheckboxItem

    Properties

    $$typeof +DropdownMenuCheckboxItem | platform-bible-react

    FunctionDropdownMenuCheckboxItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuContent.html b/platform-bible-react/functions/DropdownMenuContent.html index a0d610bb5c..d8495b76fe 100644 --- a/platform-bible-react/functions/DropdownMenuContent.html +++ b/platform-bible-react/functions/DropdownMenuContent.html @@ -1,4 +1,4 @@ -DropdownMenuContent | platform-bible-react

    FunctionDropdownMenuContent

    Properties

    $$typeof +DropdownMenuContent | platform-bible-react

    FunctionDropdownMenuContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuGroup.html b/platform-bible-react/functions/DropdownMenuGroup.html index bd8f875098..a6049e4c61 100644 --- a/platform-bible-react/functions/DropdownMenuGroup.html +++ b/platform-bible-react/functions/DropdownMenuGroup.html @@ -1,4 +1,4 @@ -DropdownMenuGroup | platform-bible-react

    FunctionDropdownMenuGroup

    Properties

    $$typeof +DropdownMenuGroup | platform-bible-react

    FunctionDropdownMenuGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuItem.html b/platform-bible-react/functions/DropdownMenuItem.html index 6ddfce5bb1..9a2c905037 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,6 +1,4 @@ -DropdownMenuItem | platform-bible-react

    FunctionDropdownMenuItem

    TODO: fix: direction is not automatically handled by this component, so that shortcuts are -display always to the right

    -

    Properties

    $$typeof +DropdownMenuItem | platform-bible-react

    FunctionDropdownMenuItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index b4c5729cd7..ebce04f4b2 100644 --- a/platform-bible-react/functions/DropdownMenuLabel.html +++ b/platform-bible-react/functions/DropdownMenuLabel.html @@ -1,4 +1,4 @@ -DropdownMenuLabel | platform-bible-react

    FunctionDropdownMenuLabel

    Properties

    $$typeof +DropdownMenuLabel | platform-bible-react

    FunctionDropdownMenuLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuPortal.html b/platform-bible-react/functions/DropdownMenuPortal.html index 2ad32cadd4..06f7485891 100644 --- a/platform-bible-react/functions/DropdownMenuPortal.html +++ b/platform-bible-react/functions/DropdownMenuPortal.html @@ -1,5 +1,5 @@ DropdownMenuPortal | platform-bible-react

    FunctionDropdownMenuPortal

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index aec28ed2b7..a3e4c55316 100644 --- a/platform-bible-react/functions/DropdownMenuRadioGroup.html +++ b/platform-bible-react/functions/DropdownMenuRadioGroup.html @@ -1,4 +1,4 @@ -DropdownMenuRadioGroup | platform-bible-react

    FunctionDropdownMenuRadioGroup

    Properties

    $$typeof +DropdownMenuRadioGroup | platform-bible-react

    FunctionDropdownMenuRadioGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioItem.html b/platform-bible-react/functions/DropdownMenuRadioItem.html index ae254cebdc..a33368910e 100644 --- a/platform-bible-react/functions/DropdownMenuRadioItem.html +++ b/platform-bible-react/functions/DropdownMenuRadioItem.html @@ -1,4 +1,4 @@ -DropdownMenuRadioItem | platform-bible-react

    FunctionDropdownMenuRadioItem

    Properties

    $$typeof +DropdownMenuRadioItem | platform-bible-react

    FunctionDropdownMenuRadioItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSeparator.html b/platform-bible-react/functions/DropdownMenuSeparator.html index f93b686c04..cd72f862d1 100644 --- a/platform-bible-react/functions/DropdownMenuSeparator.html +++ b/platform-bible-react/functions/DropdownMenuSeparator.html @@ -1,4 +1,4 @@ -DropdownMenuSeparator | platform-bible-react

    FunctionDropdownMenuSeparator

    Properties

    $$typeof +DropdownMenuSeparator | platform-bible-react

    FunctionDropdownMenuSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuShortcut.html b/platform-bible-react/functions/DropdownMenuShortcut.html index d960cf7afa..f7ba5c2699 100644 --- a/platform-bible-react/functions/DropdownMenuShortcut.html +++ b/platform-bible-react/functions/DropdownMenuShortcut.html @@ -1,2 +1,2 @@ -DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    Properties

    displayName: string
    +DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    Properties

    displayName: string
    diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index 2e34522364..4ca34db10d 100644 --- a/platform-bible-react/functions/DropdownMenuSub.html +++ b/platform-bible-react/functions/DropdownMenuSub.html @@ -1,5 +1,5 @@ DropdownMenuSub | platform-bible-react

    FunctionDropdownMenuSub

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index a900b0ff25..1fe3650887 100644 --- a/platform-bible-react/functions/DropdownMenuSubContent.html +++ b/platform-bible-react/functions/DropdownMenuSubContent.html @@ -1,4 +1,4 @@ -DropdownMenuSubContent | platform-bible-react

    FunctionDropdownMenuSubContent

    Properties

    $$typeof +DropdownMenuSubContent | platform-bible-react

    FunctionDropdownMenuSubContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubTrigger.html b/platform-bible-react/functions/DropdownMenuSubTrigger.html index 2e1785130a..463b6b3683 100644 --- a/platform-bible-react/functions/DropdownMenuSubTrigger.html +++ b/platform-bible-react/functions/DropdownMenuSubTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuSubTrigger | platform-bible-react

    FunctionDropdownMenuSubTrigger

    Properties

    $$typeof +DropdownMenuSubTrigger | platform-bible-react

    FunctionDropdownMenuSubTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuTrigger.html b/platform-bible-react/functions/DropdownMenuTrigger.html index c46db9f458..cdce1e042f 100644 --- a/platform-bible-react/functions/DropdownMenuTrigger.html +++ b/platform-bible-react/functions/DropdownMenuTrigger.html @@ -1,4 +1,4 @@ -DropdownMenuTrigger | platform-bible-react

    FunctionDropdownMenuTrigger

    Properties

    $$typeof +DropdownMenuTrigger | platform-bible-react

    FunctionDropdownMenuTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/EnableButton.html b/platform-bible-react/functions/EnableButton.html index be891c5aaf..0b5ad7323c 100644 --- a/platform-bible-react/functions/EnableButton.html +++ b/platform-bible-react/functions/EnableButton.html @@ -1,4 +1,4 @@ EnableButton | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/FilterButton.html b/platform-bible-react/functions/FilterButton.html index f5a36257d3..6903243cb2 100644 --- a/platform-bible-react/functions/FilterButton.html +++ b/platform-bible-react/functions/FilterButton.html @@ -2,7 +2,7 @@ to be used with the dropdown menu. It uses forwardRef to pass the button to the dropdown trigger asChild.

    Properties

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/FilterDropdown.html b/platform-bible-react/functions/FilterDropdown.html index db1141d3f2..ce50ea5426 100644 --- a/platform-bible-react/functions/FilterDropdown.html +++ b/platform-bible-react/functions/FilterDropdown.html @@ -1,4 +1,4 @@ FilterDropdown | platform-bible-react

    FunctionFilterDropdown

    +
    diff --git a/platform-bible-react/functions/FilterableResourceList.html b/platform-bible-react/functions/FilterableResourceList.html index a43e86b7c7..e5ec734d0f 100644 --- a/platform-bible-react/functions/FilterableResourceList.html +++ b/platform-bible-react/functions/FilterableResourceList.html @@ -1 +1 @@ -FilterableResourceList | platform-bible-react

    FunctionFilterableResourceList

    +FilterableResourceList | platform-bible-react

    FunctionFilterableResourceList

    diff --git a/platform-bible-react/functions/Footer.html b/platform-bible-react/functions/Footer.html index 9b09bcf0e0..ac607b99c3 100644 --- a/platform-bible-react/functions/Footer.html +++ b/platform-bible-react/functions/Footer.html @@ -1,4 +1,4 @@ Footer | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index cb1cc1036c..616cc4ec0d 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react
    +GridMenu | platform-bible-react
    diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index 4eac078284..e882aed3fe 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    +HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index 4f6acd0e96..1f147ff283 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react
    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 5e707a74f8..369fb24f0e 100644 --- a/platform-bible-react/functions/Input.html +++ b/platform-bible-react/functions/Input.html @@ -1,4 +1,4 @@ -Input | platform-bible-react

    Properties

    $$typeof +Input | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/InstallButton.html b/platform-bible-react/functions/InstallButton.html index c890a18d1b..d0f42623e7 100644 --- a/platform-bible-react/functions/InstallButton.html +++ b/platform-bible-react/functions/InstallButton.html @@ -1,4 +1,4 @@ InstallButton | platform-bible-react

    FunctionInstallButton

    +
    diff --git a/platform-bible-react/functions/Inventory.html b/platform-bible-react/functions/Inventory.html index efbc91c3bb..e65ba7824e 100644 --- a/platform-bible-react/functions/Inventory.html +++ b/platform-bible-react/functions/Inventory.html @@ -1,2 +1,2 @@ Inventory | platform-bible-react
    +

    Parameters

    • __namedParameters: InventoryProps

    Returns Element

    diff --git a/platform-bible-react/functions/Label.html b/platform-bible-react/functions/Label.html index 39886219fc..f93ef1d2f5 100644 --- a/platform-bible-react/functions/Label.html +++ b/platform-bible-react/functions/Label.html @@ -1,4 +1,4 @@ -Label | platform-bible-react

    Properties

    $$typeof +Label | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/MarkdownRenderer.html b/platform-bible-react/functions/MarkdownRenderer.html index fcf0a1615c..fe3ef669fa 100644 --- a/platform-bible-react/functions/MarkdownRenderer.html +++ b/platform-bible-react/functions/MarkdownRenderer.html @@ -1,4 +1,4 @@ MarkdownRenderer | platform-bible-react

    FunctionMarkdownRenderer

    +
    diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 63546aa0c4..2138e9a0ec 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react
    +MenuItem | platform-bible-react
    diff --git a/platform-bible-react/functions/MoreInfo.html b/platform-bible-react/functions/MoreInfo.html index 484fe12f7a..2360456d81 100644 --- a/platform-bible-react/functions/MoreInfo.html +++ b/platform-bible-react/functions/MoreInfo.html @@ -4,4 +4,4 @@
  • Returns the more info component that displays the category, number of downloads, languages, and links to the website and support
  • -
    +
    diff --git a/platform-bible-react/functions/MultiSelectComboBox.html b/platform-bible-react/functions/MultiSelectComboBox.html index dcbbef47cc..138f879f7b 100644 --- a/platform-bible-react/functions/MultiSelectComboBox.html +++ b/platform-bible-react/functions/MultiSelectComboBox.html @@ -1 +1 @@ -MultiSelectComboBox | platform-bible-react

    FunctionMultiSelectComboBox

    +MultiSelectComboBox | platform-bible-react

    FunctionMultiSelectComboBox

    diff --git a/platform-bible-react/functions/NavigationContentSearch.html b/platform-bible-react/functions/NavigationContentSearch.html index 91f874d7a5..688f9242ab 100644 --- a/platform-bible-react/functions/NavigationContentSearch.html +++ b/platform-bible-react/functions/NavigationContentSearch.html @@ -1 +1 @@ -NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    +NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    diff --git a/platform-bible-react/functions/NoExtensionsFound.html b/platform-bible-react/functions/NoExtensionsFound.html index 46b0476ff3..6370b3f5f8 100644 --- a/platform-bible-react/functions/NoExtensionsFound.html +++ b/platform-bible-react/functions/NoExtensionsFound.html @@ -2,4 +2,4 @@

    Parameters

    • __namedParameters: NoExtensionsFoundProps

    Returns Element

    • Returns the message component that displays the message to the user.
    -
    +
    diff --git a/platform-bible-react/functions/RadioGroup.html b/platform-bible-react/functions/RadioGroup.html index 048b56b34a..7337dba839 100644 --- a/platform-bible-react/functions/RadioGroup.html +++ b/platform-bible-react/functions/RadioGroup.html @@ -1,4 +1,4 @@ -RadioGroup | platform-bible-react

    Properties

    $$typeof +RadioGroup | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/RadioGroupItem.html b/platform-bible-react/functions/RadioGroupItem.html index 9a761a33ba..8475b44afd 100644 --- a/platform-bible-react/functions/RadioGroupItem.html +++ b/platform-bible-react/functions/RadioGroupItem.html @@ -1,4 +1,4 @@ -RadioGroupItem | platform-bible-react

    FunctionRadioGroupItem

    Properties

    $$typeof +RadioGroupItem | platform-bible-react

    FunctionRadioGroupItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ScriptureResultsViewer.html b/platform-bible-react/functions/ScriptureResultsViewer.html index b2591e4452..aa989946ac 100644 --- a/platform-bible-react/functions/ScriptureResultsViewer.html +++ b/platform-bible-react/functions/ScriptureResultsViewer.html @@ -5,4 +5,4 @@ displays somewhat "tree-like" which allows it to be more horizontally compact and intuitive. But it also has the option of displaying as a traditional table with column headings (with or without the source column showing).

    -

    Parameters

    Returns Element

    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/ScrollGroupSelector.html b/platform-bible-react/functions/ScrollGroupSelector.html index af1fe058f1..e12236c0f8 100644 --- a/platform-bible-react/functions/ScrollGroupSelector.html +++ b/platform-bible-react/functions/ScrollGroupSelector.html @@ -1,2 +1,2 @@ ScrollGroupSelector | platform-bible-react

    FunctionScrollGroupSelector

    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index ae3812b8d1..bd64156cd9 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react
    +SearchBar | platform-bible-react
    diff --git a/platform-bible-react/functions/Select.html b/platform-bible-react/functions/Select.html index e7ea8a55b1..d8715a9433 100644 --- a/platform-bible-react/functions/Select.html +++ b/platform-bible-react/functions/Select.html @@ -1,5 +1,5 @@ Select | platform-bible-react

    Properties

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectContent.html b/platform-bible-react/functions/SelectContent.html index 341c7b5d65..d65f3cc665 100644 --- a/platform-bible-react/functions/SelectContent.html +++ b/platform-bible-react/functions/SelectContent.html @@ -1,4 +1,4 @@ -SelectContent | platform-bible-react

    FunctionSelectContent

    Properties

    $$typeof +SelectContent | platform-bible-react

    FunctionSelectContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectGroup.html b/platform-bible-react/functions/SelectGroup.html index bcdc6bc834..92e45ef0ba 100644 --- a/platform-bible-react/functions/SelectGroup.html +++ b/platform-bible-react/functions/SelectGroup.html @@ -1,4 +1,4 @@ -SelectGroup | platform-bible-react

    Properties

    $$typeof +SelectGroup | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectItem.html b/platform-bible-react/functions/SelectItem.html index 4bdb1ef917..30e45e0926 100644 --- a/platform-bible-react/functions/SelectItem.html +++ b/platform-bible-react/functions/SelectItem.html @@ -1,4 +1,4 @@ -SelectItem | platform-bible-react

    Properties

    $$typeof +SelectItem | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectLabel.html b/platform-bible-react/functions/SelectLabel.html index d36470faa9..99c4e6196e 100644 --- a/platform-bible-react/functions/SelectLabel.html +++ b/platform-bible-react/functions/SelectLabel.html @@ -1,4 +1,4 @@ -SelectLabel | platform-bible-react

    Properties

    $$typeof +SelectLabel | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollDownButton.html b/platform-bible-react/functions/SelectScrollDownButton.html index b108cf671d..7cdc5256f1 100644 --- a/platform-bible-react/functions/SelectScrollDownButton.html +++ b/platform-bible-react/functions/SelectScrollDownButton.html @@ -1,4 +1,4 @@ -SelectScrollDownButton | platform-bible-react

    FunctionSelectScrollDownButton

    Properties

    $$typeof +SelectScrollDownButton | platform-bible-react

    FunctionSelectScrollDownButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollUpButton.html b/platform-bible-react/functions/SelectScrollUpButton.html index 3f953ff525..1d47b6c1d1 100644 --- a/platform-bible-react/functions/SelectScrollUpButton.html +++ b/platform-bible-react/functions/SelectScrollUpButton.html @@ -1,4 +1,4 @@ -SelectScrollUpButton | platform-bible-react

    FunctionSelectScrollUpButton

    Properties

    $$typeof +SelectScrollUpButton | platform-bible-react

    FunctionSelectScrollUpButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectSeparator.html b/platform-bible-react/functions/SelectSeparator.html index 7aaf15cf6e..64f6ea52c8 100644 --- a/platform-bible-react/functions/SelectSeparator.html +++ b/platform-bible-react/functions/SelectSeparator.html @@ -1,4 +1,4 @@ -SelectSeparator | platform-bible-react

    FunctionSelectSeparator

    Properties

    $$typeof +SelectSeparator | platform-bible-react

    FunctionSelectSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectTrigger.html b/platform-bible-react/functions/SelectTrigger.html index 6c3f7889d6..d6e3195888 100644 --- a/platform-bible-react/functions/SelectTrigger.html +++ b/platform-bible-react/functions/SelectTrigger.html @@ -1,4 +1,4 @@ -SelectTrigger | platform-bible-react

    FunctionSelectTrigger

    Properties

    $$typeof +SelectTrigger | platform-bible-react

    FunctionSelectTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectValue.html b/platform-bible-react/functions/SelectValue.html index 04db773677..8c132fad70 100644 --- a/platform-bible-react/functions/SelectValue.html +++ b/platform-bible-react/functions/SelectValue.html @@ -1,4 +1,4 @@ -SelectValue | platform-bible-react

    Properties

    $$typeof +SelectValue | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Separator.html b/platform-bible-react/functions/Separator.html index 4f852ddc98..a45f01053a 100644 --- a/platform-bible-react/functions/Separator.html +++ b/platform-bible-react/functions/Separator.html @@ -1,4 +1,4 @@ -Separator | platform-bible-react

    Properties

    $$typeof +Separator | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SettingsList.html b/platform-bible-react/functions/SettingsList.html index 3c8213acae..f3200b19e4 100644 --- a/platform-bible-react/functions/SettingsList.html +++ b/platform-bible-react/functions/SettingsList.html @@ -1,4 +1,4 @@ SettingsList | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/SettingsListHeader.html b/platform-bible-react/functions/SettingsListHeader.html index f00e3942b1..d845b88e9a 100644 --- a/platform-bible-react/functions/SettingsListHeader.html +++ b/platform-bible-react/functions/SettingsListHeader.html @@ -1,3 +1,3 @@ SettingsListHeader | platform-bible-react

    FunctionSettingsListHeader

    +
    diff --git a/platform-bible-react/functions/SettingsListItem.html b/platform-bible-react/functions/SettingsListItem.html index 2e53df96a2..a0cf2e5092 100644 --- a/platform-bible-react/functions/SettingsListItem.html +++ b/platform-bible-react/functions/SettingsListItem.html @@ -1,3 +1,3 @@ SettingsListItem | platform-bible-react

    FunctionSettingsListItem

    +
    diff --git a/platform-bible-react/functions/SettingsSidebar.html b/platform-bible-react/functions/SettingsSidebar.html index 621785f2df..646e26f895 100644 --- a/platform-bible-react/functions/SettingsSidebar.html +++ b/platform-bible-react/functions/SettingsSidebar.html @@ -1 +1 @@ -SettingsSidebar | platform-bible-react

    FunctionSettingsSidebar

    +SettingsSidebar | platform-bible-react

    FunctionSettingsSidebar

    diff --git a/platform-bible-react/functions/SettingsSidebarContentSearch.html b/platform-bible-react/functions/SettingsSidebarContentSearch.html index f4de8dfef0..f5bd2c852f 100644 --- a/platform-bible-react/functions/SettingsSidebarContentSearch.html +++ b/platform-bible-react/functions/SettingsSidebarContentSearch.html @@ -1 +1 @@ -SettingsSidebarContentSearch | platform-bible-react

    FunctionSettingsSidebarContentSearch

    +SettingsSidebarContentSearch | platform-bible-react

    FunctionSettingsSidebarContentSearch

    diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 6c6893c9df..f2f57eb6fa 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ -Slider | platform-bible-react

    Properties

    $$typeof +Slider | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Sonner-1.html b/platform-bible-react/functions/Sonner-1.html index 7a18ef1984..9b96733a0a 100644 --- a/platform-bible-react/functions/Sonner-1.html +++ b/platform-bible-react/functions/Sonner-1.html @@ -1 +1 @@ -Sonner | platform-bible-react
    +Sonner | platform-bible-react
    diff --git a/platform-bible-react/functions/Spinner.html b/platform-bible-react/functions/Spinner.html index 4cd6f9ae6b..9c8ed96592 100644 --- a/platform-bible-react/functions/Spinner.html +++ b/platform-bible-react/functions/Spinner.html @@ -1,4 +1,4 @@ -Spinner | platform-bible-react

    Properties

    $$typeof +Spinner | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 481f7ddb20..84a553e77c 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ -Switch | platform-bible-react

    Properties

    $$typeof +Switch | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index 64b8135e3d..a2a12eb0a7 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ -Table | platform-bible-react

    Properties

    $$typeof +Table | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableBody.html b/platform-bible-react/functions/TableBody.html index 8e9cd7ea27..af679a178c 100644 --- a/platform-bible-react/functions/TableBody.html +++ b/platform-bible-react/functions/TableBody.html @@ -1,4 +1,4 @@ -TableBody | platform-bible-react

    Properties

    $$typeof +TableBody | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCaption.html b/platform-bible-react/functions/TableCaption.html index 0e2c7d481e..f7559e1a4b 100644 --- a/platform-bible-react/functions/TableCaption.html +++ b/platform-bible-react/functions/TableCaption.html @@ -1,4 +1,4 @@ -TableCaption | platform-bible-react

    Properties

    $$typeof +TableCaption | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCell.html b/platform-bible-react/functions/TableCell.html index ac7ae09269..7455e72739 100644 --- a/platform-bible-react/functions/TableCell.html +++ b/platform-bible-react/functions/TableCell.html @@ -1,4 +1,4 @@ -TableCell | platform-bible-react

    Properties

    $$typeof +TableCell | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableFooter.html b/platform-bible-react/functions/TableFooter.html index dac9fe05af..55a21672ee 100644 --- a/platform-bible-react/functions/TableFooter.html +++ b/platform-bible-react/functions/TableFooter.html @@ -1,4 +1,4 @@ -TableFooter | platform-bible-react

    Properties

    $$typeof +TableFooter | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHead.html b/platform-bible-react/functions/TableHead.html index 9a4cd72cf9..ee2f0ff710 100644 --- a/platform-bible-react/functions/TableHead.html +++ b/platform-bible-react/functions/TableHead.html @@ -1,4 +1,4 @@ -TableHead | platform-bible-react

    Properties

    $$typeof +TableHead | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHeader.html b/platform-bible-react/functions/TableHeader.html index 6e155e4c01..0ab84557a7 100644 --- a/platform-bible-react/functions/TableHeader.html +++ b/platform-bible-react/functions/TableHeader.html @@ -1,4 +1,4 @@ -TableHeader | platform-bible-react

    Properties

    $$typeof +TableHeader | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableRow.html b/platform-bible-react/functions/TableRow.html index 1347f6d55e..8adcc13905 100644 --- a/platform-bible-react/functions/TableRow.html +++ b/platform-bible-react/functions/TableRow.html @@ -1,4 +1,4 @@ -TableRow | platform-bible-react

    Properties

    $$typeof +TableRow | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Tabs.html b/platform-bible-react/functions/Tabs.html index c6f010b5db..9b4d5cab93 100644 --- a/platform-bible-react/functions/Tabs.html +++ b/platform-bible-react/functions/Tabs.html @@ -1,4 +1,4 @@ -Tabs | platform-bible-react

    Properties

    $$typeof +Tabs | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsContent.html b/platform-bible-react/functions/TabsContent.html index 7d6cee76ab..7a5c190d35 100644 --- a/platform-bible-react/functions/TabsContent.html +++ b/platform-bible-react/functions/TabsContent.html @@ -1,4 +1,4 @@ -TabsContent | platform-bible-react

    Properties

    $$typeof +TabsContent | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsList.html b/platform-bible-react/functions/TabsList.html index 3b4f62cc1d..5c97afeb11 100644 --- a/platform-bible-react/functions/TabsList.html +++ b/platform-bible-react/functions/TabsList.html @@ -1,4 +1,4 @@ -TabsList | platform-bible-react

    Properties

    $$typeof +TabsList | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsTrigger.html b/platform-bible-react/functions/TabsTrigger.html index b0f630c1a3..92c3c2d060 100644 --- a/platform-bible-react/functions/TabsTrigger.html +++ b/platform-bible-react/functions/TabsTrigger.html @@ -1,4 +1,4 @@ -TabsTrigger | platform-bible-react

    Properties

    $$typeof +TabsTrigger | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index 72a3716c43..d1d592243f 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react
    +

    Parameters

    Returns Element

    diff --git a/platform-bible-react/functions/ToggleGroup.html b/platform-bible-react/functions/ToggleGroup.html index 18c017d1d2..2a740f0fdc 100644 --- a/platform-bible-react/functions/ToggleGroup.html +++ b/platform-bible-react/functions/ToggleGroup.html @@ -1,4 +1,4 @@ -ToggleGroup | platform-bible-react

    Properties

    $$typeof +ToggleGroup | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ToggleGroupItem.html b/platform-bible-react/functions/ToggleGroupItem.html index 6f61e6e1d9..5b2284e7d6 100644 --- a/platform-bible-react/functions/ToggleGroupItem.html +++ b/platform-bible-react/functions/ToggleGroupItem.html @@ -1,4 +1,4 @@ -ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • Parameters

      • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLButtonElement>

      Returns ReactNode

    Properties

    $$typeof +ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • Parameters

      • props: Omit<ToggleGroupItemProps & RefAttributes<HTMLButtonElement>, "ref"> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; outline: string; }; size: { default: string; sm: string; lg: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLButtonElement>

      Returns ReactNode

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Toolbar.html b/platform-bible-react/functions/Toolbar.html index 8fbc59f6cd..df7e9afc3a 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react
    +Toolbar | platform-bible-react
    diff --git a/platform-bible-react/functions/UiLanguageSelector.html b/platform-bible-react/functions/UiLanguageSelector.html index 724a50c7bb..281d8856dc 100644 --- a/platform-bible-react/functions/UiLanguageSelector.html +++ b/platform-bible-react/functions/UiLanguageSelector.html @@ -1 +1 @@ -UiLanguageSelector | platform-bible-react

    FunctionUiLanguageSelector

    +UiLanguageSelector | platform-bible-react

    FunctionUiLanguageSelector

    diff --git a/platform-bible-react/functions/UpdateButton.html b/platform-bible-react/functions/UpdateButton.html index 24943a6139..d0f2e924fa 100644 --- a/platform-bible-react/functions/UpdateButton.html +++ b/platform-bible-react/functions/UpdateButton.html @@ -1,4 +1,4 @@ UpdateButton | platform-bible-react
    +
    diff --git a/platform-bible-react/functions/VersionHistory.html b/platform-bible-react/functions/VersionHistory.html index 63cf6e0c31..44dea18d6f 100644 --- a/platform-bible-react/functions/VersionHistory.html +++ b/platform-bible-react/functions/VersionHistory.html @@ -1,4 +1,4 @@ VersionHistory | platform-bible-react

    FunctionVersionHistory

    +
    diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index 996eb7025a..86bb9291c7 100644 --- a/platform-bible-react/functions/VerticalTabs.html +++ b/platform-bible-react/functions/VerticalTabs.html @@ -1,4 +1,4 @@ -VerticalTabs | platform-bible-react

    Properties

    $$typeof +VerticalTabs | platform-bible-react

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsContent.html b/platform-bible-react/functions/VerticalTabsContent.html index 414b95d9c4..a3302b7a6f 100644 --- a/platform-bible-react/functions/VerticalTabsContent.html +++ b/platform-bible-react/functions/VerticalTabsContent.html @@ -1,4 +1,4 @@ -VerticalTabsContent | platform-bible-react

    FunctionVerticalTabsContent

    Properties

    $$typeof +VerticalTabsContent | platform-bible-react

    FunctionVerticalTabsContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsList.html b/platform-bible-react/functions/VerticalTabsList.html index 0448f8507e..8adac5a4bf 100644 --- a/platform-bible-react/functions/VerticalTabsList.html +++ b/platform-bible-react/functions/VerticalTabsList.html @@ -1,4 +1,4 @@ -VerticalTabsList | platform-bible-react

    FunctionVerticalTabsList

    Properties

    $$typeof +VerticalTabsList | platform-bible-react

    FunctionVerticalTabsList

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsTrigger.html b/platform-bible-react/functions/VerticalTabsTrigger.html index 914648917b..3680e3c5b5 100644 --- a/platform-bible-react/functions/VerticalTabsTrigger.html +++ b/platform-bible-react/functions/VerticalTabsTrigger.html @@ -1,4 +1,4 @@ -VerticalTabsTrigger | platform-bible-react

    FunctionVerticalTabsTrigger

    Properties

    $$typeof +VerticalTabsTrigger | platform-bible-react

    FunctionVerticalTabsTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/badgeVariants.html b/platform-bible-react/functions/badgeVariants.html index 11e177441c..ec9aee3059 100644 --- a/platform-bible-react/functions/badgeVariants.html +++ b/platform-bible-react/functions/badgeVariants.html @@ -1 +1 @@ -badgeVariants | platform-bible-react

    FunctionbadgeVariants

    +badgeVariants | platform-bible-react

    FunctionbadgeVariants

    diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index fdd544f00d..3d6153f355 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • Parameters

      • Optionalprops: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

      Returns string

    +buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • Parameters

      • Optionalprops: ConfigVariants<{ variant: { default: string; destructive: string; outline: string; secondary: string; ghost: string; link: string; }; size: { default: string; sm: string; lg: string; icon: string; }; }> & ClassProp

      Returns string

    diff --git a/platform-bible-react/functions/cn.html b/platform-bible-react/functions/cn.html index ef0b2e771a..d26046afb3 100644 --- a/platform-bible-react/functions/cn.html +++ b/platform-bible-react/functions/cn.html @@ -29,4 +29,4 @@ therefore it was not applied
  • Notice that 'some-class' was applied. This function is not limited only to Tailwind classes.
  • -
    +
    diff --git a/platform-bible-react/functions/getBookNumFromId.html b/platform-bible-react/functions/getBookNumFromId.html index 97fd9de8e8..d3c26e4cae 100644 --- a/platform-bible-react/functions/getBookNumFromId.html +++ b/platform-bible-react/functions/getBookNumFromId.html @@ -2,4 +2,4 @@
    +
    diff --git a/platform-bible-react/functions/getLinesFromUSFM.html b/platform-bible-react/functions/getLinesFromUSFM.html index c69a4ead39..46bab970ba 100644 --- a/platform-bible-react/functions/getLinesFromUSFM.html +++ b/platform-bible-react/functions/getLinesFromUSFM.html @@ -1,4 +1,4 @@ getLinesFromUSFM | platform-bible-react

    FunctiongetLinesFromUSFM

    Splits USFM string into shorter line-like segments

    +
    diff --git a/platform-bible-react/functions/getNumberFromUSFM.html b/platform-bible-react/functions/getNumberFromUSFM.html index 58c6958ab6..36a6e95e96 100644 --- a/platform-bible-react/functions/getNumberFromUSFM.html +++ b/platform-bible-react/functions/getNumberFromUSFM.html @@ -1,4 +1,4 @@ getNumberFromUSFM | platform-bible-react

    FunctiongetNumberFromUSFM

    Extracts chapter or verse number from USFM strings that start with a \c or \v marker

    +
    diff --git a/platform-bible-react/functions/getStatusForItem.html b/platform-bible-react/functions/getStatusForItem.html index 71582ba36c..bb7ebe68af 100644 --- a/platform-bible-react/functions/getStatusForItem.html +++ b/platform-bible-react/functions/getStatusForItem.html @@ -3,4 +3,4 @@
  • approvedItems: string[]

    Array of approved items, typically as defined in Settings.xml

  • unapprovedItems: string[]

    Array of unapproved items, typically as defined in Settings.xml

  • Returns Status

    The status for the specified item

    -
    +
    diff --git a/platform-bible-react/functions/inventoryCountColumn.html b/platform-bible-react/functions/inventoryCountColumn.html index 94bbbd7353..73aac0958e 100644 --- a/platform-bible-react/functions/inventoryCountColumn.html +++ b/platform-bible-react/functions/inventoryCountColumn.html @@ -1,4 +1,4 @@ inventoryCountColumn | platform-bible-react

    FunctioninventoryCountColumn

    Function that creates the count column for inventories. Should be used with the DataTable component.

    +
    diff --git a/platform-bible-react/functions/inventoryItemColumn.html b/platform-bible-react/functions/inventoryItemColumn.html index 8737c578d7..8259689ce6 100644 --- a/platform-bible-react/functions/inventoryItemColumn.html +++ b/platform-bible-react/functions/inventoryItemColumn.html @@ -1,4 +1,4 @@ inventoryItemColumn | platform-bible-react

    FunctioninventoryItemColumn

    Function that creates the item column for inventories

    +
    diff --git a/platform-bible-react/functions/inventoryStatusColumn.html b/platform-bible-react/functions/inventoryStatusColumn.html index e623422f8b..dca87c6d54 100644 --- a/platform-bible-react/functions/inventoryStatusColumn.html +++ b/platform-bible-react/functions/inventoryStatusColumn.html @@ -7,4 +7,4 @@
  • onUnapprovedItemsChange: ((items: string[]) => void)

    Callback function that stores the updated list of unapproved items

      • (items): void
      • Parameters

        • items: string[]

        Returns void

  • Returns ColumnDef<InventoryTableData>

    Column that shows the status buttons for the related inventory item. The button for the current status of the item is selected

    -
    +
    diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index ac69f892c7..c17f8c2bbf 100644 --- a/platform-bible-react/functions/useEvent.html +++ b/platform-bible-react/functions/useEvent.html @@ -9,4 +9,4 @@
  • eventHandler: PlatformEventHandler<T>

    The callback to run when the event is emitted

    WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

    -
  • Returns void

    +

    Returns void

    diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index 126b64feec..aad9853b6d 100644 --- a/platform-bible-react/functions/useEventAsync.html +++ b/platform-bible-react/functions/useEventAsync.html @@ -10,4 +10,4 @@
  • eventHandler: PlatformEventHandler<T>

    The callback to run when the event is emitted

    WARNING: MUST BE STABLE - const or wrapped in useCallback. The reference must not be updated every render

    -
  • Returns void

    +

    Returns void

    diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index db52f4d5ae..0b70624ba5 100644 --- a/platform-bible-react/functions/usePromise.html +++ b/platform-bible-react/functions/usePromise.html @@ -21,4 +21,4 @@
  • value: the current value for the promise, either the defaultValue or the resolved promise value
  • isLoading: whether the promise is waiting to be resolved
  • -
    +
    diff --git a/platform-bible-react/interfaces/BadgeProps.html b/platform-bible-react/interfaces/BadgeProps.html index dea91def86..82625507ca 100644 --- a/platform-bible-react/interfaces/BadgeProps.html +++ b/platform-bible-react/interfaces/BadgeProps.html @@ -1,4 +1,4 @@ -BadgeProps | platform-bible-react

    InterfaceBadgeProps

    interface BadgeProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLDivElement>;
        onAbortCapture?: ReactEventHandler<HTMLDivElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLDivElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLDivElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>;
        onAnimationStart?: AnimationEventHandler<HTMLDivElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>;
        onAuxClick?: MouseEventHandler<HTMLDivElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLDivElement>;
        onBeforeInput?: FormEventHandler<HTMLDivElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLDivElement>;
        onBlur?: FocusEventHandler<HTMLDivElement>;
        onBlurCapture?: FocusEventHandler<HTMLDivElement>;
        onCanPlay?: ReactEventHandler<HTMLDivElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLDivElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLDivElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>;
        onChange?: FormEventHandler<HTMLDivElement>;
        onChangeCapture?: FormEventHandler<HTMLDivElement>;
        onClick?: MouseEventHandler<HTMLDivElement>;
        onClickCapture?: MouseEventHandler<HTMLDivElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLDivElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>;
        onCompositionStart?: CompositionEventHandler<HTMLDivElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>;
        onContextMenu?: MouseEventHandler<HTMLDivElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLDivElement>;
        onCopy?: ClipboardEventHandler<HTMLDivElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLDivElement>;
        onCut?: ClipboardEventHandler<HTMLDivElement>;
        onCutCapture?: ClipboardEventHandler<HTMLDivElement>;
        onDoubleClick?: MouseEventHandler<HTMLDivElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>;
        onDrag?: DragEventHandler<HTMLDivElement>;
        onDragCapture?: DragEventHandler<HTMLDivElement>;
        onDragEnd?: DragEventHandler<HTMLDivElement>;
        onDragEndCapture?: DragEventHandler<HTMLDivElement>;
        onDragEnter?: DragEventHandler<HTMLDivElement>;
        onDragEnterCapture?: DragEventHandler<HTMLDivElement>;
        onDragExit?: DragEventHandler<HTMLDivElement>;
        onDragExitCapture?: DragEventHandler<HTMLDivElement>;
        onDragLeave?: DragEventHandler<HTMLDivElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLDivElement>;
        onDragOver?: DragEventHandler<HTMLDivElement>;
        onDragOverCapture?: DragEventHandler<HTMLDivElement>;
        onDragStart?: DragEventHandler<HTMLDivElement>;
        onDragStartCapture?: DragEventHandler<HTMLDivElement>;
        onDrop?: DragEventHandler<HTMLDivElement>;
        onDropCapture?: DragEventHandler<HTMLDivElement>;
        onDurationChange?: ReactEventHandler<HTMLDivElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onEmptied?: ReactEventHandler<HTMLDivElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLDivElement>;
        onEncrypted?: ReactEventHandler<HTMLDivElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLDivElement>;
        onEnded?: ReactEventHandler<HTMLDivElement>;
        onEndedCapture?: ReactEventHandler<HTMLDivElement>;
        onError?: ReactEventHandler<HTMLDivElement>;
        onErrorCapture?: ReactEventHandler<HTMLDivElement>;
        onFocus?: FocusEventHandler<HTMLDivElement>;
        onFocusCapture?: FocusEventHandler<HTMLDivElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLDivElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
        onInput?: FormEventHandler<HTMLDivElement>;
        onInputCapture?: FormEventHandler<HTMLDivElement>;
        onInvalid?: FormEventHandler<HTMLDivElement>;
        onInvalidCapture?: FormEventHandler<HTMLDivElement>;
        onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>;
        onKeyPress?: KeyboardEventHandler<HTMLDivElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>;
        onKeyUp?: KeyboardEventHandler<HTMLDivElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>;
        onLoad?: ReactEventHandler<HTMLDivElement>;
        onLoadCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadedData?: ReactEventHandler<HTMLDivElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLDivElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadStart?: ReactEventHandler<HTMLDivElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLDivElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLDivElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
        onMouseDown?: MouseEventHandler<HTMLDivElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseEnter?: MouseEventHandler<HTMLDivElement>;
        onMouseLeave?: MouseEventHandler<HTMLDivElement>;
        onMouseMove?: MouseEventHandler<HTMLDivElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseOut?: MouseEventHandler<HTMLDivElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseOver?: MouseEventHandler<HTMLDivElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseUp?: MouseEventHandler<HTMLDivElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLDivElement>;
        onPaste?: ClipboardEventHandler<HTMLDivElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLDivElement>;
        onPause?: ReactEventHandler<HTMLDivElement>;
        onPauseCapture?: ReactEventHandler<HTMLDivElement>;
        onPlay?: ReactEventHandler<HTMLDivElement>;
        onPlayCapture?: ReactEventHandler<HTMLDivElement>;
        onPlaying?: ReactEventHandler<HTMLDivElement>;
        onPlayingCapture?: ReactEventHandler<HTMLDivElement>;
        onPointerCancel?: PointerEventHandler<HTMLDivElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerDown?: PointerEventHandler<HTMLDivElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerEnter?: PointerEventHandler<HTMLDivElement>;
        onPointerLeave?: PointerEventHandler<HTMLDivElement>;
        onPointerMove?: PointerEventHandler<HTMLDivElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerOut?: PointerEventHandler<HTMLDivElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerOver?: PointerEventHandler<HTMLDivElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerUp?: PointerEventHandler<HTMLDivElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLDivElement>;
        onProgress?: ReactEventHandler<HTMLDivElement>;
        onProgressCapture?: ReactEventHandler<HTMLDivElement>;
        onRateChange?: ReactEventHandler<HTMLDivElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onReset?: FormEventHandler<HTMLDivElement>;
        onResetCapture?: FormEventHandler<HTMLDivElement>;
        onResize?: ReactEventHandler<HTMLDivElement>;
        onResizeCapture?: ReactEventHandler<HTMLDivElement>;
        onScroll?: UIEventHandler<HTMLDivElement>;
        onScrollCapture?: UIEventHandler<HTMLDivElement>;
        onSeeked?: ReactEventHandler<HTMLDivElement>;
        onSeekedCapture?: ReactEventHandler<HTMLDivElement>;
        onSeeking?: ReactEventHandler<HTMLDivElement>;
        onSeekingCapture?: ReactEventHandler<HTMLDivElement>;
        onSelect?: ReactEventHandler<HTMLDivElement>;
        onSelectCapture?: ReactEventHandler<HTMLDivElement>;
        onStalled?: ReactEventHandler<HTMLDivElement>;
        onStalledCapture?: ReactEventHandler<HTMLDivElement>;
        onSubmit?: FormEventHandler<HTMLDivElement>;
        onSubmitCapture?: FormEventHandler<HTMLDivElement>;
        onSuspend?: ReactEventHandler<HTMLDivElement>;
        onSuspendCapture?: ReactEventHandler<HTMLDivElement>;
        onTimeUpdate?: ReactEventHandler<HTMLDivElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>;
        onTouchCancel?: TouchEventHandler<HTMLDivElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchEnd?: TouchEventHandler<HTMLDivElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchMove?: TouchEventHandler<HTMLDivElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchStart?: TouchEventHandler<HTMLDivElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLDivElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLDivElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>;
        onVolumeChange?: ReactEventHandler<HTMLDivElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onWaiting?: ReactEventHandler<HTMLDivElement>;
        onWaitingCapture?: ReactEventHandler<HTMLDivElement>;
        onWheel?: WheelEventHandler<HTMLDivElement>;
        onWheelCapture?: WheelEventHandler<HTMLDivElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        typeof?: string;
        unselectable?: "off" | "on";
        variant?:
            | null
            | "default"
            | "outline"
            | "muted"
            | "destructive"
            | "secondary";
        vocab?: string;
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
    • VariantProps<typeof badgeVariants>
      • BadgeProps

    Properties

    about? +BadgeProps | platform-bible-react

    InterfaceBadgeProps

    interface BadgeProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLDivElement>;
        onAbortCapture?: ReactEventHandler<HTMLDivElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLDivElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLDivElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>;
        onAnimationStart?: AnimationEventHandler<HTMLDivElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>;
        onAuxClick?: MouseEventHandler<HTMLDivElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLDivElement>;
        onBeforeInput?: FormEventHandler<HTMLDivElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLDivElement>;
        onBlur?: FocusEventHandler<HTMLDivElement>;
        onBlurCapture?: FocusEventHandler<HTMLDivElement>;
        onCanPlay?: ReactEventHandler<HTMLDivElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLDivElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLDivElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>;
        onChange?: FormEventHandler<HTMLDivElement>;
        onChangeCapture?: FormEventHandler<HTMLDivElement>;
        onClick?: MouseEventHandler<HTMLDivElement>;
        onClickCapture?: MouseEventHandler<HTMLDivElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLDivElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>;
        onCompositionStart?: CompositionEventHandler<HTMLDivElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>;
        onContextMenu?: MouseEventHandler<HTMLDivElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLDivElement>;
        onCopy?: ClipboardEventHandler<HTMLDivElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLDivElement>;
        onCut?: ClipboardEventHandler<HTMLDivElement>;
        onCutCapture?: ClipboardEventHandler<HTMLDivElement>;
        onDoubleClick?: MouseEventHandler<HTMLDivElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>;
        onDrag?: DragEventHandler<HTMLDivElement>;
        onDragCapture?: DragEventHandler<HTMLDivElement>;
        onDragEnd?: DragEventHandler<HTMLDivElement>;
        onDragEndCapture?: DragEventHandler<HTMLDivElement>;
        onDragEnter?: DragEventHandler<HTMLDivElement>;
        onDragEnterCapture?: DragEventHandler<HTMLDivElement>;
        onDragExit?: DragEventHandler<HTMLDivElement>;
        onDragExitCapture?: DragEventHandler<HTMLDivElement>;
        onDragLeave?: DragEventHandler<HTMLDivElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLDivElement>;
        onDragOver?: DragEventHandler<HTMLDivElement>;
        onDragOverCapture?: DragEventHandler<HTMLDivElement>;
        onDragStart?: DragEventHandler<HTMLDivElement>;
        onDragStartCapture?: DragEventHandler<HTMLDivElement>;
        onDrop?: DragEventHandler<HTMLDivElement>;
        onDropCapture?: DragEventHandler<HTMLDivElement>;
        onDurationChange?: ReactEventHandler<HTMLDivElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onEmptied?: ReactEventHandler<HTMLDivElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLDivElement>;
        onEncrypted?: ReactEventHandler<HTMLDivElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLDivElement>;
        onEnded?: ReactEventHandler<HTMLDivElement>;
        onEndedCapture?: ReactEventHandler<HTMLDivElement>;
        onError?: ReactEventHandler<HTMLDivElement>;
        onErrorCapture?: ReactEventHandler<HTMLDivElement>;
        onFocus?: FocusEventHandler<HTMLDivElement>;
        onFocusCapture?: FocusEventHandler<HTMLDivElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLDivElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
        onInput?: FormEventHandler<HTMLDivElement>;
        onInputCapture?: FormEventHandler<HTMLDivElement>;
        onInvalid?: FormEventHandler<HTMLDivElement>;
        onInvalidCapture?: FormEventHandler<HTMLDivElement>;
        onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>;
        onKeyPress?: KeyboardEventHandler<HTMLDivElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>;
        onKeyUp?: KeyboardEventHandler<HTMLDivElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>;
        onLoad?: ReactEventHandler<HTMLDivElement>;
        onLoadCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadedData?: ReactEventHandler<HTMLDivElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLDivElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>;
        onLoadStart?: ReactEventHandler<HTMLDivElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLDivElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLDivElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
        onMouseDown?: MouseEventHandler<HTMLDivElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseEnter?: MouseEventHandler<HTMLDivElement>;
        onMouseLeave?: MouseEventHandler<HTMLDivElement>;
        onMouseMove?: MouseEventHandler<HTMLDivElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseOut?: MouseEventHandler<HTMLDivElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseOver?: MouseEventHandler<HTMLDivElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLDivElement>;
        onMouseUp?: MouseEventHandler<HTMLDivElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLDivElement>;
        onPaste?: ClipboardEventHandler<HTMLDivElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLDivElement>;
        onPause?: ReactEventHandler<HTMLDivElement>;
        onPauseCapture?: ReactEventHandler<HTMLDivElement>;
        onPlay?: ReactEventHandler<HTMLDivElement>;
        onPlayCapture?: ReactEventHandler<HTMLDivElement>;
        onPlaying?: ReactEventHandler<HTMLDivElement>;
        onPlayingCapture?: ReactEventHandler<HTMLDivElement>;
        onPointerCancel?: PointerEventHandler<HTMLDivElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerDown?: PointerEventHandler<HTMLDivElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerEnter?: PointerEventHandler<HTMLDivElement>;
        onPointerLeave?: PointerEventHandler<HTMLDivElement>;
        onPointerMove?: PointerEventHandler<HTMLDivElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerOut?: PointerEventHandler<HTMLDivElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerOver?: PointerEventHandler<HTMLDivElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLDivElement>;
        onPointerUp?: PointerEventHandler<HTMLDivElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLDivElement>;
        onProgress?: ReactEventHandler<HTMLDivElement>;
        onProgressCapture?: ReactEventHandler<HTMLDivElement>;
        onRateChange?: ReactEventHandler<HTMLDivElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onReset?: FormEventHandler<HTMLDivElement>;
        onResetCapture?: FormEventHandler<HTMLDivElement>;
        onResize?: ReactEventHandler<HTMLDivElement>;
        onResizeCapture?: ReactEventHandler<HTMLDivElement>;
        onScroll?: UIEventHandler<HTMLDivElement>;
        onScrollCapture?: UIEventHandler<HTMLDivElement>;
        onSeeked?: ReactEventHandler<HTMLDivElement>;
        onSeekedCapture?: ReactEventHandler<HTMLDivElement>;
        onSeeking?: ReactEventHandler<HTMLDivElement>;
        onSeekingCapture?: ReactEventHandler<HTMLDivElement>;
        onSelect?: ReactEventHandler<HTMLDivElement>;
        onSelectCapture?: ReactEventHandler<HTMLDivElement>;
        onStalled?: ReactEventHandler<HTMLDivElement>;
        onStalledCapture?: ReactEventHandler<HTMLDivElement>;
        onSubmit?: FormEventHandler<HTMLDivElement>;
        onSubmitCapture?: FormEventHandler<HTMLDivElement>;
        onSuspend?: ReactEventHandler<HTMLDivElement>;
        onSuspendCapture?: ReactEventHandler<HTMLDivElement>;
        onTimeUpdate?: ReactEventHandler<HTMLDivElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>;
        onTouchCancel?: TouchEventHandler<HTMLDivElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchEnd?: TouchEventHandler<HTMLDivElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchMove?: TouchEventHandler<HTMLDivElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>;
        onTouchStart?: TouchEventHandler<HTMLDivElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLDivElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLDivElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>;
        onVolumeChange?: ReactEventHandler<HTMLDivElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>;
        onWaiting?: ReactEventHandler<HTMLDivElement>;
        onWaitingCapture?: ReactEventHandler<HTMLDivElement>;
        onWheel?: WheelEventHandler<HTMLDivElement>;
        onWheelCapture?: WheelEventHandler<HTMLDivElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        typeof?: string;
        unselectable?: "off" | "on";
        variant?:
            | null
            | "default"
            | "outline"
            | "muted"
            | "destructive"
            | "secondary";
        vocab?: string;
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
    • VariantProps<typeof badgeVariants>
      • BadgeProps

    Properties

    itemID?: string
    itemProp?: string
    itemRef?: string
    itemScope?: boolean
    itemType?: string
    lang?: string
    nonce?: string
    onAbort?: ReactEventHandler<HTMLDivElement>
    onAbortCapture?: ReactEventHandler<HTMLDivElement>
    onAnimationEnd?: AnimationEventHandler<HTMLDivElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>
    onAnimationIteration?: AnimationEventHandler<HTMLDivElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>
    onAnimationStart?: AnimationEventHandler<HTMLDivElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>
    onAuxClick?: MouseEventHandler<HTMLDivElement>
    onAuxClickCapture?: MouseEventHandler<HTMLDivElement>
    onBeforeInput?: FormEventHandler<HTMLDivElement>
    onBeforeInputCapture?: FormEventHandler<HTMLDivElement>
    onBlur?: FocusEventHandler<HTMLDivElement>
    onBlurCapture?: FocusEventHandler<HTMLDivElement>
    onCanPlay?: ReactEventHandler<HTMLDivElement>
    onCanPlayCapture?: ReactEventHandler<HTMLDivElement>
    onCanPlayThrough?: ReactEventHandler<HTMLDivElement>
    onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>
    onChange?: FormEventHandler<HTMLDivElement>
    onChangeCapture?: FormEventHandler<HTMLDivElement>
    onClick?: MouseEventHandler<HTMLDivElement>
    onClickCapture?: MouseEventHandler<HTMLDivElement>
    onCompositionEnd?: CompositionEventHandler<HTMLDivElement>
    onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>
    onCompositionStart?: CompositionEventHandler<HTMLDivElement>
    onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>
    onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>
    onContextMenu?: MouseEventHandler<HTMLDivElement>
    onContextMenuCapture?: MouseEventHandler<HTMLDivElement>
    onCopy?: ClipboardEventHandler<HTMLDivElement>
    onCopyCapture?: ClipboardEventHandler<HTMLDivElement>
    onCut?: ClipboardEventHandler<HTMLDivElement>
    onCutCapture?: ClipboardEventHandler<HTMLDivElement>
    onDoubleClick?: MouseEventHandler<HTMLDivElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>
    onDrag?: DragEventHandler<HTMLDivElement>
    onDragCapture?: DragEventHandler<HTMLDivElement>
    onDragEnd?: DragEventHandler<HTMLDivElement>
    onDragEndCapture?: DragEventHandler<HTMLDivElement>
    onDragEnter?: DragEventHandler<HTMLDivElement>
    onDragEnterCapture?: DragEventHandler<HTMLDivElement>
    onDragExit?: DragEventHandler<HTMLDivElement>
    onDragExitCapture?: DragEventHandler<HTMLDivElement>
    onDragLeave?: DragEventHandler<HTMLDivElement>
    onDragLeaveCapture?: DragEventHandler<HTMLDivElement>
    onDragOver?: DragEventHandler<HTMLDivElement>
    onDragOverCapture?: DragEventHandler<HTMLDivElement>
    onDragStart?: DragEventHandler<HTMLDivElement>
    onDragStartCapture?: DragEventHandler<HTMLDivElement>
    onDrop?: DragEventHandler<HTMLDivElement>
    onDropCapture?: DragEventHandler<HTMLDivElement>
    onDurationChange?: ReactEventHandler<HTMLDivElement>
    onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>
    onEmptied?: ReactEventHandler<HTMLDivElement>
    onEmptiedCapture?: ReactEventHandler<HTMLDivElement>
    onEncrypted?: ReactEventHandler<HTMLDivElement>
    onEncryptedCapture?: ReactEventHandler<HTMLDivElement>
    onEnded?: ReactEventHandler<HTMLDivElement>
    onEndedCapture?: ReactEventHandler<HTMLDivElement>
    onError?: ReactEventHandler<HTMLDivElement>
    onErrorCapture?: ReactEventHandler<HTMLDivElement>
    onFocus?: FocusEventHandler<HTMLDivElement>
    onFocusCapture?: FocusEventHandler<HTMLDivElement>
    onGotPointerCapture?: PointerEventHandler<HTMLDivElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
    onInput?: FormEventHandler<HTMLDivElement>
    onInputCapture?: FormEventHandler<HTMLDivElement>
    onInvalid?: FormEventHandler<HTMLDivElement>
    onInvalidCapture?: FormEventHandler<HTMLDivElement>
    onKeyDown?: KeyboardEventHandler<HTMLDivElement>
    onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>
    onKeyPress?: KeyboardEventHandler<HTMLDivElement>

    Use onKeyUp or onKeyDown instead

    onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>

    Use onKeyUpCapture or onKeyDownCapture instead

    -
    onKeyUp?: KeyboardEventHandler<HTMLDivElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>
    onLoad?: ReactEventHandler<HTMLDivElement>
    onLoadCapture?: ReactEventHandler<HTMLDivElement>
    onLoadedData?: ReactEventHandler<HTMLDivElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>
    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>
    onLoadStart?: ReactEventHandler<HTMLDivElement>
    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>
    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
    onMouseDown?: MouseEventHandler<HTMLDivElement>
    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>
    onMouseEnter?: MouseEventHandler<HTMLDivElement>
    onMouseLeave?: MouseEventHandler<HTMLDivElement>
    onMouseMove?: MouseEventHandler<HTMLDivElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>
    onMouseOut?: MouseEventHandler<HTMLDivElement>
    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>
    onMouseOver?: MouseEventHandler<HTMLDivElement>
    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>
    onMouseUp?: MouseEventHandler<HTMLDivElement>
    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>
    onPaste?: ClipboardEventHandler<HTMLDivElement>
    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>
    onPause?: ReactEventHandler<HTMLDivElement>
    onPauseCapture?: ReactEventHandler<HTMLDivElement>
    onPlay?: ReactEventHandler<HTMLDivElement>
    onPlayCapture?: ReactEventHandler<HTMLDivElement>
    onPlaying?: ReactEventHandler<HTMLDivElement>
    onPlayingCapture?: ReactEventHandler<HTMLDivElement>
    onPointerCancel?: PointerEventHandler<HTMLDivElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>
    onPointerDown?: PointerEventHandler<HTMLDivElement>
    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>
    onPointerEnter?: PointerEventHandler<HTMLDivElement>
    onPointerLeave?: PointerEventHandler<HTMLDivElement>
    onPointerMove?: PointerEventHandler<HTMLDivElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>
    onPointerOut?: PointerEventHandler<HTMLDivElement>
    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>
    onPointerOver?: PointerEventHandler<HTMLDivElement>
    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>
    onPointerUp?: PointerEventHandler<HTMLDivElement>
    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>
    onProgress?: ReactEventHandler<HTMLDivElement>
    onProgressCapture?: ReactEventHandler<HTMLDivElement>
    onRateChange?: ReactEventHandler<HTMLDivElement>
    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>
    onReset?: FormEventHandler<HTMLDivElement>
    onResetCapture?: FormEventHandler<HTMLDivElement>
    onResize?: ReactEventHandler<HTMLDivElement>
    onResizeCapture?: ReactEventHandler<HTMLDivElement>
    onScroll?: UIEventHandler<HTMLDivElement>
    onScrollCapture?: UIEventHandler<HTMLDivElement>
    onSeeked?: ReactEventHandler<HTMLDivElement>
    onSeekedCapture?: ReactEventHandler<HTMLDivElement>
    onSeeking?: ReactEventHandler<HTMLDivElement>
    onSeekingCapture?: ReactEventHandler<HTMLDivElement>
    onSelect?: ReactEventHandler<HTMLDivElement>
    onSelectCapture?: ReactEventHandler<HTMLDivElement>
    onStalled?: ReactEventHandler<HTMLDivElement>
    onStalledCapture?: ReactEventHandler<HTMLDivElement>
    onSubmit?: FormEventHandler<HTMLDivElement>
    onSubmitCapture?: FormEventHandler<HTMLDivElement>
    onSuspend?: ReactEventHandler<HTMLDivElement>
    onSuspendCapture?: ReactEventHandler<HTMLDivElement>
    onTimeUpdate?: ReactEventHandler<HTMLDivElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>
    onTouchCancel?: TouchEventHandler<HTMLDivElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>
    onTouchEnd?: TouchEventHandler<HTMLDivElement>
    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>
    onTouchMove?: TouchEventHandler<HTMLDivElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>
    onTouchStart?: TouchEventHandler<HTMLDivElement>
    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>
    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>
    onVolumeChange?: ReactEventHandler<HTMLDivElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>
    onWaiting?: ReactEventHandler<HTMLDivElement>
    onWaitingCapture?: ReactEventHandler<HTMLDivElement>
    onWheel?: WheelEventHandler<HTMLDivElement>
    onWheelCapture?: WheelEventHandler<HTMLDivElement>
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    typeof?: string
    unselectable?: "off" | "on"
    variant?:
        | null
        | "default"
        | "outline"
        | "muted"
        | "destructive"
        | "secondary" = ...
    vocab?: string
    +
    onKeyUp?: KeyboardEventHandler<HTMLDivElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>
    onLoad?: ReactEventHandler<HTMLDivElement>
    onLoadCapture?: ReactEventHandler<HTMLDivElement>
    onLoadedData?: ReactEventHandler<HTMLDivElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>
    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>
    onLoadStart?: ReactEventHandler<HTMLDivElement>
    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>
    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
    onMouseDown?: MouseEventHandler<HTMLDivElement>
    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>
    onMouseEnter?: MouseEventHandler<HTMLDivElement>
    onMouseLeave?: MouseEventHandler<HTMLDivElement>
    onMouseMove?: MouseEventHandler<HTMLDivElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>
    onMouseOut?: MouseEventHandler<HTMLDivElement>
    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>
    onMouseOver?: MouseEventHandler<HTMLDivElement>
    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>
    onMouseUp?: MouseEventHandler<HTMLDivElement>
    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>
    onPaste?: ClipboardEventHandler<HTMLDivElement>
    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>
    onPause?: ReactEventHandler<HTMLDivElement>
    onPauseCapture?: ReactEventHandler<HTMLDivElement>
    onPlay?: ReactEventHandler<HTMLDivElement>
    onPlayCapture?: ReactEventHandler<HTMLDivElement>
    onPlaying?: ReactEventHandler<HTMLDivElement>
    onPlayingCapture?: ReactEventHandler<HTMLDivElement>
    onPointerCancel?: PointerEventHandler<HTMLDivElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>
    onPointerDown?: PointerEventHandler<HTMLDivElement>
    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>
    onPointerEnter?: PointerEventHandler<HTMLDivElement>
    onPointerLeave?: PointerEventHandler<HTMLDivElement>
    onPointerMove?: PointerEventHandler<HTMLDivElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>
    onPointerOut?: PointerEventHandler<HTMLDivElement>
    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>
    onPointerOver?: PointerEventHandler<HTMLDivElement>
    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>
    onPointerUp?: PointerEventHandler<HTMLDivElement>
    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>
    onProgress?: ReactEventHandler<HTMLDivElement>
    onProgressCapture?: ReactEventHandler<HTMLDivElement>
    onRateChange?: ReactEventHandler<HTMLDivElement>
    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>
    onReset?: FormEventHandler<HTMLDivElement>
    onResetCapture?: FormEventHandler<HTMLDivElement>
    onResize?: ReactEventHandler<HTMLDivElement>
    onResizeCapture?: ReactEventHandler<HTMLDivElement>
    onScroll?: UIEventHandler<HTMLDivElement>
    onScrollCapture?: UIEventHandler<HTMLDivElement>
    onSeeked?: ReactEventHandler<HTMLDivElement>
    onSeekedCapture?: ReactEventHandler<HTMLDivElement>
    onSeeking?: ReactEventHandler<HTMLDivElement>
    onSeekingCapture?: ReactEventHandler<HTMLDivElement>
    onSelect?: ReactEventHandler<HTMLDivElement>
    onSelectCapture?: ReactEventHandler<HTMLDivElement>
    onStalled?: ReactEventHandler<HTMLDivElement>
    onStalledCapture?: ReactEventHandler<HTMLDivElement>
    onSubmit?: FormEventHandler<HTMLDivElement>
    onSubmitCapture?: FormEventHandler<HTMLDivElement>
    onSuspend?: ReactEventHandler<HTMLDivElement>
    onSuspendCapture?: ReactEventHandler<HTMLDivElement>
    onTimeUpdate?: ReactEventHandler<HTMLDivElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>
    onTouchCancel?: TouchEventHandler<HTMLDivElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>
    onTouchEnd?: TouchEventHandler<HTMLDivElement>
    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>
    onTouchMove?: TouchEventHandler<HTMLDivElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>
    onTouchStart?: TouchEventHandler<HTMLDivElement>
    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>
    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>
    onVolumeChange?: ReactEventHandler<HTMLDivElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>
    onWaiting?: ReactEventHandler<HTMLDivElement>
    onWaitingCapture?: ReactEventHandler<HTMLDivElement>
    onWheel?: WheelEventHandler<HTMLDivElement>
    onWheelCapture?: WheelEventHandler<HTMLDivElement>
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    typeof?: string
    unselectable?: "off" | "on"
    variant?:
        | null
        | "default"
        | "outline"
        | "muted"
        | "destructive"
        | "secondary" = ...
    vocab?: string
    diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index 12d571d9b6..33f30651bc 100644 --- a/platform-bible-react/interfaces/ButtonProps.html +++ b/platform-bible-react/interfaces/ButtonProps.html @@ -1,4 +1,4 @@ -ButtonProps | platform-bible-react

    InterfaceButtonProps

    interface ButtonProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        asChild?: boolean;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        form?: string;
        formAction?: string;
        formEncType?: string;
        formMethod?: string;
        formNoValidate?: boolean;
        formTarget?: string;
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        name?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLButtonElement>;
        onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAuxClick?: MouseEventHandler<HTMLButtonElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onBeforeInput?: FormEventHandler<HTMLButtonElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
        onCanPlay?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
        onChange?: FormEventHandler<HTMLButtonElement>;
        onChangeCapture?: FormEventHandler<HTMLButtonElement>;
        onClick?: MouseEventHandler<HTMLButtonElement>;
        onClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
        onContextMenu?: MouseEventHandler<HTMLButtonElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
        onCopy?: ClipboardEventHandler<HTMLButtonElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onCut?: ClipboardEventHandler<HTMLButtonElement>;
        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onDrag?: DragEventHandler<HTMLButtonElement>;
        onDragCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnd?: DragEventHandler<HTMLButtonElement>;
        onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnter?: DragEventHandler<HTMLButtonElement>;
        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
        onDragExit?: DragEventHandler<HTMLButtonElement>;
        onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
        onDragLeave?: DragEventHandler<HTMLButtonElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
        onDragOver?: DragEventHandler<HTMLButtonElement>;
        onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
        onDragStart?: DragEventHandler<HTMLButtonElement>;
        onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
        onDrop?: DragEventHandler<HTMLButtonElement>;
        onDropCapture?: DragEventHandler<HTMLButtonElement>;
        onDurationChange?: ReactEventHandler<HTMLButtonElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onEmptied?: ReactEventHandler<HTMLButtonElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEncrypted?: ReactEventHandler<HTMLButtonElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEnded?: ReactEventHandler<HTMLButtonElement>;
        onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
        onError?: ReactEventHandler<HTMLButtonElement>;
        onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
        onFocus?: FocusEventHandler<HTMLButtonElement>;
        onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onInput?: FormEventHandler<HTMLButtonElement>;
        onInputCapture?: FormEventHandler<HTMLButtonElement>;
        onInvalid?: FormEventHandler<HTMLButtonElement>;
        onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onLoad?: ReactEventHandler<HTMLButtonElement>;
        onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedData?: ReactEventHandler<HTMLButtonElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadStart?: ReactEventHandler<HTMLButtonElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onMouseDown?: MouseEventHandler<HTMLButtonElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
        onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
        onMouseMove?: MouseEventHandler<HTMLButtonElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOut?: MouseEventHandler<HTMLButtonElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOver?: MouseEventHandler<HTMLButtonElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseUp?: MouseEventHandler<HTMLButtonElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
        onPaste?: ClipboardEventHandler<HTMLButtonElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onPause?: ReactEventHandler<HTMLButtonElement>;
        onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlay?: ReactEventHandler<HTMLButtonElement>;
        onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlaying?: ReactEventHandler<HTMLButtonElement>;
        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
        onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerDown?: PointerEventHandler<HTMLButtonElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
        onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
        onPointerMove?: PointerEventHandler<HTMLButtonElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOut?: PointerEventHandler<HTMLButtonElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOver?: PointerEventHandler<HTMLButtonElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerUp?: PointerEventHandler<HTMLButtonElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
        onProgress?: ReactEventHandler<HTMLButtonElement>;
        onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
        onRateChange?: ReactEventHandler<HTMLButtonElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onReset?: FormEventHandler<HTMLButtonElement>;
        onResetCapture?: FormEventHandler<HTMLButtonElement>;
        onResize?: ReactEventHandler<HTMLButtonElement>;
        onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
        onScroll?: UIEventHandler<HTMLButtonElement>;
        onScrollCapture?: UIEventHandler<HTMLButtonElement>;
        onSeeked?: ReactEventHandler<HTMLButtonElement>;
        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
        onSeeking?: ReactEventHandler<HTMLButtonElement>;
        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
        onSelect?: ReactEventHandler<HTMLButtonElement>;
        onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
        onStalled?: ReactEventHandler<HTMLButtonElement>;
        onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
        onSubmit?: FormEventHandler<HTMLButtonElement>;
        onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
        onSuspend?: ReactEventHandler<HTMLButtonElement>;
        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
        onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchMove?: TouchEventHandler<HTMLButtonElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchStart?: TouchEventHandler<HTMLButtonElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
        onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onWaiting?: ReactEventHandler<HTMLButtonElement>;
        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
        onWheel?: WheelEventHandler<HTMLButtonElement>;
        onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        size?:
            | null
            | "default"
            | "icon"
            | "sm"
            | "lg";
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        type?: "button" | "reset" | "submit";
        typeof?: string;
        unselectable?: "off" | "on";
        value?: string | number | readonly string[];
        variant?:
            | null
            | "link"
            | "default"
            | "outline"
            | "destructive"
            | "secondary"
            | "ghost";
        vocab?: string;
    }

    Hierarchy

    • ButtonHTMLAttributes<HTMLButtonElement>
    • VariantProps<typeof buttonVariants>
      • ButtonProps

    Properties

    about? +ButtonProps | platform-bible-react

    InterfaceButtonProps

    interface ButtonProps {
        about?: string;
        accessKey?: string;
        aria-activedescendant?: string;
        aria-atomic?: Booleanish;
        aria-autocomplete?:
            | "inline"
            | "both"
            | "none"
            | "list";
        aria-braillelabel?: string;
        aria-brailleroledescription?: string;
        aria-busy?: Booleanish;
        aria-checked?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-colcount?: number;
        aria-colindex?: number;
        aria-colindextext?: string;
        aria-colspan?: number;
        aria-controls?: string;
        aria-current?:
            | boolean
            | "false"
            | "time"
            | "location"
            | "page"
            | "true"
            | "step"
            | "date";
        aria-describedby?: string;
        aria-description?: string;
        aria-details?: string;
        aria-disabled?: Booleanish;
        aria-dropeffect?:
            | "link"
            | "none"
            | "copy"
            | "move"
            | "execute"
            | "popup";
        aria-errormessage?: string;
        aria-expanded?: Booleanish;
        aria-flowto?: string;
        aria-grabbed?: Booleanish;
        aria-haspopup?:
            | boolean
            | "false"
            | "grid"
            | "dialog"
            | "menu"
            | "listbox"
            | "true"
            | "tree";
        aria-hidden?: Booleanish;
        aria-invalid?:
            | boolean
            | "false"
            | "true"
            | "grammar"
            | "spelling";
        aria-keyshortcuts?: string;
        aria-label?: string;
        aria-labelledby?: string;
        aria-level?: number;
        aria-live?: "off" | "assertive" | "polite";
        aria-modal?: Booleanish;
        aria-multiline?: Booleanish;
        aria-multiselectable?: Booleanish;
        aria-orientation?: "horizontal" | "vertical";
        aria-owns?: string;
        aria-placeholder?: string;
        aria-posinset?: number;
        aria-pressed?:
            | boolean
            | "false"
            | "mixed"
            | "true";
        aria-readonly?: Booleanish;
        aria-relevant?:
            | "all"
            | "text"
            | "additions"
            | "additions removals"
            | "additions text"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text additions"
            | "text removals";
        aria-required?: Booleanish;
        aria-roledescription?: string;
        aria-rowcount?: number;
        aria-rowindex?: number;
        aria-rowindextext?: string;
        aria-rowspan?: number;
        aria-selected?: Booleanish;
        aria-setsize?: number;
        aria-sort?:
            | "none"
            | "other"
            | "ascending"
            | "descending";
        aria-valuemax?: number;
        aria-valuemin?: number;
        aria-valuenow?: number;
        aria-valuetext?: string;
        asChild?: boolean;
        autoCapitalize?:
            | "none"
            | "off"
            | "on"
            | string & {}
            | "words"
            | "sentences"
            | "characters";
        autoCorrect?: string;
        autoFocus?: boolean;
        autoSave?: string;
        children?: ReactNode;
        className?: string;
        color?: string;
        content?: string;
        contentEditable?: "inherit" | Booleanish | "plaintext-only";
        contextMenu?: string;
        dangerouslySetInnerHTML?: {
            __html: string | TrustedHTML;
        };
        datatype?: string;
        defaultChecked?: boolean;
        defaultValue?: string | number | readonly string[];
        dir?: string;
        disabled?: boolean;
        draggable?: Booleanish;
        enterKeyHint?:
            | "search"
            | "next"
            | "done"
            | "enter"
            | "go"
            | "previous"
            | "send";
        form?: string;
        formAction?: string;
        formEncType?: string;
        formMethod?: string;
        formNoValidate?: boolean;
        formTarget?: string;
        hidden?: boolean;
        id?: string;
        inlist?: any;
        inputMode?:
            | "search"
            | "numeric"
            | "none"
            | "url"
            | "text"
            | "email"
            | "tel"
            | "decimal";
        is?: string;
        itemID?: string;
        itemProp?: string;
        itemRef?: string;
        itemScope?: boolean;
        itemType?: string;
        lang?: string;
        name?: string;
        nonce?: string;
        onAbort?: ReactEventHandler<HTMLButtonElement>;
        onAbortCapture?: ReactEventHandler<HTMLButtonElement>;
        onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStart?: AnimationEventHandler<HTMLButtonElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>;
        onAuxClick?: MouseEventHandler<HTMLButtonElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onBeforeInput?: FormEventHandler<HTMLButtonElement>;
        onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>;
        onBlur?: FocusEventHandler<HTMLButtonElement>;
        onBlurCapture?: FocusEventHandler<HTMLButtonElement>;
        onCanPlay?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>;
        onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>;
        onChange?: FormEventHandler<HTMLButtonElement>;
        onChangeCapture?: FormEventHandler<HTMLButtonElement>;
        onClick?: MouseEventHandler<HTMLButtonElement>;
        onClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStart?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>;
        onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>;
        onContextMenu?: MouseEventHandler<HTMLButtonElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>;
        onCopy?: ClipboardEventHandler<HTMLButtonElement>;
        onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onCut?: ClipboardEventHandler<HTMLButtonElement>;
        onCutCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onDoubleClick?: MouseEventHandler<HTMLButtonElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>;
        onDrag?: DragEventHandler<HTMLButtonElement>;
        onDragCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnd?: DragEventHandler<HTMLButtonElement>;
        onDragEndCapture?: DragEventHandler<HTMLButtonElement>;
        onDragEnter?: DragEventHandler<HTMLButtonElement>;
        onDragEnterCapture?: DragEventHandler<HTMLButtonElement>;
        onDragExit?: DragEventHandler<HTMLButtonElement>;
        onDragExitCapture?: DragEventHandler<HTMLButtonElement>;
        onDragLeave?: DragEventHandler<HTMLButtonElement>;
        onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>;
        onDragOver?: DragEventHandler<HTMLButtonElement>;
        onDragOverCapture?: DragEventHandler<HTMLButtonElement>;
        onDragStart?: DragEventHandler<HTMLButtonElement>;
        onDragStartCapture?: DragEventHandler<HTMLButtonElement>;
        onDrop?: DragEventHandler<HTMLButtonElement>;
        onDropCapture?: DragEventHandler<HTMLButtonElement>;
        onDurationChange?: ReactEventHandler<HTMLButtonElement>;
        onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onEmptied?: ReactEventHandler<HTMLButtonElement>;
        onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEncrypted?: ReactEventHandler<HTMLButtonElement>;
        onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>;
        onEnded?: ReactEventHandler<HTMLButtonElement>;
        onEndedCapture?: ReactEventHandler<HTMLButtonElement>;
        onError?: ReactEventHandler<HTMLButtonElement>;
        onErrorCapture?: ReactEventHandler<HTMLButtonElement>;
        onFocus?: FocusEventHandler<HTMLButtonElement>;
        onFocusCapture?: FocusEventHandler<HTMLButtonElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onInput?: FormEventHandler<HTMLButtonElement>;
        onInputCapture?: FormEventHandler<HTMLButtonElement>;
        onInvalid?: FormEventHandler<HTMLButtonElement>;
        onInvalidCapture?: FormEventHandler<HTMLButtonElement>;
        onKeyDown?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPress?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUp?: KeyboardEventHandler<HTMLButtonElement>;
        onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>;
        onLoad?: ReactEventHandler<HTMLButtonElement>;
        onLoadCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedData?: ReactEventHandler<HTMLButtonElement>;
        onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>;
        onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>;
        onLoadStart?: ReactEventHandler<HTMLButtonElement>;
        onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>;
        onMouseDown?: MouseEventHandler<HTMLButtonElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseEnter?: MouseEventHandler<HTMLButtonElement>;
        onMouseLeave?: MouseEventHandler<HTMLButtonElement>;
        onMouseMove?: MouseEventHandler<HTMLButtonElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOut?: MouseEventHandler<HTMLButtonElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseOver?: MouseEventHandler<HTMLButtonElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>;
        onMouseUp?: MouseEventHandler<HTMLButtonElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>;
        onPaste?: ClipboardEventHandler<HTMLButtonElement>;
        onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>;
        onPause?: ReactEventHandler<HTMLButtonElement>;
        onPauseCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlay?: ReactEventHandler<HTMLButtonElement>;
        onPlayCapture?: ReactEventHandler<HTMLButtonElement>;
        onPlaying?: ReactEventHandler<HTMLButtonElement>;
        onPlayingCapture?: ReactEventHandler<HTMLButtonElement>;
        onPointerCancel?: PointerEventHandler<HTMLButtonElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerDown?: PointerEventHandler<HTMLButtonElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerEnter?: PointerEventHandler<HTMLButtonElement>;
        onPointerLeave?: PointerEventHandler<HTMLButtonElement>;
        onPointerMove?: PointerEventHandler<HTMLButtonElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOut?: PointerEventHandler<HTMLButtonElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerOver?: PointerEventHandler<HTMLButtonElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>;
        onPointerUp?: PointerEventHandler<HTMLButtonElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>;
        onProgress?: ReactEventHandler<HTMLButtonElement>;
        onProgressCapture?: ReactEventHandler<HTMLButtonElement>;
        onRateChange?: ReactEventHandler<HTMLButtonElement>;
        onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onReset?: FormEventHandler<HTMLButtonElement>;
        onResetCapture?: FormEventHandler<HTMLButtonElement>;
        onResize?: ReactEventHandler<HTMLButtonElement>;
        onResizeCapture?: ReactEventHandler<HTMLButtonElement>;
        onScroll?: UIEventHandler<HTMLButtonElement>;
        onScrollCapture?: UIEventHandler<HTMLButtonElement>;
        onSeeked?: ReactEventHandler<HTMLButtonElement>;
        onSeekedCapture?: ReactEventHandler<HTMLButtonElement>;
        onSeeking?: ReactEventHandler<HTMLButtonElement>;
        onSeekingCapture?: ReactEventHandler<HTMLButtonElement>;
        onSelect?: ReactEventHandler<HTMLButtonElement>;
        onSelectCapture?: ReactEventHandler<HTMLButtonElement>;
        onStalled?: ReactEventHandler<HTMLButtonElement>;
        onStalledCapture?: ReactEventHandler<HTMLButtonElement>;
        onSubmit?: FormEventHandler<HTMLButtonElement>;
        onSubmitCapture?: FormEventHandler<HTMLButtonElement>;
        onSuspend?: ReactEventHandler<HTMLButtonElement>;
        onSuspendCapture?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdate?: ReactEventHandler<HTMLButtonElement>;
        onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>;
        onTouchCancel?: TouchEventHandler<HTMLButtonElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchEnd?: TouchEventHandler<HTMLButtonElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchMove?: TouchEventHandler<HTMLButtonElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>;
        onTouchStart?: TouchEventHandler<HTMLButtonElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>;
        onVolumeChange?: ReactEventHandler<HTMLButtonElement>;
        onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>;
        onWaiting?: ReactEventHandler<HTMLButtonElement>;
        onWaitingCapture?: ReactEventHandler<HTMLButtonElement>;
        onWheel?: WheelEventHandler<HTMLButtonElement>;
        onWheelCapture?: WheelEventHandler<HTMLButtonElement>;
        prefix?: string;
        property?: string;
        radioGroup?: string;
        rel?: string;
        resource?: string;
        results?: number;
        rev?: string;
        role?: AriaRole;
        security?: string;
        size?:
            | null
            | "default"
            | "icon"
            | "sm"
            | "lg";
        slot?: string;
        spellCheck?: Booleanish;
        style?: CSSProperties;
        suppressContentEditableWarning?: boolean;
        suppressHydrationWarning?: boolean;
        tabIndex?: number;
        title?: string;
        translate?: "yes" | "no";
        type?: "button" | "reset" | "submit";
        typeof?: string;
        unselectable?: "off" | "on";
        value?: string | number | readonly string[];
        variant?:
            | null
            | "link"
            | "default"
            | "outline"
            | "destructive"
            | "secondary"
            | "ghost";
        vocab?: string;
    }

    Hierarchy

    • ButtonHTMLAttributes<HTMLButtonElement>
    • VariantProps<typeof buttonVariants>
      • ButtonProps

    Properties

    aria-valuenow?: number

    Defines the current value for a range widget.

    aria-valuetext.

    aria-valuetext?: string

    Defines the human readable text alternative of aria-valuenow for a range widget.

    -
    asChild?: boolean
    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"
    autoCorrect?: string
    autoFocus?: boolean
    autoSave?: string
    children?: ReactNode
    className?: string
    color?: string
    content?: string
    contentEditable?: "inherit" | Booleanish | "plaintext-only"
    contextMenu?: string
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }
    datatype?: string
    defaultChecked?: boolean
    defaultValue?: string | number | readonly string[]
    dir?: string
    disabled?: boolean
    draggable?: Booleanish
    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"
    form?: string
    formAction?: string
    formEncType?: string
    formMethod?: string
    formNoValidate?: boolean
    formTarget?: string
    hidden?: boolean
    id?: string
    inlist?: any
    inputMode?:
        | "search"
        | "numeric"
        | "none"
        | "url"
        | "text"
        | "email"
        | "tel"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +
    asChild?: boolean
    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"
    autoCorrect?: string
    autoFocus?: boolean
    autoSave?: string
    children?: ReactNode
    className?: string
    color?: string
    content?: string
    contentEditable?: "inherit" | Booleanish | "plaintext-only"
    contextMenu?: string
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }
    datatype?: string
    defaultChecked?: boolean
    defaultValue?: string | number | readonly string[]
    dir?: string
    disabled?: boolean
    draggable?: Booleanish
    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"
    form?: string
    formAction?: string
    formEncType?: string
    formMethod?: string
    formNoValidate?: boolean
    formTarget?: string
    hidden?: boolean
    id?: string
    inlist?: any
    inputMode?:
        | "search"
        | "numeric"
        | "none"
        | "url"
        | "text"
        | "email"
        | "tel"
        | "decimal"

    Hints at the type of data that might be entered by the user while editing the element or its contents

    is?: string

    Specify that a standard HTML element should behave like a defined custom built-in element

    itemID?: string
    itemProp?: string
    itemRef?: string
    itemScope?: boolean
    itemType?: string
    lang?: string
    name?: string
    nonce?: string
    onAbort?: ReactEventHandler<HTMLButtonElement>
    onAbortCapture?: ReactEventHandler<HTMLButtonElement>
    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>
    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>
    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>
    onAuxClick?: MouseEventHandler<HTMLButtonElement>
    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>
    onBeforeInput?: FormEventHandler<HTMLButtonElement>
    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>
    onBlur?: FocusEventHandler<HTMLButtonElement>
    onBlurCapture?: FocusEventHandler<HTMLButtonElement>
    onCanPlay?: ReactEventHandler<HTMLButtonElement>
    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>
    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>
    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>
    onChange?: FormEventHandler<HTMLButtonElement>
    onChangeCapture?: FormEventHandler<HTMLButtonElement>
    onClick?: MouseEventHandler<HTMLButtonElement>
    onClickCapture?: MouseEventHandler<HTMLButtonElement>
    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>
    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>
    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>
    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>
    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>
    onContextMenu?: MouseEventHandler<HTMLButtonElement>
    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>
    onCopy?: ClipboardEventHandler<HTMLButtonElement>
    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>
    onCut?: ClipboardEventHandler<HTMLButtonElement>
    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>
    onDoubleClick?: MouseEventHandler<HTMLButtonElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>
    onDrag?: DragEventHandler<HTMLButtonElement>
    onDragCapture?: DragEventHandler<HTMLButtonElement>
    onDragEnd?: DragEventHandler<HTMLButtonElement>
    onDragEndCapture?: DragEventHandler<HTMLButtonElement>
    onDragEnter?: DragEventHandler<HTMLButtonElement>
    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>
    onDragExit?: DragEventHandler<HTMLButtonElement>
    onDragExitCapture?: DragEventHandler<HTMLButtonElement>
    onDragLeave?: DragEventHandler<HTMLButtonElement>
    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>
    onDragOver?: DragEventHandler<HTMLButtonElement>
    onDragOverCapture?: DragEventHandler<HTMLButtonElement>
    onDragStart?: DragEventHandler<HTMLButtonElement>
    onDragStartCapture?: DragEventHandler<HTMLButtonElement>
    onDrop?: DragEventHandler<HTMLButtonElement>
    onDropCapture?: DragEventHandler<HTMLButtonElement>
    onDurationChange?: ReactEventHandler<HTMLButtonElement>
    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onEmptied?: ReactEventHandler<HTMLButtonElement>
    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>
    onEncrypted?: ReactEventHandler<HTMLButtonElement>
    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>
    onEnded?: ReactEventHandler<HTMLButtonElement>
    onEndedCapture?: ReactEventHandler<HTMLButtonElement>
    onError?: ReactEventHandler<HTMLButtonElement>
    onErrorCapture?: ReactEventHandler<HTMLButtonElement>
    onFocus?: FocusEventHandler<HTMLButtonElement>
    onFocusCapture?: FocusEventHandler<HTMLButtonElement>
    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
    onInput?: FormEventHandler<HTMLButtonElement>
    onInputCapture?: FormEventHandler<HTMLButtonElement>
    onInvalid?: FormEventHandler<HTMLButtonElement>
    onInvalidCapture?: FormEventHandler<HTMLButtonElement>
    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>
    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>
    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

    Use onKeyUp or onKeyDown instead

    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

    Use onKeyUpCapture or onKeyDownCapture instead

    -
    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
    onLoad?: ReactEventHandler<HTMLButtonElement>
    onLoadCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedData?: ReactEventHandler<HTMLButtonElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadStart?: ReactEventHandler<HTMLButtonElement>
    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
    onMouseDown?: MouseEventHandler<HTMLButtonElement>
    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseEnter?: MouseEventHandler<HTMLButtonElement>
    onMouseLeave?: MouseEventHandler<HTMLButtonElement>
    onMouseMove?: MouseEventHandler<HTMLButtonElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOut?: MouseEventHandler<HTMLButtonElement>
    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOver?: MouseEventHandler<HTMLButtonElement>
    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseUp?: MouseEventHandler<HTMLButtonElement>
    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
    onPaste?: ClipboardEventHandler<HTMLButtonElement>
    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
    onPause?: ReactEventHandler<HTMLButtonElement>
    onPauseCapture?: ReactEventHandler<HTMLButtonElement>
    onPlay?: ReactEventHandler<HTMLButtonElement>
    onPlayCapture?: ReactEventHandler<HTMLButtonElement>
    onPlaying?: ReactEventHandler<HTMLButtonElement>
    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
    onPointerCancel?: PointerEventHandler<HTMLButtonElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerDown?: PointerEventHandler<HTMLButtonElement>
    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerEnter?: PointerEventHandler<HTMLButtonElement>
    onPointerLeave?: PointerEventHandler<HTMLButtonElement>
    onPointerMove?: PointerEventHandler<HTMLButtonElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOut?: PointerEventHandler<HTMLButtonElement>
    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOver?: PointerEventHandler<HTMLButtonElement>
    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerUp?: PointerEventHandler<HTMLButtonElement>
    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
    onProgress?: ReactEventHandler<HTMLButtonElement>
    onProgressCapture?: ReactEventHandler<HTMLButtonElement>
    onRateChange?: ReactEventHandler<HTMLButtonElement>
    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onReset?: FormEventHandler<HTMLButtonElement>
    onResetCapture?: FormEventHandler<HTMLButtonElement>
    onResize?: ReactEventHandler<HTMLButtonElement>
    onResizeCapture?: ReactEventHandler<HTMLButtonElement>
    onScroll?: UIEventHandler<HTMLButtonElement>
    onScrollCapture?: UIEventHandler<HTMLButtonElement>
    onSeeked?: ReactEventHandler<HTMLButtonElement>
    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
    onSeeking?: ReactEventHandler<HTMLButtonElement>
    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
    onSelect?: ReactEventHandler<HTMLButtonElement>
    onSelectCapture?: ReactEventHandler<HTMLButtonElement>
    onStalled?: ReactEventHandler<HTMLButtonElement>
    onStalledCapture?: ReactEventHandler<HTMLButtonElement>
    onSubmit?: FormEventHandler<HTMLButtonElement>
    onSubmitCapture?: FormEventHandler<HTMLButtonElement>
    onSuspend?: ReactEventHandler<HTMLButtonElement>
    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
    onTouchCancel?: TouchEventHandler<HTMLButtonElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchEnd?: TouchEventHandler<HTMLButtonElement>
    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchMove?: TouchEventHandler<HTMLButtonElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchStart?: TouchEventHandler<HTMLButtonElement>
    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
    onVolumeChange?: ReactEventHandler<HTMLButtonElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onWaiting?: ReactEventHandler<HTMLButtonElement>
    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
    onWheel?: WheelEventHandler<HTMLButtonElement>
    onWheelCapture?: WheelEventHandler<HTMLButtonElement>
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    type?: "button" | "reset" | "submit"
    typeof?: string
    unselectable?: "off" | "on"
    value?: string | number | readonly string[]
    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...
    vocab?: string
    +
    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
    onLoad?: ReactEventHandler<HTMLButtonElement>
    onLoadCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedData?: ReactEventHandler<HTMLButtonElement>
    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
    onLoadStart?: ReactEventHandler<HTMLButtonElement>
    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
    onMouseDown?: MouseEventHandler<HTMLButtonElement>
    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseEnter?: MouseEventHandler<HTMLButtonElement>
    onMouseLeave?: MouseEventHandler<HTMLButtonElement>
    onMouseMove?: MouseEventHandler<HTMLButtonElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOut?: MouseEventHandler<HTMLButtonElement>
    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseOver?: MouseEventHandler<HTMLButtonElement>
    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
    onMouseUp?: MouseEventHandler<HTMLButtonElement>
    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
    onPaste?: ClipboardEventHandler<HTMLButtonElement>
    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
    onPause?: ReactEventHandler<HTMLButtonElement>
    onPauseCapture?: ReactEventHandler<HTMLButtonElement>
    onPlay?: ReactEventHandler<HTMLButtonElement>
    onPlayCapture?: ReactEventHandler<HTMLButtonElement>
    onPlaying?: ReactEventHandler<HTMLButtonElement>
    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
    onPointerCancel?: PointerEventHandler<HTMLButtonElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerDown?: PointerEventHandler<HTMLButtonElement>
    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerEnter?: PointerEventHandler<HTMLButtonElement>
    onPointerLeave?: PointerEventHandler<HTMLButtonElement>
    onPointerMove?: PointerEventHandler<HTMLButtonElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOut?: PointerEventHandler<HTMLButtonElement>
    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerOver?: PointerEventHandler<HTMLButtonElement>
    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
    onPointerUp?: PointerEventHandler<HTMLButtonElement>
    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
    onProgress?: ReactEventHandler<HTMLButtonElement>
    onProgressCapture?: ReactEventHandler<HTMLButtonElement>
    onRateChange?: ReactEventHandler<HTMLButtonElement>
    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onReset?: FormEventHandler<HTMLButtonElement>
    onResetCapture?: FormEventHandler<HTMLButtonElement>
    onResize?: ReactEventHandler<HTMLButtonElement>
    onResizeCapture?: ReactEventHandler<HTMLButtonElement>
    onScroll?: UIEventHandler<HTMLButtonElement>
    onScrollCapture?: UIEventHandler<HTMLButtonElement>
    onSeeked?: ReactEventHandler<HTMLButtonElement>
    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
    onSeeking?: ReactEventHandler<HTMLButtonElement>
    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
    onSelect?: ReactEventHandler<HTMLButtonElement>
    onSelectCapture?: ReactEventHandler<HTMLButtonElement>
    onStalled?: ReactEventHandler<HTMLButtonElement>
    onStalledCapture?: ReactEventHandler<HTMLButtonElement>
    onSubmit?: FormEventHandler<HTMLButtonElement>
    onSubmitCapture?: FormEventHandler<HTMLButtonElement>
    onSuspend?: ReactEventHandler<HTMLButtonElement>
    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
    onTouchCancel?: TouchEventHandler<HTMLButtonElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchEnd?: TouchEventHandler<HTMLButtonElement>
    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchMove?: TouchEventHandler<HTMLButtonElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
    onTouchStart?: TouchEventHandler<HTMLButtonElement>
    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
    onVolumeChange?: ReactEventHandler<HTMLButtonElement>
    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
    onWaiting?: ReactEventHandler<HTMLButtonElement>
    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
    onWheel?: WheelEventHandler<HTMLButtonElement>
    onWheelCapture?: WheelEventHandler<HTMLButtonElement>
    prefix?: string
    property?: string
    radioGroup?: string
    rel?: string
    resource?: string
    results?: number
    rev?: string
    role?: AriaRole
    security?: string
    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...
    slot?: string
    spellCheck?: Booleanish
    style?: CSSProperties
    suppressContentEditableWarning?: boolean
    suppressHydrationWarning?: boolean
    tabIndex?: number
    title?: string
    translate?: "yes" | "no"
    type?: "button" | "reset" | "submit"
    typeof?: string
    unselectable?: "off" | "on"
    value?: string | number | readonly string[]
    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...
    vocab?: string
    diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index d92c953e8c..6bb93dfc05 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

    InterfaceCommandHandler

    +CommandHandler | platform-bible-react

    InterfaceCommandHandler

    diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index c1db3f9726..9ce53d45e4 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • Parameters

      • isSupportAndDevelopment: boolean

      Returns Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    +MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • Parameters

      • isSupportAndDevelopment: boolean

      Returns Promise<{
          columns: {
              isExtensible?: boolean;
          };
          groups: {};
          items: ({
              group: string;
              id: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          } | {
              command: string;
              group: string;
              iconPathAfter?: string;
              iconPathBefore?: string;
              label: string;
              localizeNotes: string;
              order: number;
              searchTerms?: string;
              tooltip?: string;
          })[];
      }>

    diff --git a/platform-bible-react/types/BookSelectorLocalizedStrings.html b/platform-bible-react/types/BookSelectorLocalizedStrings.html index 189eedac01..855d4dbd12 100644 --- a/platform-bible-react/types/BookSelectorLocalizedStrings.html +++ b/platform-bible-react/types/BookSelectorLocalizedStrings.html @@ -1 +1 @@ -BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedBookSelectorKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }
    +BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedBookSelectorKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }
    diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 4aca8acbdf..f14444cddb 100644 --- a/platform-bible-react/types/ChapterRangeSelectorProps.html +++ b/platform-bible-react/types/ChapterRangeSelectorProps.html @@ -1 +1 @@ -ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

    ChapterRangeSelectorProps: {
        chapterCount: number;
        endChapter: number;
        handleSelectEndChapter: ((chapter: number) => void);
        handleSelectStartChapter: ((chapter: number) => void);
        isDisabled?: boolean;
        startChapter: number;
    }
    +ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

    ChapterRangeSelectorProps: {
        chapterCount: number;
        endChapter: number;
        handleSelectEndChapter: ((chapter: number) => void);
        handleSelectStartChapter: ((chapter: number) => void);
        isDisabled?: boolean;
        startChapter: number;
    }
    diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index 4bf7938f94..85e75bc29f 100644 --- a/platform-bible-react/types/ChecklistProps.html +++ b/platform-bible-react/types/ChecklistProps.html @@ -8,4 +8,4 @@

    Returns void

  • Optionalid?: string

    Optional string representing the id attribute of the Checklist

  • listItems: string[]

    Array of strings representing the checkable items

  • selectedListItems: string[]

    Array of strings representing the checked items

    -
  • +
    diff --git a/platform-bible-react/types/ColumnDef.html b/platform-bible-react/types/ColumnDef.html index ba09357562..67072fe3cd 100644 --- a/platform-bible-react/types/ColumnDef.html +++ b/platform-bible-react/types/ColumnDef.html @@ -1 +1 @@ -ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown
    +ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown
    diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index 40ac611b8b..6ab5469991 100644 --- a/platform-bible-react/types/ComboBoxLabelOption.html +++ b/platform-bible-react/types/ComboBoxLabelOption.html @@ -1 +1 @@ -ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }
    +ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }
    diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index 0952b31ec6..80b1b95691 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react
    +ComboBoxOption | platform-bible-react
    diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index af52151e35..aa5f9cfb9a 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -1,10 +1,9 @@ -ComboBoxProps | platform-bible-react

    Type AliasComboBoxProps<T>

    ComboBoxProps<T>: {
        alignDropDown?: "start" | "center" | "end";
        buttonClassName?: string;
        buttonPlaceholder?: string;
        buttonVariant?: ButtonProps["variant"];
        className?: string;
        commandEmptyMessage?: string;
        dir?: Direction;
        getOptionLabel?: ((option: ComboBoxOption) => string);
        icon?: ReactNode;
        id?: string;
        isDisabled?: boolean;
        onChange?: ((newValue: T) => void);
        options?: readonly T[];
        popoverContentClassName?: string;
        textPlaceholder?: string;
        value?: T;
    } & PopoverProps

    Type Parameters

    • T

    Type declaration

    • OptionalalignDropDown?: "start" | "center" | "end"

      Control how the popover menu should be aligned. Defaults to start

      +ComboBoxProps | platform-bible-react

      Type AliasComboBoxProps<T>

      ComboBoxProps<T>: {
          alignDropDown?: "start" | "center" | "end";
          buttonClassName?: string;
          buttonPlaceholder?: string;
          buttonVariant?: ButtonProps["variant"];
          className?: string;
          commandEmptyMessage?: string;
          getOptionLabel?: ((option: ComboBoxOption) => string);
          icon?: ReactNode;
          id?: string;
          isDisabled?: boolean;
          onChange?: ((newValue: T) => void);
          options?: readonly T[];
          popoverContentClassName?: string;
          textPlaceholder?: string;
          value?: T;
      } & PopoverProps

      Type Parameters

      • T

      Type declaration

      • OptionalalignDropDown?: "start" | "center" | "end"

        Control how the popover menu should be aligned. Defaults to start

      • OptionalbuttonClassName?: string

        Additional css classes to help with unique styling of the combo box button

      • OptionalbuttonPlaceholder?: string

        Text displayed on button if value is undefined

      • OptionalbuttonVariant?: ButtonProps["variant"]

        Variant of button

      • OptionalclassName?: string

        3 December 2024. Renamed to buttonClassName

      • OptionalcommandEmptyMessage?: string

        Text to display when no options match input

        -
      • Optionaldir?: Direction

        Text direction ltr or rtl

      • OptionalgetOptionLabel?: ((option: ComboBoxOption) => string)

        Used to determine the string value for a given option.

      • Optionalicon?: ReactNode

        Icon to be displayed on the trigger

      • Optionalid?: string

        Optional unique identifier

        @@ -15,4 +14,4 @@
      • OptionaltextPlaceholder?: string

        Placeholder text for text field

      • Optionalvalue?: T

        The selected value that the combo box currently holds. Must be shallow equal to one of the options entries.

        -
      +
    diff --git a/platform-bible-react/types/DropdownGroup.html b/platform-bible-react/types/DropdownGroup.html index fa226cef56..5a684d5022 100644 --- a/platform-bible-react/types/DropdownGroup.html +++ b/platform-bible-react/types/DropdownGroup.html @@ -1,4 +1,4 @@ DropdownGroup | platform-bible-react

    Type AliasDropdownGroup

    DropdownGroup: {
        items: DropdownItem[];
        label: string;
    }

    Type declaration

    • items: DropdownItem[]

      The items array contains the items that will be displayed in the dropdown group

    • label: string

      The label is the text that will be displayed on the dropdown group. It is used to categorize the items in the group.

      -
    +
    diff --git a/platform-bible-react/types/DropdownItem.html b/platform-bible-react/types/DropdownItem.html index 40de0cbe97..3d04a66b7b 100644 --- a/platform-bible-react/types/DropdownItem.html +++ b/platform-bible-react/types/DropdownItem.html @@ -1,4 +1,4 @@ DropdownItem | platform-bible-react

    Type AliasDropdownItem

    DropdownItem: {
        itemType: DropdownMenuItemType;
        label: string;
        onClick: (() => void);
    }

    Type declaration

    • itemType: DropdownMenuItemType

      The itemType determines the DropdownMenuItemType type as either Check or Radio.

    • label: string

      The label is the text that will be displayed on the dropdown item.

    • onClick: (() => void)

      The onClick function is called when the item is clicked.

      -
        • (): void
        • Returns void

    +
      • (): void
      • Returns void

    diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index 2c2d742647..ab27d9d304 100644 --- a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html +++ b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html @@ -1 +1 @@ -DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }
    +DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index 9988f91621..946ae7713f 100644 --- a/platform-bible-react/types/DropdownMenuContentProps.html +++ b/platform-bible-react/types/DropdownMenuContentProps.html @@ -1 +1 @@ -DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }
    +DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }
    diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index 6dabdecfda..d6947b4008 100644 --- a/platform-bible-react/types/DropdownMenuItemProps.html +++ b/platform-bible-react/types/DropdownMenuItemProps.html @@ -1 +1 @@ -DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }
    +DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }
    diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index a17fbf0972..e4cc0035be 100644 --- a/platform-bible-react/types/DropdownMenuLabelProps.html +++ b/platform-bible-react/types/DropdownMenuLabelProps.html @@ -1 +1 @@ -DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }
    +DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }
    diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index 1ab0362f7b..488ad284b3 100644 --- a/platform-bible-react/types/DropdownMenuRadioItemProps.html +++ b/platform-bible-react/types/DropdownMenuRadioItemProps.html @@ -1 +1 @@ -DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }
    +DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index 3cd80e18dd..2e63bc417d 100644 --- a/platform-bible-react/types/DropdownMenuSeparatorProps.html +++ b/platform-bible-react/types/DropdownMenuSeparatorProps.html @@ -1 +1 @@ -DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }
    +DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index 6cdc2737e3..78eb096db1 100644 --- a/platform-bible-react/types/DropdownMenuShortcutProps.html +++ b/platform-bible-react/types/DropdownMenuShortcutProps.html @@ -1 +1 @@ -DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }
    +DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index 36c81e3866..88c9cf24e9 100644 --- a/platform-bible-react/types/DropdownMenuSubContentProps.html +++ b/platform-bible-react/types/DropdownMenuSubContentProps.html @@ -1 +1 @@ -DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }
    +DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }
    diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index e49a7b5a29..699a5de6a8 100644 --- a/platform-bible-react/types/DropdownMenuSubTriggerProps.html +++ b/platform-bible-react/types/DropdownMenuSubTriggerProps.html @@ -1 +1 @@ -DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }
    +DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }
    diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index d314c096b4..43b2c5fae3 100644 --- a/platform-bible-react/types/GridMenuInfo.html +++ b/platform-bible-react/types/GridMenuInfo.html @@ -1,2 +1,2 @@ GridMenuInfo | platform-bible-react

    Type AliasGridMenuInfo

    GridMenuInfo: {
        multiColumnMenu: Localized<MultiColumnMenu>;
    }

    Type declaration

    • multiColumnMenu: Localized<MultiColumnMenu>

      The menu object containing information about the columns, groups, and items to display.

      -
    +
    diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index fc1272f592..0c4ade00cc 100644 --- a/platform-bible-react/types/GridMenuProps.html +++ b/platform-bible-react/types/GridMenuProps.html @@ -1,3 +1,3 @@ GridMenuProps | platform-bible-react

    Type AliasGridMenuProps

    GridMenuProps: GridMenuInfo & {
        className?: string;
        commandHandler: CommandHandler;
        id?: string;
    }

    Type declaration

    • OptionalclassName?: string

      Additional css classes to help with unique styling of the grid menu

    • commandHandler: CommandHandler
    • Optionalid?: string

      Optional unique identifier

      -
    +
    diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 4d3f372eb7..ac79245781 100644 --- a/platform-bible-react/types/IconButtonProps.html +++ b/platform-bible-react/types/IconButtonProps.html @@ -19,4 +19,4 @@
  • Optionaltooltip?: string

    Optional tooltip to display if different from the aria-label.

    -
  • +
    diff --git a/platform-bible-react/types/InventoryItemOccurrence.html b/platform-bible-react/types/InventoryItemOccurrence.html index aac69c6cf1..5d613ac427 100644 --- a/platform-bible-react/types/InventoryItemOccurrence.html +++ b/platform-bible-react/types/InventoryItemOccurrence.html @@ -1,4 +1,4 @@ InventoryItemOccurrence | platform-bible-react

    Type AliasInventoryItemOccurrence

    InventoryItemOccurrence: {
        reference: ScriptureReference;
        text: string;
    }

    Occurrence of item in inventory. Primarily used by table that shows occurrences

    Type declaration

    • reference: ScriptureReference

      Reference to scripture where the item appears

    • text: string

      Snippet of scripture that contains the occurrence

      -
    +
    diff --git a/platform-bible-react/types/InventoryLocalizedStrings.html b/platform-bible-react/types/InventoryLocalizedStrings.html index db9ac6b9f6..4f46a5f710 100644 --- a/platform-bible-react/types/InventoryLocalizedStrings.html +++ b/platform-bible-react/types/InventoryLocalizedStrings.html @@ -1 +1 @@ -InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }
    +InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }
    diff --git a/platform-bible-react/types/InventoryTableData.html b/platform-bible-react/types/InventoryTableData.html index a5d6338e37..d00c6e5327 100644 --- a/platform-bible-react/types/InventoryTableData.html +++ b/platform-bible-react/types/InventoryTableData.html @@ -7,4 +7,4 @@ prop for the Inventory component

  • occurrences: InventoryItemOccurrence[]

    Occurrences of this item in the scripture text for the selected scope

  • status: Status

    The status of this item (see documentation for Status type for more information)

    -
  • +
    diff --git a/platform-bible-react/types/LanguageInfo.html b/platform-bible-react/types/LanguageInfo.html index ad8606ba80..429e1733eb 100644 --- a/platform-bible-react/types/LanguageInfo.html +++ b/platform-bible-react/types/LanguageInfo.html @@ -3,4 +3,4 @@ never be displayed unless typed by the user.

  • OptionaluiNames?: Record<string, string>

    The name of the language in other languages, so that the language can also be displayed in the current UI language, if known.

    -
  • +
    diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index fb33dd7e67..a33145e248 100644 --- a/platform-bible-react/types/MenuItemListProps.html +++ b/platform-bible-react/types/MenuItemListProps.html @@ -1,2 +1,2 @@ MenuItemListProps | platform-bible-react

    Type AliasMenuItemListProps

    MenuItemListProps: MenuPropsBase & {
        columnId?: ReferencedItem;
    }

    Type declaration

    • OptionalcolumnId?: ReferencedItem

      Optional unique (column) identifier

      -
    +
    diff --git a/platform-bible-react/types/ProjectInfo.html b/platform-bible-react/types/ProjectInfo.html index cee62fb937..fabb2e4305 100644 --- a/platform-bible-react/types/ProjectInfo.html +++ b/platform-bible-react/types/ProjectInfo.html @@ -1 +1 @@ -ProjectInfo | platform-bible-react

    Type AliasProjectInfo

    ProjectInfo: {
        projectId: string;
        projectName: string;
    }
    +ProjectInfo | platform-bible-react

    Type AliasProjectInfo

    ProjectInfo: {
        projectId: string;
        projectName: string;
    }
    diff --git a/platform-bible-react/types/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index 14688b7207..947dc2f9f7 100644 --- a/platform-bible-react/types/ResultsSet.html +++ b/platform-bible-react/types/ResultsSet.html @@ -3,4 +3,4 @@ sources.

    Type declaration

    • data: ScriptureItemDetail[]

      Array of Scripture item details (messages keyed by Scripture reference).

    • source: ResultsSource

      The backing source associated with this set of results.

      -
    +
    diff --git a/platform-bible-react/types/ResultsSource.html b/platform-bible-react/types/ResultsSource.html index 039163b8a5..2a9b4d6e74 100644 --- a/platform-bible-react/types/ResultsSource.html +++ b/platform-bible-react/types/ResultsSource.html @@ -3,4 +3,4 @@ sources.

    Type declaration

    • displayName: string

      Name (potentially localized) of the source, suitable for display in the UI.

    • id: string

      Uniquely identifies the source.

      -
    +
    diff --git a/platform-bible-react/types/RowContents.html b/platform-bible-react/types/RowContents.html index 6c86ce7abf..9fc8370dd4 100644 --- a/platform-bible-react/types/RowContents.html +++ b/platform-bible-react/types/RowContents.html @@ -1 +1 @@ -RowContents | platform-bible-react
    +RowContents | platform-bible-react
    diff --git a/platform-bible-react/types/Scope.html b/platform-bible-react/types/Scope.html index 4bc51195d8..6fde794968 100644 --- a/platform-bible-react/types/Scope.html +++ b/platform-bible-react/types/Scope.html @@ -1,2 +1,2 @@ Scope | platform-bible-react
    Scope: "book" | "chapter" | "verse"

    Scope of scripture that the inventory can operate on

    -
    +
    diff --git a/platform-bible-react/types/ScriptureItemDetail.html b/platform-bible-react/types/ScriptureItemDetail.html index 6db8fd3c04..4ce1d55fde 100644 --- a/platform-bible-react/types/ScriptureItemDetail.html +++ b/platform-bible-react/types/ScriptureItemDetail.html @@ -3,4 +3,4 @@

    Type declaration

    • detail: string

      Text of the error, note, etc. In the future, we might want to support something more than just text so that a JSX element could be provided with a link or some other controls related to the issue being reported.

      -
    +
    diff --git a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html index 2ad12eeb2f..d78c5e252f 100644 --- a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html +++ b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html @@ -2,4 +2,4 @@
  • OptionalscriptureBookGroupName?: string

    Optional text to display to refer to the Scripture book group. Default value: 'Scripture Book'.

  • OptionalscriptureReferenceColumnName?: string

    Optional header to display for the Reference column. Default value: 'Scripture Reference'.

  • OptionaltypeColumnName?: string

    Optional header to display for the Type column. Default value: 'Type'.

    -
  • +
    diff --git a/platform-bible-react/types/ScriptureResultsViewerProps.html b/platform-bible-react/types/ScriptureResultsViewerProps.html index 9e74581e9c..3621c81a32 100644 --- a/platform-bible-react/types/ScriptureResultsViewerProps.html +++ b/platform-bible-react/types/ScriptureResultsViewerProps.html @@ -1,6 +1,5 @@ -ScriptureResultsViewerProps | platform-bible-react

    Type AliasScriptureResultsViewerProps

    ScriptureResultsViewerProps: ScriptureResultsViewerColumnInfo & {
        direction?: "ltr" | "rtl";
        onRowSelected?: ((selectedRow: ScriptureSrcItemDetail | undefined) => void);
        showColumnHeaders?: boolean;
        showSourceColumn?: boolean;
        sources: ResultsSet[];
    }

    Type declaration

    diff --git a/platform-bible-react/types/ScriptureSrcItemDetail.html b/platform-bible-react/types/ScriptureSrcItemDetail.html index e8f4c6eedb..a6f359b89d 100644 --- a/platform-bible-react/types/ScriptureSrcItemDetail.html +++ b/platform-bible-react/types/ScriptureSrcItemDetail.html @@ -1,2 +1,2 @@ ScriptureSrcItemDetail | platform-bible-react

    Type AliasScriptureSrcItemDetail

    ScriptureSrcItemDetail: ScriptureItemDetail & {
        source: ResultsSource;
    }

    Type declaration

    • source: ResultsSource

      Source/type of detail. Can be used for grouping.

      -
    +
    diff --git a/platform-bible-react/types/ScrollGroupSelectorProps.html b/platform-bible-react/types/ScrollGroupSelectorProps.html index c4bf8d11fc..eec71ec4ad 100644 --- a/platform-bible-react/types/ScrollGroupSelectorProps.html +++ b/platform-bible-react/types/ScrollGroupSelectorProps.html @@ -17,4 +17,4 @@
  • onChangeScrollGroupId: ((newScrollGroupId: ScrollGroupId | undefined) => void)

    Callback function run when the user tries to change the scroll group id

      • (newScrollGroupId): void
      • Parameters

        • newScrollGroupId: ScrollGroupId | undefined

        Returns void

  • scrollGroupId: ScrollGroupId | undefined

    Currently selected scroll group id. undefined for no scroll group

    -
  • +
    diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index b793d8d6a6..51733dffa9 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -3,4 +3,4 @@
  • OptionalisFullWidth?: boolean

    Optional boolean to set the input base to full width

  • onSearch: ((searchQuery: string) => void)

    Callback fired to handle the search query when button pressed

      • (searchQuery): void
      • Parameters

        • searchQuery: string

        Returns void

  • Optionalplaceholder?: string

    Optional string that appears in the search bar without a search string

    -
  • +
    diff --git a/platform-bible-react/types/SelectedSettingsSidebarItem.html b/platform-bible-react/types/SelectedSettingsSidebarItem.html index 44b8e64282..5d4695b79a 100644 --- a/platform-bible-react/types/SelectedSettingsSidebarItem.html +++ b/platform-bible-react/types/SelectedSettingsSidebarItem.html @@ -1 +1 @@ -SelectedSettingsSidebarItem | platform-bible-react

    Type AliasSelectedSettingsSidebarItem

    SelectedSettingsSidebarItem: {
        label: string;
        projectId?: string;
    }
    +SelectedSettingsSidebarItem | platform-bible-react

    Type AliasSelectedSettingsSidebarItem

    SelectedSettingsSidebarItem: {
        label: string;
        projectId?: string;
    }
    diff --git a/platform-bible-react/types/SettingsSidebarProps.html b/platform-bible-react/types/SettingsSidebarProps.html index aabbb74c06..9b2ebcc802 100644 --- a/platform-bible-react/types/SettingsSidebarProps.html +++ b/platform-bible-react/types/SettingsSidebarProps.html @@ -6,4 +6,4 @@
  • projectInfo: ProjectInfo[]

    Project names and ids

  • projectsSidebarGroupLabel: string

    Label for the group of projects settings

  • selectedSidebarItem: SelectedSettingsSidebarItem

    The current selected value in the sidebar

    -
  • +
    diff --git a/platform-bible-react/types/SortDirection.html b/platform-bible-react/types/SortDirection.html index 455b6bb25a..ffe813fd6a 100644 --- a/platform-bible-react/types/SortDirection.html +++ b/platform-bible-react/types/SortDirection.html @@ -1 +1 @@ -SortDirection | platform-bible-react
    +SortDirection | platform-bible-react
    diff --git a/platform-bible-react/types/SpinnerProps.html b/platform-bible-react/types/SpinnerProps.html index 2a037ba8c5..cddff915d6 100644 --- a/platform-bible-react/types/SpinnerProps.html +++ b/platform-bible-react/types/SpinnerProps.html @@ -1 +1 @@ -SpinnerProps | platform-bible-react
    +SpinnerProps | platform-bible-react
    diff --git a/platform-bible-react/types/TabKeyValueContent.html b/platform-bible-react/types/TabKeyValueContent.html index 7b74fbd8b3..408c0e9949 100644 --- a/platform-bible-react/types/TabKeyValueContent.html +++ b/platform-bible-react/types/TabKeyValueContent.html @@ -1 +1 @@ -TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }
    +TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }
    diff --git a/platform-bible-react/types/TableContents.html b/platform-bible-react/types/TableContents.html index e19f371b2b..e910979096 100644 --- a/platform-bible-react/types/TableContents.html +++ b/platform-bible-react/types/TableContents.html @@ -1 +1 @@ -TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData
    +TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData
    diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index f541ef9bff..a4f2ab0062 100644 --- a/platform-bible-react/types/TextFieldProps.html +++ b/platform-bible-react/types/TextFieldProps.html @@ -24,4 +24,4 @@
  • OptionalonFocus?: FocusEventHandler<HTMLInputElement>

    Triggers when textfield gets focus

  • Optionalplaceholder?: string

    The short hint displayed in the input before the user enters a value.

  • Optionalvalue?: string | number

    Value of the text field if controlled

    -
  • +
    diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index f6fd5c21c2..e6de0ed581 100644 --- a/platform-bible-react/types/ToolbarProps.html +++ b/platform-bible-react/types/ToolbarProps.html @@ -3,4 +3,4 @@
  • Optionalid?: string

    Optional unique identifier

  • OptionalmenuProvider?: MultiColumnMenuProvider

    The optional delegate to use to get the menu data. If not specified, the "hamburger" menu will not display.

    -
  • +
    diff --git a/platform-bible-react/types/UiLanguageSelectorProps.html b/platform-bible-react/types/UiLanguageSelectorProps.html index bf503c6020..932bf31043 100644 --- a/platform-bible-react/types/UiLanguageSelectorProps.html +++ b/platform-bible-react/types/UiLanguageSelectorProps.html @@ -1,5 +1,4 @@ -UiLanguageSelectorProps | platform-bible-react

    Type AliasUiLanguageSelectorProps

    UiLanguageSelectorProps: {
        className?: string;
        direction?: "ltr" | "rtl";
        fallbackLanguages: string[] | undefined;
        knownUiLanguages: Record<string, LanguageInfo>;
        localizedStrings: UiLanguageSelectorLocalizedStrings;
        onFallbackLanguagesChange?: ((newFallbackLanguages: string[]) => void);
        onLanguagesChange?: ((newUiLanguages: string[]) => void);
        onPrimaryLanguageChange?: ((newPrimaryUiLanguage: string) => void);
        primaryLanguage: string;
    }

    Type declaration

    • OptionalclassName?: string

      Additional css classes to help with unique styling of the control

      -
    • Optionaldirection?: "ltr" | "rtl"

      Interface direction

      +UiLanguageSelectorProps | platform-bible-react

      Type AliasUiLanguageSelectorProps

      UiLanguageSelectorProps: {
          className?: string;
          fallbackLanguages: string[] | undefined;
          knownUiLanguages: Record<string, LanguageInfo>;
          localizedStrings: UiLanguageSelectorLocalizedStrings;
          onFallbackLanguagesChange?: ((newFallbackLanguages: string[]) => void);
          onLanguagesChange?: ((newUiLanguages: string[]) => void);
          onPrimaryLanguageChange?: ((newPrimaryUiLanguage: string) => void);
          primaryLanguage: string;
      }

      Type declaration

      • OptionalclassName?: string

        Additional css classes to help with unique styling of the control

      • fallbackLanguages: string[] | undefined

        Ordered list of fallback language tags to use if the localization key can't be found in the current primary UI language. This list never contains English ('en') because it is the ultimate fallback.

        @@ -13,4 +12,4 @@ languages in order of decreasing preference.

          • (newUiLanguages): void
          • Parameters

            • newUiLanguages: string[]

            Returns void

      • OptionalonPrimaryLanguageChange?: ((newPrimaryUiLanguage: string) => void)

        Handler for the primary language changes.

          • (newPrimaryUiLanguage): void
          • Parameters

            • newPrimaryUiLanguage: string

            Returns void

      • primaryLanguage: string

        IETF BCP-47 language tag of the current primary UI language. undefined => 'en'

        -
      +
    diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index f0ede4d9bf..6c8f300bd7 100644 --- a/platform-bible-react/types/UsePromiseOptions.html +++ b/platform-bible-react/types/UsePromiseOptions.html @@ -1,3 +1,3 @@ UsePromiseOptions | platform-bible-react

    Type AliasUsePromiseOptions

    UsePromiseOptions: {
        preserveValue?: boolean;
    }

    Type declaration

    • OptionalpreserveValue?: boolean

      Whether to leave the value as the most recent resolved promise value or set it back to defaultValue while running the promise again. Defaults to true

      -
    +
    diff --git a/platform-bible-react/types/VersionHistoryType.html b/platform-bible-react/types/VersionHistoryType.html index 0fba0f5402..040091eaec 100644 --- a/platform-bible-react/types/VersionHistoryType.html +++ b/platform-bible-react/types/VersionHistoryType.html @@ -1,2 +1,2 @@ VersionHistoryType | platform-bible-react

    Type AliasVersionHistoryType

    VersionHistoryType: Record<string, VersionInformation>

    Type to store the version history information

    -
    +
    diff --git a/platform-bible-react/types/VersionInformation.html b/platform-bible-react/types/VersionInformation.html index 3d8f4e14c3..710ece99e5 100644 --- a/platform-bible-react/types/VersionInformation.html +++ b/platform-bible-react/types/VersionInformation.html @@ -1,3 +1,3 @@ VersionInformation | platform-bible-react

    Type AliasVersionInformation

    VersionInformation: {
        date: string;
        description: string;
    }

    Type declaration

    • date: string

      Date the version was published

    • description: string

      Description of the changes in the version

      -
    +
    diff --git a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html index bdea2ad4da..ef5f390094 100644 --- a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html +++ b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html @@ -1,4 +1,4 @@ BOOK_SELECTOR_STRING_KEYS | platform-bible-react

    VariableBOOK_SELECTOR_STRING_KEYSConst

    BOOK_SELECTOR_STRING_KEYS: readonly ["%webView_bookSelector_currentBook%", "%webView_bookSelector_choose%", "%webView_bookSelector_chooseBooks%"] = ...

    Object containing all keys used for localization in this component. If you're using this component in an extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of this component

    -
    +
    diff --git a/platform-bible-react/variables/FILTERABLE_RESOURCE_LIST_STRING_KEYS.html b/platform-bible-react/variables/FILTERABLE_RESOURCE_LIST_STRING_KEYS.html index 37c03467a1..df3920a373 100644 --- a/platform-bible-react/variables/FILTERABLE_RESOURCE_LIST_STRING_KEYS.html +++ b/platform-bible-react/variables/FILTERABLE_RESOURCE_LIST_STRING_KEYS.html @@ -1 +1 @@ -FILTERABLE_RESOURCE_LIST_STRING_KEYS | platform-bible-react

    VariableFILTERABLE_RESOURCE_LIST_STRING_KEYSConst

    FILTERABLE_RESOURCE_LIST_STRING_KEYS: LocalizeKey[] = ...
    +FILTERABLE_RESOURCE_LIST_STRING_KEYS | platform-bible-react

    VariableFILTERABLE_RESOURCE_LIST_STRING_KEYSConst

    FILTERABLE_RESOURCE_LIST_STRING_KEYS: LocalizeKey[] = ...
    diff --git a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html index 1d749fcd0b..7448465bb3 100644 --- a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html +++ b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html @@ -1,4 +1,4 @@ INVENTORY_STRING_KEYS | platform-bible-react

    VariableINVENTORY_STRING_KEYSConst

    INVENTORY_STRING_KEYS: readonly ["%webView_inventory_all%", "%webView_inventory_approved%", "%webView_inventory_unapproved%", "%webView_inventory_unknown%", "%webView_inventory_scope_currentBook%", "%webView_inventory_scope_chapter%", "%webView_inventory_scope_verse%", "%webView_inventory_filter_text%", "%webView_inventory_show_additional_items%", "%webView_inventory_occurrences_table_header_reference%", "%webView_inventory_occurrences_table_header_occurrence%"] = ...

    Object containing all keys used for localization in this component. If you're using this component in an extension, you can pass it into the useLocalizedStrings hook to easily obtain the localized strings and pass them into the localizedStrings prop of this component

    -
    +
    diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 246b658674..04c2835646 100644 --- a/platform-bible-utils/classes/AsyncVariable.html +++ b/platform-bible-utils/classes/AsyncVariable.html @@ -1,5 +1,5 @@ AsyncVariable | platform-bible-utils

    ClassAsyncVariable<T>

    This class provides a convenient way for one task to wait on a variable that another task sets.

    -

    Type Parameters

    • T

    Constructors

    Type Parameters

    • T

    Constructors

    Accessors

    Methods

    rejectWithReason @@ -9,17 +9,17 @@
  • rejectIfNotSettledWithinMS: number = 10000

    Milliseconds to wait before verifying if the promise was settled (resolved or rejected); will reject if it has not settled by that time. Use -1 if you do not want a timeout at all. Defaults to 10000 ms

    -
  • Returns AsyncVariable<T>

    Accessors

    • get hasSettled(): boolean
    • A simple way to see if this variable's promise was resolved or rejected already

      +

    Returns AsyncVariable<T>

    Accessors

    • get promise(): Promise<T>
    • Get this variable's promise to a value. This always returns the same promise even after the value has been resolved or rejected.

      Returns Promise<T>

      The promise for the value to be set

      -

    Methods

    Methods

    • Reject this variable's promise for the value with the given reason

      Parameters

      • reason: string

        This variable's promise will be rejected with this reason

      • throwIfAlreadySettled: boolean = false

        Determines whether to throw if the variable was already resolved or rejected. Defaults to false

        -

      Returns void

    • Resolve this variable's promise to the given value

      +

    Returns void

    • Resolve this variable's promise to the given value

      Parameters

      • value: T

        This variable's promise will resolve to this value

      • throwIfAlreadySettled: boolean = false

        Determines whether to throw if the variable was already resolved or rejected. Defaults to false

        -

      Returns void

    +

    Returns void

    diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index 5f9de46279..795fcffe99 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,14 +1,14 @@ Collator | platform-bible-utils

    Enables language-sensitive string comparison. Wraps Intl.Collator

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Compares two strings according to the sort order of this Collator object

      +

    Constructors

    Methods

    • Compares two strings according to the sort order of this Collator object

      Parameters

      • string1: string

        String to compare

      • string2: string

        String to compare

      Returns number

      A number indicating how string1 and string2 compare to each other according to the sort order of this Collator object. Negative value if string1 comes before string2. Positive value if string1 comes after string2. 0 if they are considered equal.

      -
    • Returns a new object with properties reflecting the locale and collation options computed during initialization of this collator object.

      Returns ResolvedCollatorOptions

      ResolvedCollatorOptions object

      -
    +
    diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index 86df62ebae..9be0d1c06a 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,29 +1,29 @@ DateTimeFormat | platform-bible-utils

    Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

    -

    Constructors

    Constructors

    Methods

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      +

    Constructors

    Methods

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns string

      String representing the given date formatted according to the locale and formatting options of this DateTimeFormat object

      -
    • Formats a date range in the most concise way based on the locales and options provided when instantiating this DateTimeFormat object

      Parameters

      • startDate: Date

        Date object representing start of the date range

      • endDate: Date

        Date object representing the end of the date range

      Returns string

      String representing the given date range formatted according to the locale and formatting options of this DateTimeFormat object

      -
    • Returns an array of locale-specific tokens representing each part of the formatted date range produced by this DateTimeFormat object

      Parameters

      • startDate: Date

        Date object representing start of the date range

      • endDate: Date

        Date object representing the end of the date range

      Returns DateTimeRangeFormatPart[]

      Array of DateTimeRangeFormatPart objects

      -
    • Allows locale-aware formatting of strings produced by this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns DateTimeFormatPart[]

      Array of DateTimeFormatPart objects

      -
    • Returns a new object with properties reflecting the locale and date and time formatting options computed during initialization of this DateTimeFormat object

      Returns ResolvedDateTimeFormatOptions

      ResolvedDateTimeFormatOptions object

      -
    +
    diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index c0205ba893..710a4dfaab 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

    Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Returns DocumentCombiner

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered indeterminate as it depends on the order in which Map.forEach iterates over the contributions. However, the order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is is @@ -32,22 +32,22 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -
    • Transform the starting document that is given to the combiner. This transformation occurs after validating the base document and before combining any contributions.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the baseDocument passed in.

      Parameters

      • baseDocument: JsonDocumentLike

        Initial input document. Already validated via validateBaseDocument

      Returns JsonDocumentLike

      Transformed base document

      -
    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -55,19 +55,19 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -
    • Transform the document that is the composition of the base document and all contribution documents. This is the last step that will be run prior to validation via validateOutput before this.latestOutput is updated to the new output.

      Parameters

      • finalOutput: JsonDocumentLike

        Final output document that could potentially be returned to callers. "Final" means no further contribution documents will be merged.

        -

      Returns JsonDocumentLike

    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    • Throw an error if the provided document is not a valid contribution document.

      Parameters

      • documentName: string

        Name of the contributed document to combine

      • document: JsonDocumentLike

        Content of the contributed document to combine

        -

      Returns void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    +

    Returns void

    diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index 09675a8cd0..a0d193f862 100644 --- a/platform-bible-utils/classes/Mutex.html +++ b/platform-bible-utils/classes/Mutex.html @@ -4,7 +4,7 @@

    See async-mutex for more information.

    -

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    Methods

    acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index 40f30e8e03..9fa5110d0c 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,4 +1,4 @@ MutexMap | platform-bible-utils

    Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

    -

    Constructors

    Constructors

    Methods

    get -

    Constructors

    Methods

    +

    Constructors

    Methods

    diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 5daf5a1a86..7b55e30d6f 100644 --- a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html +++ b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html @@ -1,6 +1,6 @@ NonValidatingDocumentCombiner | platform-bible-utils

    ClassNonValidatingDocumentCombiner

    Base class for any code that wants to compose JSON documents (primarily in the form of JS objects or arrays) together into a single output document.

    -

    Hierarchy (view full)

    Constructors

    Hierarchy (view full)

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    -

    Accessors

    Methods

    • Add or update one of the contribution documents for the composition process

      +

    Constructors

    Properties

    baseDocument: JsonDocumentLike
    contributions: Map<string, JsonDocumentLike> = ...
    latestOutput: undefined | JsonDocumentLike
    onDidRebuild: PlatformEvent<undefined> = ...

    Event that emits to announce that the document has been rebuilt and the output has been updated

    +

    Accessors

    Methods

    • Add or update one of the contribution documents for the composition process

      Note: the order in which contribution documents are added can be considered indeterminate as it depends on the order in which Map.forEach iterates over the contributions. However, the order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties is is @@ -30,22 +30,22 @@

    • document: JsonDocumentLike

      Content of the contributed document to combine

    Returns undefined | JsonDocumentLike

    Recalculated output document given the new or updated contribution and existing other documents

    -
    • Transform the contributed document associated with documentName. This transformation occurs after validating the contributed document and before combining with other documents.

      WARNING: If you do not create the combiner with option copyDocuments: true or clone inside this method, this method will directly modify the contributed document passed in.

      @@ -53,19 +53,19 @@
    • document: JsonDocumentLike

      Content of the contributed document to combine. Already validated via validateContribution

    Returns JsonDocumentLike

    Transformed contributed document

    -
    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    +

    Returns void

    diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index 9b03350d12..7626460f51 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,30 +1,30 @@ NumberFormat | platform-bible-utils

    Enables language-sensitive number formatting. Wraps Intl.NumberFormat

    -

    Constructors

    Constructors

    Methods

    • Formats a number according to the locale and formatting options of this NumberFormat object

      +

    Constructors

    Methods

    • Formats a number according to the locale and formatting options of this NumberFormat object

      Parameters

      • value: number | bigint

        Number or BigInt to format

      Returns string

      String representing the given number formatted according to the locale and formatting options of this NumberFormat object

      -
    • Formats a range of numbers according to the locale and formatting options of this NumberFormat object

      Parameters

      • startRange: number | bigint

        Number or bigint representing the start of the range

      • endRange: number | bigint

        Number or bigint representing the end of the range

      Returns string

      String representing the given range of numbers formatted according to the locale and formatting options of this NumberFormat object

      -
    • Returns an array of objects containing the locale-specific tokens from which it is possible to build custom strings while preserving the locale-specific parts.

      Parameters

      • startRange: number | bigint

        Number or bigint representing start of the range

      • endRange: number | bigint

        Number or bigint representing end of the range

      Returns NumberRangeFormatPart[]

      Array of NumberRangeFormatPart objects containing the formatted range of numbers in parts

      -
    • Allows locale-aware formatting of strings produced by this NumberFormat object

      Parameters

      • value: number | bigint

        Number or bigint to format

      Returns NumberFormatPart[]

      Array of NumberFormatPart objects containing the formatted number in parts

      -
    • Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

      Returns ResolvedNumberFormatOptions

      ResolvedNumberFormatOptions object

      -
    +
    diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index b434f72565..39abb1ddc6 100644 --- a/platform-bible-utils/classes/PlatformEventEmitter.html +++ b/platform-bible-utils/classes/PlatformEventEmitter.html @@ -3,7 +3,7 @@ eventEmitter.emit(event) to run the subscriptions. Generally, this EventEmitter should be private, and its event should be public. That way, the emitter is not publicized, but anyone can subscribe to the event.

    -

    Type Parameters

    • T

    Implements

    Constructors

    Type Parameters

    • T

    Implements

    Constructors

    Properties

    Accessors

    Methods

    assertNotDisposed @@ -16,16 +16,16 @@

    Unsubscriber function to run to stop calling the passed-in function when the event is emitted

    event

    -

    Accessors

    • get event(): PlatformEvent<T>
    • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

    Accessors

    Methods

    Methods

    • Function that runs the subscriptions for the event. Added here so children can override emit +

    Returns void

    +

    Parameters

    • event: T

    Returns void

    diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index f5b09e2de1..dc6d540d1b 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,10 +1,10 @@ UnsubscriberAsyncList | platform-bible-utils

    Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    • Add unsubscribers to the list. Note that duplicates are not added twice.

      +

    Constructors

    Properties

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    • Run all unsubscribers added to this list and then clear the list.

      +

    Returns void

    +
    diff --git a/platform-bible-utils/classes/UsjReaderWriter.html b/platform-bible-utils/classes/UsjReaderWriter.html index e74bae0cdd..c1219667da 100644 --- a/platform-bible-utils/classes/UsjReaderWriter.html +++ b/platform-bible-utils/classes/UsjReaderWriter.html @@ -1,5 +1,5 @@ UsjReaderWriter | platform-bible-utils

    Represents USJ formatted scripture with helpful utilities for working with it

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    • Return a copy of text following a given starting point

      +

    Constructors

    Methods

    • Return a copy of text between two points

      +

    Returns string

    • Given a starting point, find the next location in this USJ data that matches the given text

      Parameters

      • startingPoint: UsjContentLocation
      • text: string

        Text to find

      • maxTextLengthToSearch: number = 1000

        Maximum length of text to search before stopping (default is 1000)

      Returns undefined | UsjContentLocation

      Object containing the USJ node where text begins (it might be split across nodes), @@ -27,17 +27,17 @@ indicates the location of the of USJ node within usj. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -
    • Convert a JSONPath query into a VerseRef and offset

      Parameters

      • jsonPathQuery: string

        JSONPath search expression that indicates a node within this USJ data. If the expression matches more than one node, then only the first node found is considered.

      • OptionalbookId: string

        3 letter ID of the book being searched (must be defined in this USJ data if not provided here)

      Returns VerseRefOffset

      VerseRef and offset that represents the location within this USJ data indicated by jsonPathQuery

      -
    • Determine the VerseRef and offset that correspond to the location of a node somewhere within this USJ data

      Parameters

      • bookId: string

        ID of the book represented by this USJ data

      • node: MarkerContent

        JSON object representing the location of the VerseRef and offset

        @@ -45,12 +45,12 @@ 'undefined' is provided then the UsjReaderWriter will attempt to lookup the parent of node. The lookup will always fail and throw an error if node is a string.

      Returns undefined | {
          offset: number;
          verseRef: VerseRef;
      }

      VerseRef and offset representing the location of node, if one could be found

      -
    • Remove all nodes from this USJ data that match a given search function.

      Parameters

      • searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)

        Function that returns true if the given node should be removed

          • (potentiallyMatchingNode): boolean
          • Parameters

            • potentiallyMatchingNode: MarkerContent

            Returns boolean

      Returns number

      Number of nodes removed

      -
    • Convert a verse ref + offset into a node + offset within this USJ data and a JSONPath query

      Parameters

      • verseRef: VerseRef

        Indicates the book, chapter, and verse of interest to find

      • verseRefOffset: number = 0

        Specific location within verse text (defaults to 0)

      Returns UsjContentLocation

      Object containing the USJ node indicated by verseRef and verseRefOffset, offset @@ -58,4 +58,4 @@ location of the of USJ node within this USJ data. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -
    +
    diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 0aebab7e6c..38d9dc18d0 100644 --- a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html +++ b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html @@ -1,4 +1,4 @@ aggregateUnsubscriberAsyncs | platform-bible-utils

    FunctionaggregateUnsubscriberAsyncs

    Returns an UnsubscriberAsync function that combines all the unsubscribers passed in.

    +
    diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index ed12c5c93c..2991f1fe41 100644 --- a/platform-bible-utils/functions/aggregateUnsubscribers.html +++ b/platform-bible-utils/functions/aggregateUnsubscribers.html @@ -1,4 +1,4 @@ aggregateUnsubscribers | platform-bible-utils

    FunctionaggregateUnsubscribers

    Returns an Unsubscriber function that combines all the unsubscribers passed in.

    +
    diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index 38d0e5a881..6ad443fdc1 100644 --- a/platform-bible-utils/functions/at.html +++ b/platform-bible-utils/functions/at.html @@ -6,4 +6,4 @@ length(string)

    Returns string | undefined

    New string consisting of the Unicode code point located at the specified offset, undefined if index is out of bounds

    -
    +
    diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index c44f3daa69..e58c8780f7 100644 --- a/platform-bible-utils/functions/charAt.html +++ b/platform-bible-utils/functions/charAt.html @@ -6,4 +6,4 @@ length(string)-1

    Returns string

    New string consisting of the Unicode code point located at the specified offset, empty string if index is out of bounds

    -
    +
    diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index 460bc3361a..6a05c1b4b1 100644 --- a/platform-bible-utils/functions/codePointAt.html +++ b/platform-bible-utils/functions/codePointAt.html @@ -7,4 +7,4 @@ length(string)-1

    Returns number | undefined

    Non-negative integer representing the code point value of the character at the given index, or undefined if there is no element at that position

    -
    +
    diff --git a/platform-bible-utils/functions/compareScrRefs.html b/platform-bible-utils/functions/compareScrRefs.html index e77297b812..c038ece03d 100644 --- a/platform-bible-utils/functions/compareScrRefs.html +++ b/platform-bible-utils/functions/compareScrRefs.html @@ -4,4 +4,4 @@

    Returns number

    A number indicating the result of the comparison: - Negative value if scrRef1 precedes scrRef2 in sorting order. - Zero if scrRef1 and scrRef2 are equivalent in sorting order. - Positive value if scrRef1 follows scrRef2 in sorting order.

    -
    +
    diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index 6d19796a8c..a84b865508 100644 --- a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html +++ b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html @@ -7,4 +7,4 @@ does not exist on this object, it will be considered to be an asynchronous method called on the object returned from getObject.

    Returns T

    A synchronous proxy for the asynchronous object.

    -
    +
    diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index fea0de764e..6da8f4330d 100644 --- a/platform-bible-utils/functions/debounce.html +++ b/platform-bible-utils/functions/debounce.html @@ -3,4 +3,4 @@
  • delay: number = 300

    How much delay in milliseconds after the most recent call to the debounced function to call the function

  • Returns T

    Function that, when called, only calls the function passed in at maximum every delay ms

    -
    +
    diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index 091b051232..9214d5c729 100644 --- a/platform-bible-utils/functions/deepClone.html +++ b/platform-bible-utils/functions/deepClone.html @@ -2,4 +2,4 @@ references between the source and target of property copying operations.

    Type Parameters

    Parameters

    Returns T

    Duplicate copy of obj without any references back to the original one

    -
    +
    diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 67df97383b..924d555e2a 100644 --- a/platform-bible-utils/functions/deepEqual.html +++ b/platform-bible-utils/functions/deepEqual.html @@ -15,4 +15,4 @@ CodeSandbox.

    Returns boolean

    True if a and b are deeply equal; false otherwise

    -
    +
    diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index 5c12045343..e04ed1933e 100644 --- a/platform-bible-utils/functions/deserialize.html +++ b/platform-bible-utils/functions/deserialize.html @@ -9,4 +9,4 @@ the object. If a member contains nested objects, the nested objects are transformed before the parent object is. Note that null values are converted into undefined values after the reviver has run.

    -

    Returns any

    +

    Returns any

    diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index 3492560ad8..42494693f8 100644 --- a/platform-bible-utils/functions/endsWith.html +++ b/platform-bible-utils/functions/endsWith.html @@ -6,4 +6,4 @@
  • endPosition: number = ...

    End position where searchString is expected to be found. Default is length(string)

  • Returns boolean

    True if it ends with searchString, false if it does not

    -
    +
    diff --git a/platform-bible-utils/functions/ensureArray.html b/platform-bible-utils/functions/ensureArray.html index 6d792ab2f4..eb445517df 100644 --- a/platform-bible-utils/functions/ensureArray.html +++ b/platform-bible-utils/functions/ensureArray.html @@ -10,4 +10,4 @@

    Parameters

    Returns T[]

    An array containing the input value(s). If the input is undefined, an empty array is returned.

    -
    +
    diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index b4fed60198..3b94895c51 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -6,4 +6,4 @@

    Parameters

    Returns string

    import escapeStringRegexp from 'platform-bible-utils';

    const escapedString = escapeStringRegexp('How much $ for a 🦄?');
    //=> 'How much \\$ for a 🦄\\?'

    new RegExp(escapedString);
    -
    +
    diff --git a/platform-bible-utils/functions/formatBytes.html b/platform-bible-utils/functions/formatBytes.html index 4025979e6a..b26d9e010a 100644 --- a/platform-bible-utils/functions/formatBytes.html +++ b/platform-bible-utils/functions/formatBytes.html @@ -9,4 +9,4 @@
    FormatBytes(1024, 0) => "1 KB"
     
    -
    +
    diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index d031a58002..3451dd076e 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -14,4 +14,4 @@
    formatReplacementString(
    'Hi, this is {name}! I like \{curly braces\}! I have a {carColor} car. My favorite food is {food}.',
    { name: 'Bill', carColor: 'blue' }
    );

    =>

    'Hi, this is Bill! I like {curly braces}! I have a blue car. My favorite food is food.'
    -
    +
    diff --git a/platform-bible-utils/functions/formatReplacementStringToArray.html b/platform-bible-utils/functions/formatReplacementStringToArray.html index d4c1a3937f..5cc3e7f1c5 100644 --- a/platform-bible-utils/functions/formatReplacementStringToArray.html +++ b/platform-bible-utils/functions/formatReplacementStringToArray.html @@ -19,4 +19,4 @@
    formatReplacementStringToArray(
    'Hi, this is {name}! I like \{curly braces\}! I have a {carInfo} car. My favorite food is {food}.',
    { name: ['Bill'], carInfo: { year: 2015, color: 'blue' } }
    );

    =>

    ['Hi, this is ', ['Bill'], '! I like {curly braces}! I have a ', { year: 2015, color: 'blue' }, ' car. My favorite food is food.']
    -
    +
    diff --git a/platform-bible-utils/functions/formatScrRef.html b/platform-bible-utils/functions/formatScrRef.html index 478e159927..d1bfaf239e 100644 --- a/platform-bible-utils/functions/formatScrRef.html +++ b/platform-bible-utils/functions/formatScrRef.html @@ -9,4 +9,4 @@
  • OptionalbookChapterSeparator: string

    The character used to separate the book from the chapter number. Default is a single space. Note: More than one character is allowed.

  • Returns string

    The formatted reference.

    -
    +
    diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index deb8a9a881..1638f1db50 100644 --- a/platform-bible-utils/functions/getAllObjectFunctionNames.html +++ b/platform-bible-utils/functions/getAllObjectFunctionNames.html @@ -5,4 +5,4 @@

    Parameters

    Returns Set<string>

    Array of all function names on an object

    -
    +
    diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index ded1e1b2ac..32f0fa2ab8 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    +getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index 184cfd2c92..ca4473ba2d 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

    FunctiongetCurrentLocale

    • Retrieves the current locale of the user's environment.

      Returns string

      A string representing the current locale. If the locale cannot be determined, the function returns an empty string.

      -
    +
    diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 5ad277a091..a7c604fc05 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -6,4 +6,4 @@
    `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
     
    -
    +
    diff --git a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html index 52e2caeee4..59f367712b 100644 --- a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html +++ b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html @@ -1,2 +1,2 @@ getLocalizeKeyForScrollGroupId | platform-bible-utils

    FunctiongetLocalizeKeyForScrollGroupId

    +

    Parameters

    Returns LocalizeKey

    diff --git a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html index 01ad782f43..5d8052a564 100644 --- a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html +++ b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html @@ -5,4 +5,4 @@
    getLocalizeKeysForScrollGroupIds([undefined, 0, 1, 2, 3, 4]);
    // Gives localized string keys for the provided scroll group ids in an array
    -
    +
    diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index 990a216ca6..22bdf594d3 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

    Parameters

    Returns Promise<string>

    +

    Returns Promise<string>

    diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index aea8ce2254..03001d9ef2 100644 --- a/platform-bible-utils/functions/groupBy.html +++ b/platform-bible-utils/functions/groupBy.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns Map<K, T[]>

    Map of keys to groups of values corresponding to each item

    -
  • Type Parameters

    • T
    • K
    • V

    Parameters

    • items: T[]
    • keySelector: ((item: T) => K)
        • (item): K
        • Parameters

          • item: T

          Returns K

    • valueSelector: ((item: T, key: K) => V)
        • (item, key): V
        • Parameters

          • item: T
          • key: K

          Returns V

    Returns Map<K, V[]>

  • +
  • Type Parameters

    • T
    • K
    • V

    Parameters

    • items: T[]
    • keySelector: ((item: T) => K)
        • (item): K
        • Parameters

          • item: T

          Returns K

    • valueSelector: ((item: T, key: K) => V)
        • (item, key): V
        • Parameters

          • item: T
          • key: K

          Returns V

    Returns Map<K, V[]>

  • diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 3e1cf68f63..d5ef8be1b7 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

    HTML Encodes the provided string. Thanks to ChatGPT

    +
    diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index 047bcb59d5..484cd68bb3 100644 --- a/platform-bible-utils/functions/includes.html +++ b/platform-bible-utils/functions/includes.html @@ -5,4 +5,4 @@
  • searchString: string

    String to search for

  • position: number = 0

    Position within the string to start searching for searchString. Default is 0

  • Returns boolean

    True if search string is found, false if it is not

    -
    +
    diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 6a611aa06e..a6109e91a7 100644 --- a/platform-bible-utils/functions/indexOf.html +++ b/platform-bible-utils/functions/indexOf.html @@ -5,4 +5,4 @@
  • searchString: string

    The string to search for

  • position: undefined | number = 0

    Start of searching. Default is 0

  • Returns number

    Index of the first occurrence of a given string

    -
    +
    diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index d4199ebd63..f8a87cb5fc 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

    FunctionisLocalizeKey

    • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

      -

      Parameters

      • str: string

      Returns str is `%${string}%`

    +

    Parameters

    Returns str is `%${string}%`

    diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 5ac60ec459..3bb235fc60 100644 --- a/platform-bible-utils/functions/isSerializable.html +++ b/platform-bible-utils/functions/isSerializable.html @@ -13,4 +13,4 @@

    We intend to improve this in the future if it becomes important to do so. See JSON.stringify documentation for more information.

    -
    +
    diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index 44447fd475..dda12f2310 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils
    • Determine whether the object is a string

      Parameters

      • o: unknown

        Object to determine if it is a string

      Returns o is string

      True if the object is a string; false otherwise

      -
    +
    diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 173b06fdec..3242f5f6dc 100644 --- a/platform-bible-utils/functions/isSubset.html +++ b/platform-bible-utils/functions/isSubset.html @@ -14,4 +14,4 @@

    It is important to note that only arrays of primitives (i.e., booleans, numbers, strings) are supported. In particular, objects in arrays will not be checked for deep equality. Also, presence in an array is all this checks, not the number of times that an item appears in an array. [1, 1] is a subset of [1].

    -
    +
    diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 8d562904ce..9089d16cdc 100644 --- a/platform-bible-utils/functions/lastIndexOf.html +++ b/platform-bible-utils/functions/lastIndexOf.html @@ -6,4 +6,4 @@
  • Optionalposition: number

    The index at which to begin searching. If omitted, the search begins at the end of the string. Default is undefined

  • Returns number

    Index of the last occurrence of searchString found, or -1 if not found.

    -
    +
    diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index c9ab7628c1..5627c2bd9d 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils
    +

    Returns string

    diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index edc5cbabf7..603e65aad8 100644 --- a/platform-bible-utils/functions/normalize.html +++ b/platform-bible-utils/functions/normalize.html @@ -4,4 +4,4 @@

    Parameters

    Returns string

    A string containing the Unicode Normalization Form of the given string.

    -
    +
    diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index 12a69ac050..22084e2002 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils
    +offsetBook | platform-bible-utils
    diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index f46aa742a5..053aa935f9 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    +offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 1f2005b7f6..8e2daa6c61 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils
    +offsetVerse | platform-bible-utils
    diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 85e37b1e6d..9088b5d46a 100644 --- a/platform-bible-utils/functions/ordinalCompare.html +++ b/platform-bible-utils/functions/ordinalCompare.html @@ -7,4 +7,4 @@

    Returns number

    A number indicating the result of the comparison: - Negative value if string1 precedes string2 in sorting order. - Zero if string1 and string2 are equivalent in sorting order. - Positive value if string1 follows string2 in sorting order.

    -
    +
    diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index e4382b15dc..fda530d449 100644 --- a/platform-bible-utils/functions/padEnd.html +++ b/platform-bible-utils/functions/padEnd.html @@ -8,4 +8,4 @@
  • padString: string = ' '

    The string to pad the current string with. If padString is too long to stay within targetLength, it will be truncated. Default is " "

  • Returns string

    String with appropriate padding at the end

    -
    +
    diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index eda30de2ff..53b925ab20 100644 --- a/platform-bible-utils/functions/padStart.html +++ b/platform-bible-utils/functions/padStart.html @@ -8,4 +8,4 @@
  • padString: string = ' '

    The string to pad the current string with. If padString is too long to stay within the targetLength, it will be truncated from the end. Default is " "

  • Returns string

    String with of specified targetLength with padString applied from the start

    -
    +
    diff --git a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html index 40ea272b77..3bc3293661 100644 --- a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html +++ b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html @@ -2,4 +2,4 @@

    Parameters

    Returns number

    An integer where the first three digits represent the book, the next three represent the chapter and the last three represent the verse.

    -
    +
    diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index 9386d75371..b2c71d4bfc 100644 --- a/platform-bible-utils/functions/serialize.html +++ b/platform-bible-utils/functions/serialize.html @@ -10,4 +10,4 @@
  • Optionalspace: string | number

    Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read. See the space parameter of JSON.stringify for more details.

    -
  • Returns string

    +

    Returns string

    diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index 699da3de53..13ba00c1fd 100644 --- a/platform-bible-utils/functions/slice.html +++ b/platform-bible-utils/functions/slice.html @@ -6,4 +6,4 @@
  • indexStart: number

    The index of the first character to include in the returned substring.

  • OptionalindexEnd: number

    The index of the first character to exclude from the returned substring.

  • Returns string

    A new string containing the extracted section of the string.

    -
    +
    diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index 921fbdaea1..1d74fd3e93 100644 --- a/platform-bible-utils/functions/split.html +++ b/platform-bible-utils/functions/split.html @@ -9,4 +9,4 @@ in the array.

    Returns string[]

    An array of strings, split at each point where separator occurs in the starting string. Returns undefined if separator is not found in string.

    -
    +
    diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index 4e99135d02..83e87b84ff 100644 --- a/platform-bible-utils/functions/startsWith.html +++ b/platform-bible-utils/functions/startsWith.html @@ -8,4 +8,4 @@ searchString's first character). Default is 0

    Returns boolean

    True if the given characters are found at the beginning of the string, including when searchString is an empty string; otherwise, false.

    -
    +
    diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index 895b19fa07..7932a8f91f 100644 --- a/platform-bible-utils/functions/stringLength.html +++ b/platform-bible-utils/functions/stringLength.html @@ -4,4 +4,4 @@

    Returns the length of a string.

    Parameters

    Returns number

    Number that is length of the starting string

    -
    +
    diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index f9e124300d..7ac147d884 100644 --- a/platform-bible-utils/functions/substring.html +++ b/platform-bible-utils/functions/substring.html @@ -5,4 +5,4 @@
  • begin: number

    Start position

  • end: number = ...

    End position. Default is End of string

  • Returns string

    Substring from starting string

    -
    +
    diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index 21c182c73f..ef55718384 100644 --- a/platform-bible-utils/functions/toArray.html +++ b/platform-bible-utils/functions/toArray.html @@ -3,4 +3,4 @@

    Converts a string to an array of string characters.

    Parameters

    Returns string[]

    An array of characters from the starting string

    -
    +
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html index 737081c18f..ae12bdc88a 100644 --- a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html +++ b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html @@ -8,4 +8,4 @@

    Parameters

    Returns RegExp[]

    An array of RegExp objects. If the input is undefined, an empty array is returned.

    -
    +
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html index 1fc04a9bc4..a96bf888f5 100644 --- a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html +++ b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html @@ -12,4 +12,4 @@ array of strings or arrays of strings, or undefined.

    Returns (RegExp | RegExp[])[]

    An array of RegExp objects or arrays of RegExp objects. If the input is undefined, an empty array is returned.

    -
    +
    diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 2f622c9c7a..96d50fdf2d 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils
    • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

      -

      Parameters

      • ms: number

      Returns Promise<void>

    +

    Parameters

    Returns Promise<void>

    diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index b5e5ae9335..51f8c3a6da 100644 --- a/platform-bible-utils/functions/waitForDuration.html +++ b/platform-bible-utils/functions/waitForDuration.html @@ -3,4 +3,4 @@
  • maxWaitTimeInMS: number

    The maximum amount of time to wait for the function to resolve

  • Returns Promise<undefined | Awaited<TResult>>

    Promise that resolves to the resolved value of the function or undefined if it ran longer than the specified wait time

    -
    +
    diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index d40ee1bb3d..ae330a11d0 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils
    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters +BookInfo | platform-bible-utils
    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters: number
    fullNames: string[]
    shortName: string
    +

    Properties

    chapters: number
    fullNames: string[]
    shortName: string
    diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 8474c9dbfa..dab5999d06 100644 --- a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html +++ b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html @@ -1,7 +1,7 @@ CannotHaveOnDidDispose | platform-bible-utils

    InterfaceCannotHaveOnDidDispose

    Indicates than an object cannot have an onDidDispose event. Also allows an object to include a dispose function.

    -
    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -
    +
    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +
    diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index 2af695e9e2..6ede6ad5b6 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

    Require a dispose function

    -
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    Properties

    Release resources and notify dependent services when tearing down an object

    -
    +
    diff --git a/platform-bible-utils/interfaces/IUsjReaderWriter.html b/platform-bible-utils/interfaces/IUsjReaderWriter.html index 823c6d90ec..e4eb472a2f 100644 --- a/platform-bible-utils/interfaces/IUsjReaderWriter.html +++ b/platform-bible-utils/interfaces/IUsjReaderWriter.html @@ -1,5 +1,5 @@ IUsjReaderWriter | platform-bible-utils

    InterfaceIUsjReaderWriter

    Utilities for reading from and writing to Usj objects

    -
    interface IUsjReaderWriter {
        extractText(start: UsjContentLocation, desiredLength: number): string;
        extractTextBetweenPoints(start: UsjContentLocation, end: UsjContentLocation, maxLength: number): string;
        findNextLocationOfMatchingText(start: UsjContentLocation, text: string, maxTextLengthToSearch: number): undefined | UsjContentLocation;
        findParent<T>(jsonPathQuery: string): undefined | T;
        findSingleValue<T>(jsonPathQuery: string): undefined | T;
        jsonPathToVerseRefAndOffset(jsonPathQuery: string, bookId?: string): VerseRefOffset;
        nodeToJsonPath(node: MarkerObject): ContentJsonPath;
        nodeToVerseRefAndOffset(bookId: string, node: MarkerContent, nodeParent: undefined | MarkerObject | MarkerContent[]): undefined | {
            offset: number;
            verseRef: VerseRef;
        };
        removeContentNodes(searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)): number;
        usjChanged(): void;
        verseRefToUsjContentLocation(verseRef: VerseRef, verseRefOffset: number): UsjContentLocation;
    }

    Implemented by

    Methods

    interface IUsjReaderWriter {
        extractText(start: UsjContentLocation, desiredLength: number): string;
        extractTextBetweenPoints(start: UsjContentLocation, end: UsjContentLocation, maxLength: number): string;
        findNextLocationOfMatchingText(start: UsjContentLocation, text: string, maxTextLengthToSearch: number): undefined | UsjContentLocation;
        findParent<T>(jsonPathQuery: string): undefined | T;
        findSingleValue<T>(jsonPathQuery: string): undefined | T;
        jsonPathToVerseRefAndOffset(jsonPathQuery: string, bookId?: string): VerseRefOffset;
        nodeToJsonPath(node: MarkerObject): ContentJsonPath;
        nodeToVerseRefAndOffset(bookId: string, node: MarkerContent, nodeParent: undefined | MarkerObject | MarkerContent[]): undefined | {
            offset: number;
            verseRef: VerseRef;
        };
        removeContentNodes(searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)): number;
        usjChanged(): void;
        verseRefToUsjContentLocation(verseRef: VerseRef, verseRefOffset: number): UsjContentLocation;
    }

    Implemented by

    Methods

    • Return a copy of text between two points

      +

    Returns string

    • Given a starting point, find the next location in this USJ data that matches the given text

      Parameters

      • start: UsjContentLocation

        Point where the search for text will start

      • text: string

        Text to find

      • maxTextLengthToSearch: number

        Maximum length of text to search before stopping (default is 1000)

        @@ -27,17 +27,17 @@ indicates the location of the of USJ node within usj. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

        -
    • Convert a JSONPath query into a VerseRef and offset

      Parameters

      • jsonPathQuery: string

        JSONPath search expression that indicates a node within this USJ data. If the expression matches more than one node, then only the first node found is considered.

      • OptionalbookId: string

        3 letter ID of the book being searched (must be defined in this USJ data if not provided here)

      Returns VerseRefOffset

      VerseRef and offset that represents the location within this USJ data indicated by jsonPathQuery

      -
    • Determine the VerseRef and offset that correspond to the location of a node somewhere within this USJ data

      Parameters

      • bookId: string

        ID of the book represented by this USJ data

      • node: MarkerContent

        JSON object representing the location of the VerseRef and offset

        @@ -45,12 +45,12 @@ 'undefined' is provided then the UsjReaderWriter will attempt to lookup the parent of node. The lookup will always fail and throw an error if node is a string.

      Returns undefined | {
          offset: number;
          verseRef: VerseRef;
      }

      VerseRef and offset representing the location of node, if one could be found

      -
    • Remove all nodes from this USJ data that match a given search function.

      Parameters

      • searchFunction: ((potentiallyMatchingNode: MarkerContent) => boolean)

        Function that returns true if the given node should be removed

          • (potentiallyMatchingNode): boolean
          • Parameters

            • potentiallyMatchingNode: MarkerContent

            Returns boolean

      Returns number

      Number of nodes removed

      -
    • Convert a verse ref + offset into a node + offset within this USJ data and a JSONPath query

      Parameters

      • verseRef: VerseRef

        Indicates the book, chapter, and verse of interest to find

      • verseRefOffset: number

        Specific location within verse text (defaults to 0)

      Returns UsjContentLocation

      Object containing the USJ node indicated by verseRef and verseRefOffset, offset @@ -58,4 +58,4 @@ location of the of USJ node within this USJ data. Note that if the USJ node returned is an object, it is the same object that is within this USJ data. So if you change it, you are changing this USJ data.

      -
    +
    diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index 3d4b9a25a1..1bcef2f40e 100644 --- a/platform-bible-utils/interfaces/LanguageStrings.html +++ b/platform-bible-utils/interfaces/LanguageStrings.html @@ -1,3 +1,3 @@ LanguageStrings | platform-bible-utils

    InterfaceLanguageStrings

    Map whose keys are localized string keys and whose values provide information about how to localize strings for the localized string key

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index c9ee3a2f9c..a05deb2b7c 100644 --- a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html +++ b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html @@ -1,4 +1,4 @@ LocalizedStringDataContribution | platform-bible-utils

    InterfaceLocalizedStringDataContribution

    The data an extension provides to inform Platform.Bible of the localized strings it provides.

    -
    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }
    metadata?: StringsMetadata
    +

    Properties

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }
    metadata?: StringsMetadata
    diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index f0f59c6163..7b4972e147 100644 --- a/platform-bible-utils/interfaces/ModifierExtensionControlled.html +++ b/platform-bible-utils/interfaces/ModifierExtensionControlled.html @@ -1,6 +1,6 @@ ModifierExtensionControlled | platform-bible-utils

    InterfaceModifierExtensionControlled

    Modifies state/setting type to be extension-controlled. "Extension-controlled" means the extension provides the component and the validator for the state/setting, so the state/setting is controlled by the extension.

    -
    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    Properties

    platformType?: undefined
    type?: undefined
    +

    Properties

    platformType?: undefined
    type?: undefined
    diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index 9bb7f51c47..a13d5a6e21 100644 --- a/platform-bible-utils/interfaces/ModifierProject.html +++ b/platform-bible-utils/interfaces/ModifierProject.html @@ -1,4 +1,4 @@ -ModifierProject | platform-bible-utils

    InterfaceModifierProject

    interface ModifierProject {
        excludePdpFactoryIds?: string | string[];
        excludeProjectInterfaces?: string | (string | string[])[];
        includePdpFactoryIds?: string | string[];
        includeProjectInterfaces?: string | (string | string[])[];
    }

    Properties

    excludePdpFactoryIds? +ModifierProject | platform-bible-utils

    InterfaceModifierProject

    interface ModifierProject {
        excludePdpFactoryIds?: string | string[];
        excludeProjectInterfaces?: string | (string | string[])[];
        includePdpFactoryIds?: string | string[];
        includeProjectInterfaces?: string | (string | string[])[];
    }

    Properties

    excludePdpFactoryIds? excludeProjectInterfaces? includePdpFactoryIds? includeProjectInterfaces? @@ -8,7 +8,7 @@ function) to determine if the projects should absolutely not be included even if they match with includeProjectInterfaces.

    Defaults to none, so all projects that match includePdpFactoryIds will be included

    -
    excludeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces +

    excludeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should absolutely not be included even if they match with @@ -36,13 +36,13 @@

  • Include one
  • Include both two and three.
  • -
    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory +

    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should be included.

    Defaults to all Project Data Provider Factory Ids, so all projects that do not match excludePdpFactoryIds will be included

    -
    includeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces +

    includeProjectInterfaces?: string | (string | string[])[]

    String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included.

    @@ -69,4 +69,4 @@
  • Include one
  • Include both two and three.
  • -
    +
    diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 0aab06c83e..9f04c48df0 100644 --- a/platform-bible-utils/interfaces/OnDidDispose.html +++ b/platform-bible-utils/interfaces/OnDidDispose.html @@ -1,4 +1,4 @@ OnDidDispose | platform-bible-utils

    InterfaceOnDidDispose

    Require an onDidDispose event

    -
    interface OnDidDispose {
        onDidDispose: PlatformEvent<void>;
    }

    Properties

    interface OnDidDispose {
        onDidDispose: PlatformEvent<void>;
    }

    Properties

    Properties

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -
    +
    diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 91c0217bbe..d3e02cda41 100644 --- a/platform-bible-utils/interfaces/ProjectSettingProperties.html +++ b/platform-bible-utils/interfaces/ProjectSettingProperties.html @@ -1,2 +1,2 @@ ProjectSettingProperties | platform-bible-utils

    InterfaceProjectSettingProperties

    Object whose keys are setting IDs and whose values are settings objects

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index e417ceae76..559a871f9a 100644 --- a/platform-bible-utils/interfaces/ProjectSettingsGroup.html +++ b/platform-bible-utils/interfaces/ProjectSettingsGroup.html @@ -1,7 +1,7 @@ ProjectSettingsGroup | platform-bible-utils

    InterfaceProjectSettingsGroup

    Group of related settings definitions

    -
    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description?: `%${string}%`

    LocalizeKey that displays in the project settings dialog to describe the group

    -
    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    -
    +
    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    +
    diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 6eb16ee6ad..ef578dba14 100644 --- a/platform-bible-utils/interfaces/ProjectStateContribution.html +++ b/platform-bible-utils/interfaces/ProjectStateContribution.html @@ -1,2 +1,2 @@ ProjectStateContribution | platform-bible-utils

    InterfaceProjectStateContribution

    The data an extension provides to inform Platform.Bible of the project state it provides

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 32eec86e9c..d8cab06367 100644 --- a/platform-bible-utils/interfaces/ScriptureReference.html +++ b/platform-bible-utils/interfaces/ScriptureReference.html @@ -1,4 +1,4 @@ -ScriptureReference | platform-bible-utils

    InterfaceScriptureReference

    interface ScriptureReference {
        bookNum: number;
        chapterNum: number;
        verseNum: number;
    }

    Properties

    bookNum +ScriptureReference | platform-bible-utils

    InterfaceScriptureReference

    interface ScriptureReference {
        bookNum: number;
        chapterNum: number;
        verseNum: number;
    }

    Properties

    bookNum: number
    chapterNum: number
    verseNum: number
    +

    Properties

    bookNum: number
    chapterNum: number
    verseNum: number
    diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index c60884574e..23cc2893eb 100644 --- a/platform-bible-utils/interfaces/SettingProperties.html +++ b/platform-bible-utils/interfaces/SettingProperties.html @@ -1,2 +1,2 @@ SettingProperties | platform-bible-utils

    InterfaceSettingProperties

    Object whose keys are setting IDs and whose values are settings objects

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index f9367c2c32..dc8a49bf9b 100644 --- a/platform-bible-utils/interfaces/SettingsGroup.html +++ b/platform-bible-utils/interfaces/SettingsGroup.html @@ -1,7 +1,7 @@ SettingsGroup | platform-bible-utils

    InterfaceSettingsGroup

    Group of related settings definitions

    -
    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description?: `%${string}%`

    LocalizeKey that displays in the settings dialog to describe the group

    -
    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    -
    properties: SettingProperties
    +
    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    +
    properties: SettingProperties
    diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index 84e1f5b361..93767796ff 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

    Base information needed to describe a state entry

    -
    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    default: unknown

    Default value for the state/setting

    -
    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time +

    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time this state/setting is loaded

    -
    +
    diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index 62c0dfedf0..125e4b2940 100644 --- a/platform-bible-utils/interfaces/StringMetadata.html +++ b/platform-bible-utils/interfaces/StringMetadata.html @@ -1,11 +1,11 @@ StringMetadata | platform-bible-utils

    InterfaceStringMetadata

    Additional non-locale-specific information about a localized string key

    -
    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    Properties

    fallbackKey?: `%${string}%`

    Localized string key from which to get this value if one does not exist in the specified language. If a new key/value pair needs to be made to replace an existing one, this could help smooth over the transition if the meanings are close enough

    You can use Paratext 9 Localized String Keys here. Be sure to escape any % signs with a backslash ``.

    -
    notes?: string

    Additional information provided by developers in English to help the translator to know how to +

    notes?: string

    Additional information provided by developers in English to help the translator to know how to translate this localized string accurately

    -
    +
    diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index 38d5e690ed..787ead6165 100644 --- a/platform-bible-utils/interfaces/StringsMetadata.html +++ b/platform-bible-utils/interfaces/StringsMetadata.html @@ -1,3 +1,3 @@ StringsMetadata | platform-bible-utils

    InterfaceStringsMetadata

    Map whose keys are localized string keys and whose values provide additional non-locale-specific information about the localized string key

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index eb0d162b76..7c6f372030 100644 --- a/platform-bible-utils/interfaces/UserStateContribution.html +++ b/platform-bible-utils/interfaces/UserStateContribution.html @@ -1,2 +1,2 @@ UserStateContribution | platform-bible-utils

    InterfaceUserStateContribution

    The data an extension provides to inform Platform.Bible of the user state it provides

    -

    Indexable

    +

    Indexable

    diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 4282da9c8b..d8c763c4d8 100644 --- a/platform-bible-utils/types/CanHaveOnDidDispose.html +++ b/platform-bible-utils/types/CanHaveOnDidDispose.html @@ -1,2 +1,2 @@ CanHaveOnDidDispose | platform-bible-utils

    Type AliasCanHaveOnDidDispose<T>

    CanHaveOnDidDispose<T>: Omit<T, "onDidDispose">

    Allow onDidDispose to exist on the type if it was previously disallowed by CannotHaveOnDidDispose

    -

    Type Parameters

    +

    Type Parameters

    diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 66cf4d9530..e647afc392 100644 --- a/platform-bible-utils/types/ColumnsWithHeaders.html +++ b/platform-bible-utils/types/ColumnsWithHeaders.html @@ -1,4 +1,4 @@ ColumnsWithHeaders | platform-bible-utils

    Type AliasColumnsWithHeaders

    ColumnsWithHeaders: {
        isExtensible?: boolean;
        [property: ReferencedItem]: MenuColumnWithHeader;
    }

    Group of columns that can be combined with other columns to form a multi-column menu

    Type declaration

    +
    diff --git a/platform-bible-utils/types/DblResourceData.html b/platform-bible-utils/types/DblResourceData.html index 78aeb923d1..4bcdce0c97 100644 --- a/platform-bible-utils/types/DblResourceData.html +++ b/platform-bible-utils/types/DblResourceData.html @@ -1 +1 @@ -DblResourceData | platform-bible-utils

    Type AliasDblResourceData

    DblResourceData: {
        bestLanguageName: string;
        dblEntryUid: string;
        displayName: string;
        fullName: string;
        installed: boolean;
        projectId: string;
        size: number;
        type: ResourceType;
        updateAvailable: boolean;
    }
    +DblResourceData | platform-bible-utils

    Type AliasDblResourceData

    DblResourceData: {
        bestLanguageName: string;
        dblEntryUid: string;
        displayName: string;
        fullName: string;
        installed: boolean;
        projectId: string;
        size: number;
        type: ResourceType;
        updateAvailable: boolean;
    }
    diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index c75ffbc817..c699b5b49f 100644 --- a/platform-bible-utils/types/DeepPartial.html +++ b/platform-bible-utils/types/DeepPartial.html @@ -1,2 +1,2 @@ DeepPartial | platform-bible-utils

    Type AliasDeepPartial<T>

    DeepPartial<T>: T extends object
        ? {
            [P in keyof T]?: DeepPartial<T[P]>
        }
        : T

    Within type T, recursively change all properties to be optional

    -

    Type Parameters

    • T
    +

    Type Parameters

    diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index c4244d48d4..0a044f67b3 100644 --- a/platform-bible-utils/types/DocumentCombinerOptions.html +++ b/platform-bible-utils/types/DocumentCombinerOptions.html @@ -7,4 +7,4 @@ contributed documents. If false, then throw when duplicate properties are seen in contributed documents. -
    +
    diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index d6c59d060f..8ecd1d5607 100644 --- a/platform-bible-utils/types/ExtensionControlledProjectSetting.html +++ b/platform-bible-utils/types/ExtensionControlledProjectSetting.html @@ -1,2 +1,2 @@ ExtensionControlledProjectSetting | platform-bible-utils

    Type AliasExtensionControlledProjectSetting

    ExtensionControlledProjectSetting: ProjectSettingBase & ModifierExtensionControlled

    Setting definition that is validated by the extension.

    -
    +
    diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index f829cc8e64..2641043b19 100644 --- a/platform-bible-utils/types/ExtensionControlledSetting.html +++ b/platform-bible-utils/types/ExtensionControlledSetting.html @@ -1,2 +1,2 @@ ExtensionControlledSetting | platform-bible-utils

    Type AliasExtensionControlledSetting

    ExtensionControlledSetting: SettingBase & ModifierExtensionControlled

    Setting definition that is validated by the extension.

    -
    +
    diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index d8bd102983..8ac4dd5265 100644 --- a/platform-bible-utils/types/ExtensionControlledState.html +++ b/platform-bible-utils/types/ExtensionControlledState.html @@ -1,2 +1,2 @@ ExtensionControlledState | platform-bible-utils

    Type AliasExtensionControlledState

    ExtensionControlledState: StateBase & ModifierExtensionControlled

    State definition that is validated by the extension.

    -
    +
    diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index 85ffdcedaf..742194138b 100644 --- a/platform-bible-utils/types/GroupsInMultiColumnMenu.html +++ b/platform-bible-utils/types/GroupsInMultiColumnMenu.html @@ -1,4 +1,4 @@ GroupsInMultiColumnMenu | platform-bible-utils

    Type AliasGroupsInMultiColumnMenu

    GroupsInMultiColumnMenu: {
        [property: ReferencedItem]: MenuGroupDetailsInColumn | MenuGroupDetailsInSubMenu;
    }

    Group of menu items that can be combined with other groups to form a single menu/submenu within a multi-column menu. Groups are separated using a line within the menu/submenu.

    Type declaration

    +
    diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 396597445c..9be26669db 100644 --- a/platform-bible-utils/types/GroupsInSingleColumnMenu.html +++ b/platform-bible-utils/types/GroupsInSingleColumnMenu.html @@ -1,4 +1,4 @@ GroupsInSingleColumnMenu | platform-bible-utils

    Type AliasGroupsInSingleColumnMenu

    GroupsInSingleColumnMenu: {
        [property: ReferencedItem]: OrderedExtensibleContainer | MenuGroupDetailsInSubMenu;
    }

    Group of menu items that can be combined with other groups to form a single context menu/submenu. Groups are separated using a line within the menu/submenu.

    Type declaration

    +
    diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index 1e2e62eb2d..edee670748 100644 --- a/platform-bible-utils/types/JsonDocumentLike.html +++ b/platform-bible-utils/types/JsonDocumentLike.html @@ -1 +1 @@ -JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike
    +JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike
    diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index a8b5fdea00..eaa2fe466c 100644 --- a/platform-bible-utils/types/LocalizeKey.html +++ b/platform-bible-utils/types/LocalizeKey.html @@ -1,2 +1,2 @@ LocalizeKey | platform-bible-utils

    Type AliasLocalizeKey

    LocalizeKey: `%${string}%`

    Identifier for a string that will be localized in a menu based on the user's UI language

    -
    +
    diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index 81e02a7a0f..1ff19ce97a 100644 --- a/platform-bible-utils/types/Localized.html +++ b/platform-bible-utils/types/Localized.html @@ -1,3 +1,3 @@ Localized | platform-bible-utils

    Type AliasLocalized<T>

    Localized<T>: ReplaceType<ReplaceType<T, LocalizeKey, string>, ReferencedItem, string>

    Type that converts any menu type before it is localized to what it is after it is localized. This can be applied to any menu type as needed.

    -

    Type Parameters

    • T
    +

    Type Parameters

    diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index 20537cad0f..421252531a 100644 --- a/platform-bible-utils/types/LocalizedStringValue.html +++ b/platform-bible-utils/types/LocalizedStringValue.html @@ -1,2 +1,2 @@ LocalizedStringValue | platform-bible-utils

    Type AliasLocalizedStringValue

    LocalizedStringValue: string

    Localized string value associated with this key

    -
    +
    diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 0511c1ada3..71fc83f76c 100644 --- a/platform-bible-utils/types/MenuColumnWithHeader.html +++ b/platform-bible-utils/types/MenuColumnWithHeader.html @@ -1,3 +1,3 @@ MenuColumnWithHeader | platform-bible-utils

    Type AliasMenuColumnWithHeader

    MenuColumnWithHeader: OrderedExtensibleContainer & {
        label: LocalizeKey;
    }

    Column that includes header text in a menu

    Type declaration

    • label: LocalizeKey

      Key that represents the text of the header text of the column

      -
    +
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index 8bf5e938f9..3e1a15c121 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInColumn.html +++ b/platform-bible-utils/types/MenuGroupDetailsInColumn.html @@ -1,3 +1,3 @@ MenuGroupDetailsInColumn | platform-bible-utils

    Type AliasMenuGroupDetailsInColumn

    MenuGroupDetailsInColumn: OrderedExtensibleContainer & {
        column: ReferencedItem;
    }

    Group of menu items that belongs in a column

    Type declaration

    +
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index a8db31e9ca..a38ada0c31 100644 --- a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html +++ b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html @@ -1,3 +1,3 @@ MenuGroupDetailsInSubMenu | platform-bible-utils

    Type AliasMenuGroupDetailsInSubMenu

    MenuGroupDetailsInSubMenu: OrderedExtensibleContainer & {
        menuItem: ReferencedItem;
    }

    Group of menu items that belongs in a submenu

    Type declaration

    • menuItem: ReferencedItem

      ID of menu item hosting the submenu in which this group resides

      -
    +
    diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index bbd83ffdac..2560cca961 100644 --- a/platform-bible-utils/types/MenuItemBase.html +++ b/platform-bible-utils/types/MenuItemBase.html @@ -3,4 +3,4 @@
  • localizeNotes: string

    Additional information provided by developers to help people who perform localization

  • OptionalsearchTerms?: LocalizeKey

    Key that represents words the platform should reference when users are searching for menu items

  • Optionaltooltip?: LocalizeKey

    Key that represents the text to display if a mouse pointer hovers over the menu item

    -
  • +
    diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index 5f2699b020..8c75c4fee9 100644 --- a/platform-bible-utils/types/MenuItemContainingCommand.html +++ b/platform-bible-utils/types/MenuItemContainingCommand.html @@ -4,4 +4,4 @@ papi-extension://helloWorld/assets/icon.png

  • OptionaliconPathBefore?: string

    Uri path to the icon to display before the menu text. Ex: papi-extension://helloWorld/assets/icon.png

    -
  • +
    diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 61737fe368..fcb3f2a8bd 100644 --- a/platform-bible-utils/types/MenuItemContainingSubmenu.html +++ b/platform-bible-utils/types/MenuItemContainingSubmenu.html @@ -1,3 +1,3 @@ MenuItemContainingSubmenu | platform-bible-utils

    Type AliasMenuItemContainingSubmenu

    MenuItemContainingSubmenu: MenuItemBase & {
        id: ReferencedItem;
    }

    Menu item that hosts a submenu

    Type declaration

    +
    diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index 582091ab4a..f10f9697d4 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index 9d619df55f..6108bcdb4a 100644 --- a/platform-bible-utils/types/OrderedExtensibleContainer.html +++ b/platform-bible-utils/types/OrderedExtensibleContainer.html @@ -1,2 +1,2 @@ OrderedExtensibleContainer | platform-bible-utils

    Type AliasOrderedExtensibleContainer

    OrderedExtensibleContainer: OrderedItem & {
        isExtensible?: boolean;
    }

    Type declaration

    • OptionalisExtensible?: boolean

      Determines whether other items can be added to this after it has been defined

      -
    +
    diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index d188bf94dd..e8e9b8647b 100644 --- a/platform-bible-utils/types/OrderedItem.html +++ b/platform-bible-utils/types/OrderedItem.html @@ -1,2 +1,2 @@ OrderedItem | platform-bible-utils

    Type AliasOrderedItem

    OrderedItem: {
        order: number;
    }

    Type declaration

    • order: number

      Relative order of this item compared to other items in the same parent/scope (sorted ascending)

      -
    +
    diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index 59973185ac..e8607f9b14 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    +
    diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index f5058fb64a..6f43c11977 100644 --- a/platform-bible-utils/types/PlatformEventAsync.html +++ b/platform-bible-utils/types/PlatformEventAsync.html @@ -1,3 +1,3 @@ PlatformEventAsync | platform-bible-utils

    Type AliasPlatformEventAsync<T>

    PlatformEventAsync<T>: ((callback: PlatformEventHandler<T>) => Promise<UnsubscriberAsync>)

    A PapiEvent that subscribes asynchronously and resolves an asynchronous unsubscriber.

    Note: The callback itself is not asynchronous.

    -

    Type Parameters

    • T
    +

    Type Parameters

    diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 777fefd71c..6f2c2443b8 100644 --- a/platform-bible-utils/types/PlatformEventHandler.html +++ b/platform-bible-utils/types/PlatformEventHandler.html @@ -1,2 +1,2 @@ PlatformEventHandler | platform-bible-utils

    Type AliasPlatformEventHandler<T>

    PlatformEventHandler<T>: ((event: T) => void)

    Callback function that accepts an event and should run when an event is emitted

    -

    Type Parameters

    • T
    +

    Type Parameters

    diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index 3f05d1e3ca..486446bf9a 100644 --- a/platform-bible-utils/types/PlatformMenus.html +++ b/platform-bible-utils/types/PlatformMenus.html @@ -3,4 +3,4 @@
  • defaultWebViewTopMenu: MultiColumnMenu

    Default top menu for web views that don't specify their own

  • mainMenu: MultiColumnMenu

    Top level menu for the application

  • webViewMenus: WebViewMenus

    Menus that apply per web view in the application

    -
  • +
    diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index 949133de89..763594fae5 100644 --- a/platform-bible-utils/types/ProjectSetting.html +++ b/platform-bible-utils/types/ProjectSetting.html @@ -1,2 +1,2 @@ ProjectSetting | platform-bible-utils

    Type AliasProjectSetting

    A description of an extension's setting entry

    -
    +
    diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 582603cb2a..33fc63f3bc 100644 --- a/platform-bible-utils/types/ProjectSettingBase.html +++ b/platform-bible-utils/types/ProjectSettingBase.html @@ -1,2 +1,2 @@ ProjectSettingBase | platform-bible-utils

    Type AliasProjectSettingBase

    ProjectSettingBase: SettingBase & ModifierProject

    Base information needed to describe a project setting entry

    -
    +
    diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index 196e722c4d..1a14ce40f8 100644 --- a/platform-bible-utils/types/ProjectSettingsContribution.html +++ b/platform-bible-utils/types/ProjectSettingsContribution.html @@ -1,2 +1,2 @@ ProjectSettingsContribution | platform-bible-utils

    Type AliasProjectSettingsContribution

    ProjectSettingsContribution: ProjectSettingsGroup | ProjectSettingsGroup[]

    The data an extension provides to inform Platform.Bible of the project settings it provides

    -
    +
    diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 60a4d7610a..7dc967085c 100644 --- a/platform-bible-utils/types/ReferencedItem.html +++ b/platform-bible-utils/types/ReferencedItem.html @@ -1,2 +1,2 @@ ReferencedItem | platform-bible-utils

    Type AliasReferencedItem

    ReferencedItem: `${string}.${string}`

    Name of some UI element (i.e., tab, column, group, menu item) or some PAPI object (i.e., command)

    -
    +
    diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index d5875ec81b..f0baffafaf 100644 --- a/platform-bible-utils/types/ReplaceType.html +++ b/platform-bible-utils/types/ReplaceType.html @@ -1,2 +1,2 @@ ReplaceType | platform-bible-utils

    Type AliasReplaceType<T, A, B>

    ReplaceType<T, A, B>: T extends A
        ? B
        : T extends object
            ? {
                [K in keyof T]: ReplaceType<T[K], A, B>
            }
            : T

    Within type T, recursively change properties that were of type A to be of type B

    -

    Type Parameters

    • T
    • A
    • B
    +

    Type Parameters

    diff --git a/platform-bible-utils/types/ResourceType.html b/platform-bible-utils/types/ResourceType.html index b808170c41..a62d0f027e 100644 --- a/platform-bible-utils/types/ResourceType.html +++ b/platform-bible-utils/types/ResourceType.html @@ -1 +1 @@ -ResourceType | platform-bible-utils

    Type AliasResourceType

    ResourceType:
        | "DBLResource"
        | "EnhancedResource"
        | "XmlResource"
        | "SourceLanguageResource"
    +ResourceType | platform-bible-utils

    Type AliasResourceType

    ResourceType:
        | "DBLResource"
        | "EnhancedResource"
        | "XmlResource"
        | "SourceLanguageResource"
    diff --git a/platform-bible-utils/types/ScriptureNode.html b/platform-bible-utils/types/ScriptureNode.html index d1fee3e2e5..05436c1167 100644 --- a/platform-bible-utils/types/ScriptureNode.html +++ b/platform-bible-utils/types/ScriptureNode.html @@ -1,3 +1,3 @@ ScriptureNode | platform-bible-utils

    Type AliasScriptureNode

    ScriptureNode: ScriptureReference & {
        jsonPath: string;
    }

    Represents a "node" in the JSON used to present Scripture in the editor, with a path that is relative to the start of a verse.

    -
    +
    diff --git a/platform-bible-utils/types/ScriptureSelection.html b/platform-bible-utils/types/ScriptureSelection.html index 7dbd8f5a5b..5591f1af5a 100644 --- a/platform-bible-utils/types/ScriptureSelection.html +++ b/platform-bible-utils/types/ScriptureSelection.html @@ -1,3 +1,3 @@ ScriptureSelection | platform-bible-utils

    Type AliasScriptureSelection

    ScriptureSelection: {
        end?: ScriptureNode | ScriptureTextAnchor;
        start: ScriptureNode | ScriptureTextAnchor;
    }

    Represents a range of text in the Scripture editor. The start and end node are expected to be in the same book.

    -
    +
    diff --git a/platform-bible-utils/types/ScriptureTextAnchor.html b/platform-bible-utils/types/ScriptureTextAnchor.html index 0ce5b415ff..c3c1287a3a 100644 --- a/platform-bible-utils/types/ScriptureTextAnchor.html +++ b/platform-bible-utils/types/ScriptureTextAnchor.html @@ -1,2 +1,2 @@ ScriptureTextAnchor | platform-bible-utils

    Type AliasScriptureTextAnchor

    ScriptureTextAnchor: ScriptureNode & {
        offset: number;
    }

    Represents a specific character offset in the text of a textual Scripture node (in the editor.)

    -
    +
    diff --git a/platform-bible-utils/types/ScrollGroupId.html b/platform-bible-utils/types/ScrollGroupId.html index e22ecc2832..0050758ce9 100644 --- a/platform-bible-utils/types/ScrollGroupId.html +++ b/platform-bible-utils/types/ScrollGroupId.html @@ -3,4 +3,4 @@

    For example, a few web views that share a Scroll Group Id would all change Scripture Reference together.

    These are generally expected to be non-negative numbers (starting at 0).

    -
    +
    diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 2a81a186ee..848f183b3f 100644 --- a/platform-bible-utils/types/Setting.html +++ b/platform-bible-utils/types/Setting.html @@ -1,2 +1,2 @@ Setting | platform-bible-utils

    Type AliasSetting

    A description of an extension's setting entry

    -
    +
    diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index de7827d0c5..e3568a91cc 100644 --- a/platform-bible-utils/types/SettingBase.html +++ b/platform-bible-utils/types/SettingBase.html @@ -1,4 +1,4 @@ SettingBase | platform-bible-utils

    Type AliasSettingBase

    SettingBase: StateBase & {
        description?: LocalizeKey;
        label: LocalizeKey;
        [k: string]: unknown;
    }

    Base information needed to describe a setting entry

    Type declaration

    • [k: string]: unknown
    • Optionaldescription?: LocalizeKey

      LocalizeKey that displays in the settings dialog to describe the setting

    • label: LocalizeKey

      LocalizeKey that displays in the settings dialog as the setting name

      -
    +
    diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index 47cf5a1b5a..5d7201276e 100644 --- a/platform-bible-utils/types/SettingsContribution.html +++ b/platform-bible-utils/types/SettingsContribution.html @@ -1,2 +1,2 @@ SettingsContribution | platform-bible-utils

    Type AliasSettingsContribution

    SettingsContribution: SettingsGroup | SettingsGroup[]

    The data an extension provides to inform Platform.Bible of the settings it provides

    -
    +
    diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 8a291fc955..fcfe699d8e 100644 --- a/platform-bible-utils/types/SingleColumnMenu.html +++ b/platform-bible-utils/types/SingleColumnMenu.html @@ -1,4 +1,4 @@ SingleColumnMenu | platform-bible-utils

    Type AliasSingleColumnMenu

    SingleColumnMenu: {
        groups: GroupsInSingleColumnMenu;
        items: (MenuItemContainingCommand | MenuItemContainingSubmenu)[];
    }

    Menu that contains a column without a header

    Type declaration

    +
    diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index ab4c8306f7..41b9d6d178 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -3,4 +3,4 @@

    Type Parameters

    type TypeOne = { one: string };
    type TypeTwo = { two: number };
    type TypeThree = { three: string };

    type TypeNums = { one: TypeOne; two: TypeTwo; three: TypeThree };
    const numNames = ['one', 'two'] as const;
    type TypeNumNames = typeof numNames;

    // Same as `TypeOne | TypeTwo`
    // `{ one: string } | { two: number }`
    type TypeOneTwoUnion = TypeNums[TypeNumNames[number]];

    // Same as `TypeOne & TypeTwo`
    // `{ one: string; two: number }`
    type TypeOneTwoIntersection = UnionToIntersection<TypeOneTwoUnion>;
    -
    +
    diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index 92286041c7..44fbe0f178 100644 --- a/platform-bible-utils/types/Unsubscriber.html +++ b/platform-bible-utils/types/Unsubscriber.html @@ -1,2 +1,2 @@ Unsubscriber | platform-bible-utils

    Type AliasUnsubscriber

    Unsubscriber: (() => boolean)

    Function to run to dispose of something. Returns true if successfully unsubscribed

    -
    +
    diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index 4ef5b6ada0..2cd58e8b9e 100644 --- a/platform-bible-utils/types/UnsubscriberAsync.html +++ b/platform-bible-utils/types/UnsubscriberAsync.html @@ -1,3 +1,3 @@ UnsubscriberAsync | platform-bible-utils

    Type AliasUnsubscriberAsync

    UnsubscriberAsync: (() => Promise<boolean>)

    Function to run to dispose of something that runs asynchronously. The promise resolves to true if successfully unsubscribed

    -
    +
    diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index c1fe7519eb..85302d3f55 100644 --- a/platform-bible-utils/types/UserState.html +++ b/platform-bible-utils/types/UserState.html @@ -1,2 +1,2 @@ UserState | platform-bible-utils

    Type AliasUserState

    A description of an extension's user state entry

    -
    +
    diff --git a/platform-bible-utils/types/UsjContentLocation.html b/platform-bible-utils/types/UsjContentLocation.html index ac6cec15da..39064b4fce 100644 --- a/platform-bible-utils/types/UsjContentLocation.html +++ b/platform-bible-utils/types/UsjContentLocation.html @@ -1,2 +1,2 @@ UsjContentLocation | platform-bible-utils

    Type AliasUsjContentLocation

    UsjContentLocation: {
        jsonPath: ContentJsonPath;
        node: MarkerContent;
        offset: number;
    }

    Node within a USJ object, an offset within that node, and a JSONPath query to the node

    -
    +
    diff --git a/platform-bible-utils/types/VerseRefOffset.html b/platform-bible-utils/types/VerseRefOffset.html index bd72e20d06..d33e22d7b9 100644 --- a/platform-bible-utils/types/VerseRefOffset.html +++ b/platform-bible-utils/types/VerseRefOffset.html @@ -1,2 +1,2 @@ VerseRefOffset | platform-bible-utils

    Type AliasVerseRefOffset

    VerseRefOffset: {
        offset: number;
        verseRef: VerseRef;
    }

    Represents a book, chapter, verse, and offset

    -
    +
    diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index 7483822da0..6fc88c6f8a 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 65fbdb4301..e8567cd532 100644 --- a/platform-bible-utils/types/WebViewMenus.html +++ b/platform-bible-utils/types/WebViewMenus.html @@ -1,3 +1,3 @@ WebViewMenus | platform-bible-utils

    Type AliasWebViewMenus

    WebViewMenus: {
        [property: ReferencedItem]: WebViewMenu;
    }

    Menus for all web views

    Type declaration

    +
    diff --git a/platform-bible-utils/variables/CHAPTER_TYPE.html b/platform-bible-utils/variables/CHAPTER_TYPE.html index cfe1b9ed2d..babbc2a404 100644 --- a/platform-bible-utils/variables/CHAPTER_TYPE.html +++ b/platform-bible-utils/variables/CHAPTER_TYPE.html @@ -1,2 +1,2 @@ CHAPTER_TYPE | platform-bible-utils

    VariableCHAPTER_TYPEConst

    CHAPTER_TYPE: "chapter" = 'chapter'

    USJ content node type for a chapter

    -
    +
    diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index 5e57c89369..2eb4089c4f 100644 --- a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html @@ -1 +1 @@ -FIRST_SCR_BOOK_NUM | platform-bible-utils

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1
    +FIRST_SCR_BOOK_NUM | platform-bible-utils

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1
    diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index 5ee0295cbd..c2efcc998d 100644 --- a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html @@ -1 +1 @@ -FIRST_SCR_CHAPTER_NUM | platform-bible-utils

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1
    +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1
    diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index cbbeb23d1d..35923c40e1 100644 --- a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html +++ b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html @@ -1 +1 @@ -FIRST_SCR_VERSE_NUM | platform-bible-utils

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1
    +FIRST_SCR_VERSE_NUM | platform-bible-utils

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1
    diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index edf9b1722f..a617344af9 100644 --- a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html +++ b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html @@ -1 +1 @@ -LAST_SCR_BOOK_NUM | platform-bible-utils

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...
    +LAST_SCR_BOOK_NUM | platform-bible-utils

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...
    diff --git a/platform-bible-utils/variables/VERSE_TYPE.html b/platform-bible-utils/variables/VERSE_TYPE.html index 24456fd08b..3766d10c1e 100644 --- a/platform-bible-utils/variables/VERSE_TYPE.html +++ b/platform-bible-utils/variables/VERSE_TYPE.html @@ -1,2 +1,2 @@ VERSE_TYPE | platform-bible-utils

    VariableVERSE_TYPEConst

    VERSE_TYPE: "verse" = 'verse'

    USJ content node type for a verse

    -
    +
    diff --git a/platform-bible-utils/variables/defaultScrRef.html b/platform-bible-utils/variables/defaultScrRef.html index 19c5eb97bc..49e59b8e63 100644 --- a/platform-bible-utils/variables/defaultScrRef.html +++ b/platform-bible-utils/variables/defaultScrRef.html @@ -1 +1 @@ -defaultScrRef | platform-bible-utils
    +defaultScrRef | platform-bible-utils
    diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index fdce370f64..37399c30b2 100644 --- a/platform-bible-utils/variables/localizedStringsDocumentSchema.html +++ b/platform-bible-utils/variables/localizedStringsDocumentSchema.html @@ -1,2 +1,2 @@ localizedStringsDocumentSchema | platform-bible-utils

    VariablelocalizedStringsDocumentSchemaConst

    localizedStringsDocumentSchema: {
        $defs: {
            languageStrings: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            localizedStringValue: {
                description: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            stringMetadata: {
                description: string;
                properties: {
                    fallbackKey: {
                        description: string;
                        pattern: string;
                        tsType: string;
                        type: string;
                    };
                    notes: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            };
            stringsMetadata: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^%[\w\-\.]+%$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        description: string;
        properties: {
            localizedStrings: {
                additionalProperties: {
                    $ref: string;
                };
                type: string;
            };
            metadata: {
                $ref: string;
            };
        };
        title: string;
        type: string;
    } = ...

    JSON schema object that aligns with the LocalizedStringDataContribution type

    -
    +
    diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index d0e4821b27..4748f92c06 100644 --- a/platform-bible-utils/variables/menuDocumentSchema.html +++ b/platform-bible-utils/variables/menuDocumentSchema.html @@ -1,2 +1,2 @@ menuDocumentSchema | platform-bible-utils

    VariablemenuDocumentSchemaConst

    menuDocumentSchema: {
        $defs: {
            columnsWithHeaders: {
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        additionalProperties: boolean;
                        description: string;
                        properties: {
                            isExtensible: {
                                description: string;
                                type: string;
                            };
                            label: {
                                $ref: string;
                                description: string;
                            };
                            localizeNotes: {
                                description: string;
                                type: string;
                            };
                            order: {
                                description: string;
                                type: string;
                            };
                        };
                        required: string[];
                        type: string;
                    };
                };
                properties: {
                    isExtensible: {
                        description: string;
                        type: string;
                    };
                };
                type: string;
            };
            groupsAndItems: {
                description: string;
                properties: {
                    groups: {
                        $ref: string;
                        description: string;
                    };
                    items: {
                        description: string;
                        items: {
                            $ref: string;
                        };
                        type: string;
                        uniqueItems: boolean;
                    };
                };
                required: string[];
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                type: string;
            };
            menuGroups: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        description: string;
                        oneOf: ({
                            additionalProperties: boolean;
                            properties: {
                                column: {
                                    $ref: string;
                                    description: string;
                                };
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem?: undefined;
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        } | {
                            additionalProperties: boolean;
                            properties: {
                                column?: undefined;
                                isExtensible: {
                                    description: string;
                                    type: string;
                                };
                                menuItem: {
                                    $ref: string;
                                    description: string;
                                };
                                order: {
                                    description: string;
                                    type: string;
                                };
                            };
                            required: string[];
                        })[];
                        type: string;
                    };
                };
                type: string;
            };
            menuItem: {
                description: string;
                oneOf: ({
                    properties: {
                        command?: undefined;
                        iconPathAfter?: undefined;
                        iconPathBefore?: undefined;
                        id: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                } | {
                    properties: {
                        command: {
                            $ref: string;
                            description: string;
                        };
                        iconPathAfter: {
                            description: string;
                            type: string;
                        };
                        iconPathBefore: {
                            description: string;
                            type: string;
                        };
                        id?: undefined;
                    };
                    required: string[];
                })[];
                properties: {
                    group: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    localizeNotes: {
                        description: string;
                        type: string;
                    };
                    order: {
                        description: string;
                        type: string;
                    };
                    searchTerms: {
                        $ref: string;
                        description: string;
                    };
                    tooltip: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
                unevaluatedProperties: boolean;
            };
            menusForOneWebView: {
                additionalProperties: boolean;
                description: string;
                properties: {
                    contextMenu: {
                        $ref: string;
                        description: string;
                    };
                    includeDefaults: {
                        description: string;
                        type: string;
                    };
                    topMenu: {
                        $ref: string;
                        description: string;
                    };
                };
                type: string;
            };
            multiColumnMenu: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        columns: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                })[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            };
            referencedItem: {
                description: string;
                pattern: string;
                type: string;
            };
            singleColumnMenu: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
                type: string;
                unevaluatedProperties: boolean;
            };
        };
        additionalProperties: boolean;
        properties: {
            defaultWebViewContextMenu: {
                $ref: string;
                description: string;
            };
            defaultWebViewTopMenu: {
                $ref: string;
                description: string;
            };
            mainMenu: {
                $ref: string;
                description: string;
            };
            webViewMenus: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        required: string[];
        title: string;
        type: string;
    } = ...

    JSON schema object that aligns with the PlatformMenus type

    -
    +
    diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index 208ba82a2c..7e0930be18 100644 --- a/platform-bible-utils/variables/projectSettingsDocumentSchema.html +++ b/platform-bible-utils/variables/projectSettingsDocumentSchema.html @@ -1,2 +1,2 @@ projectSettingsDocumentSchema | platform-bible-utils

    VariableprojectSettingsDocumentSchemaConst

    projectSettingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: {
                $ref: string;
                description: string;
            };
            setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            };
            userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            userStateContribution: {
                $ref: string;
                description: string;
            };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        anyOf: ({
            $ref: string;
            items?: undefined;
            type?: undefined;
        } | {
            $ref?: undefined;
            items: {
                $ref: string;
            };
            type: string;
        })[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the ProjectSettingsContribution type

    -
    +
    diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index a7efe6e9ad..c1da1e5d9a 100644 --- a/platform-bible-utils/variables/settingsDocumentSchema.html +++ b/platform-bible-utils/variables/settingsDocumentSchema.html @@ -1,2 +1,2 @@ settingsDocumentSchema | platform-bible-utils

    VariablesettingsDocumentSchemaConst

    settingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            extensionControlledState: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            id: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: {
                    anyOf: {
                        required: string[];
                        type: string;
                    }[];
                };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                type: string;
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: ({
                            items?: undefined;
                            type: string;
                        } | {
                            items: {
                                anyOf: ((...) | (...))[];
                            };
                            type: string;
                        })[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingBase: {
                allOf: {
                    $ref: string;
                }[];
                description: string;
            };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: {
                $ref: string;
                description: string;
            };
            setting: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            settingBase: {
                allOf: ({
                    $ref: string;
                    properties?: undefined;
                    required?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    properties: {
                        description: {
                            $ref: string;
                            description: string;
                        };
                        label: {
                            $ref: string;
                            description: string;
                        };
                    };
                    required: string[];
                    type: string;
                })[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w-]+\.[\w-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
            settingsContribution: {
                anyOf: ({
                    $ref: string;
                    items?: undefined;
                    type?: undefined;
                } | {
                    $ref?: undefined;
                    items: {
                        $ref: string;
                    };
                    type: string;
                })[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: {
                        $ref: string;
                        description: string;
                    };
                    label: {
                        $ref: string;
                        description: string;
                    };
                    properties: {
                        $ref: string;
                    };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: {
                        description: string;
                        type: string;
                    };
                    derivesFrom: {
                        $ref: string;
                        description: string;
                    };
                };
                required: string[];
                type: string;
            };
            userState: {
                anyOf: {
                    $ref: string;
                }[];
                description: string;
            };
            userStateContribution: {
                $ref: string;
                description: string;
            };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: {
                    ^[\w\-]+\.[\w\-]+$: {
                        $ref: string;
                    };
                };
                type: string;
            };
        };
        $schema: string;
        anyOf: ({
            $ref: string;
            items?: undefined;
            type?: undefined;
        } | {
            $ref?: undefined;
            items: {
                $ref: string;
            };
            type: string;
        })[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the SettingsContribution type

    -
    +