diff --git a/papi-dts/classes/_client_services_rpc_client_.default.html b/papi-dts/classes/_client_services_rpc_client_.default.html index b659202f68..77a4473765 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

Classdefault

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

constructor +

Implements

Constructors

constructor

Properties

connectionStatus

Methods

connect disconnect @@ -8,9 +8,9 @@ registerMethod request unregisterMethod -

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

-

Methods

connect

Methods

connect

  • connect(localEventHandler): Promise<boolean>

  • 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

    -

disconnect

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the connection:

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

    Returns Promise<void>

emitEventOnNetwork

emitEventOnNetwork

  • emitEventOnNetwork<T>(eventType, event): 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

registerMethod

request

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

  • Send a request and resolve after receiving a response

    +

Returns void

registerMethod

request

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/papi-dts/classes/_main_services_rpc_server_.default.html b/papi-dts/classes/_main_services_rpc_server_.default.html index 6155b4f0cb..2eb27c62e4 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

constructor +

Implements

Constructors

constructor

Properties

connectionStatus

Methods

connect disconnect @@ -10,26 +10,26 @@ registerRemoteMethod request unregisterRemoteMethod -

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

-

Methods

connect

Methods

connect

  • connect(): Promise<boolean>

  • 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

    -

disconnect

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the connection:

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

    Returns Promise<void>

emitEventOnNetwork

emitEventOnNetwork

  • emitEventOnNetwork<T>(eventType, event): 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

registerRemoteMethod

request

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

  • Send a request and resolve after receiving a response

    +

Returns void

registerRemoteMethod

request

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

  • 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

    -

unregisterRemoteMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

unregisterRemoteMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
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 ec93b01bae..3916a1cd8f 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

constructor +

Implements

Constructors

constructor

Properties

connectionStatus

Accessors

nextSocketId

Methods

connect @@ -14,9 +14,9 @@ registerMethod request unregisterMethod -

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

Constructors

constructor

Properties

connectionStatus

connectionStatus: ConnectionStatus

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

-

Accessors

nextSocketId

Methods

connect

Accessors

nextSocketId

Methods

connect

  • connect(localEventHandler): Promise<boolean>

  • 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
      • @@ -25,19 +25,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

    -

disconnect

disconnect

  • disconnect(): Promise<void>

  • Disconnects from the connection:

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

    Returns Promise<void>

emitEventOnNetwork

emitEventOnNetwork

  • emitEventOnNetwork<T>(eventType, event): 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

registerMethod

request

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

  • Send a request and resolve after receiving a response

    +

Returns void

registerMethod

request

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

  • 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

    -

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

unregisterMethod

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
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 5a8ae61367..f3ae95f286 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

ClassExecutionToken

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

name nonce type

Methods

getHash -

Constructors

constructor

Properties

Readonlyname

name: string

Name of an extension

-

Readonlynonce

nonce: string

Readonlytype

type

Methods

getHash

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Readonlyname

name: string

Name of an extension

+

Readonlynonce

nonce: string

Readonlytype

type

Methods

getHash

Settings

Member Visibility

On This Page

Constructors
Properties
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 df27546e5a..189761568f 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

constructor +

Implements

  • WebSocket

Constructors

constructor

Properties

addEventListener binaryType bufferedAmount @@ -22,28 +22,28 @@ removeEventListener send url -

Constructors

constructor

Properties

addEventListener

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

binaryType

binaryType: BinaryType

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

+

Constructors

constructor

Properties

addEventListener

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

binaryType

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

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

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

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

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

-

ReadonlyCLOSED

CLOSED

ReadonlyCLOSING

CLOSING

ReadonlyCONNECTING

CONNECTING

dispatchEvent

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.

+

ReadonlyCLOSED

CLOSED

ReadonlyCLOSING

CLOSING

ReadonlyCONNECTING

CONNECTING

dispatchEvent

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

extensions: string

Returns the extensions selected by the server, if any.

+

extensions

extensions: string

Returns the extensions selected by the server, if any.

MDN Reference

-

onclose

onclose: null | ((this: WebSocket, ev: CloseEvent) => any)

MDN Reference

-

onerror

onerror: null | ((this: WebSocket, ev: Event) => any)

MDN Reference

-

onmessage

onmessage: null | ((this: WebSocket, ev: MessageEvent<any>) => any)

MDN Reference

-

onopen

onopen: null | ((this: WebSocket, ev: Event) => any)

MDN Reference

-

ReadonlyOPEN

OPEN

protocol

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

onclose: null | ((this: WebSocket, ev: CloseEvent) => any)

MDN Reference

+

onerror

onerror: null | ((this: WebSocket, ev: Event) => any)

MDN Reference

+

onmessage

onmessage: null | ((this: WebSocket, ev: MessageEvent<any>) => any)

MDN Reference

+

onopen

onopen: null | ((this: WebSocket, ev: Event) => any)

MDN Reference

+

ReadonlyOPEN

OPEN

protocol

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

readyState: number

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

+

readyState

readyState: number

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

MDN Reference

-

removeEventListener

removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)

send

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

removeEventListener: (<K>(type: K, listener: ((this: WebSocket, ev: WebSocketEventMap[K]) => any), options?: boolean | EventListenerOptions) => void)

send

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

url: string

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

+

url

url: string

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

MDN Reference

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Settings

Member Visibility

On This Page

Constructors
Properties
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 ebfcae5aec..2c71907bc9 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

constructor +

Implements

  • XMLHttpRequest

Constructors

constructor

Properties

abort addEventListener dispatchEvent @@ -37,53 +37,53 @@ UNSENT upload withCredentials -

Constructors

constructor

Properties

abort

abort: (() => void)

Cancels any network activity.

+

Constructors

constructor

Properties

abort

abort: (() => void)

Cancels any network activity.

MDN Reference

-

addEventListener

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

dispatchEvent

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

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

dispatchEvent

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

-

ReadonlyDONE

DONE

getAllResponseHeaders

getAllResponseHeaders: (() => string)

MDN Reference

-

getResponseHeader

getResponseHeader: ((name: string) => null | string)

MDN Reference

-

ReadonlyHEADERS_RECEIVED

HEADERS_RECEIVED

ReadonlyLOADING

LOADING

onabort

onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onerror

onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onload

onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadend

onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadstart

onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onprogress

onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onreadystatechange

onreadystatechange: null | ((this: XMLHttpRequest, ev: Event) => any)

MDN Reference

-

ontimeout

ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

open

open: ((method: string, url: string, async?: boolean, username?: null | string, password?: null | string) => void)

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

+

ReadonlyDONE

DONE

getAllResponseHeaders

getAllResponseHeaders: (() => string)

MDN Reference

+

getResponseHeader

getResponseHeader: ((name: string) => null | string)

MDN Reference

+

ReadonlyHEADERS_RECEIVED

HEADERS_RECEIVED

ReadonlyLOADING

LOADING

onabort

onabort: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onerror

onerror: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onload

onload: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadend

onloadend: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onloadstart

onloadstart: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onprogress

onprogress: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

onreadystatechange

onreadystatechange: null | ((this: XMLHttpRequest, ev: Event) => any)

MDN Reference

+

ontimeout

ontimeout: null | ((this: XMLHttpRequest, ev: ProgressEvent<EventTarget>) => any)

open

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

-

ReadonlyOPENED

OPENED

overrideMimeType

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

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

+

ReadonlyOPENED

OPENED

overrideMimeType

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

readyState: number

Returns client's state.

+

readyState

readyState: number

Returns client's state.

MDN Reference

-

removeEventListener

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

response

response: any

Returns the response body.

+

removeEventListener

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

response

response: any

Returns the response body.

MDN Reference

-

responseText

responseText: string

Returns response as text.

+

responseText

responseText: string

Returns response as text.

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

MDN Reference

-

responseType

responseType: XMLHttpRequestResponseType

Returns the response type.

+

responseType

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

responseURL: string

MDN Reference

-

responseXML

responseXML: null | Document

Returns the response as document.

+

responseURL

responseURL: string

MDN Reference

+

responseXML

responseXML: null | Document

Returns the response as document.

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

MDN Reference

-

send

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

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

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

Combines a header in author request headers.

+

setRequestHeader

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

status: number

MDN Reference

-

statusText

statusText: string

MDN Reference

-

timeout

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

status: number

MDN Reference

+

statusText

statusText: string

MDN Reference

+

timeout

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

-

ReadonlyUNSENT

UNSENT

upload

upload: XMLHttpRequestUpload

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

+

ReadonlyUNSENT

UNSENT

upload

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

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

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

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/papi-dts/classes/_shared_log_error_model_.default.html b/papi-dts/classes/_shared_log_error_model_.default.html index 986713423c..11f674bf1d 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

Classdefault

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

-

Hierarchy

  • Error
    • default

Constructors

constructor +

Hierarchy

  • Error
    • default

Constructors

constructor

Properties

cause? message name @@ -7,7 +7,7 @@ stack? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Optionalstack

stack?: string

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
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 894900676b..f7521c87e6 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 @@

See

IBaseProjectDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Constructors

constructor

Methods

notifyUpdate

Constructors

constructor

Methods

notifyUpdate

Settings

Member Visibility

On This Page

Constructors
Methods
+

Parameters

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
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 c6315c1ca1..15fdb76938 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.

See

IDataProviderEngine for more information on extending this class.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Methods

notifyUpdate

Constructors

constructor

Methods

notifyUpdate

  • notifyUpdate(updateInstructions?): void

  • 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

Settings

Member Visibility

On This Page

Constructors
Methods
+

Parameters

Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
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 21677428ff..f8c7de14fa 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

constructor +

Type Parameters

  • T

Hierarchy

  • PlatformEventEmitter<T>
    • default

Constructors

constructor

Properties

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

Constructors

constructor

Properties

dispose

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

Disposes of this event, preparing it to release from memory

-

emit

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

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

Disposes of this event, preparing it to release from memory

+

emit

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

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

+

Returns void

subscribe

subscribe: PlatformEvent<T>

Subscribes a function to run when this event is emitted.

Param: callback

Function to run with the event when it is emitted

Returns

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

Alias

event

-

Accessors

event

  • get event(): PlatformEvent<T>

  • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

Accessors

event

  • 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

ProtectedassertNotDisposed

ProtecteddisposeFn

Methods

ProtectedassertNotDisposed

ProtecteddisposeFn

  • disposeFn(): Promise<boolean>

  • 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>

ProtectedemitFn

  • emitFn(event): void

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

    Returns Promise<boolean>

ProtectedemitFn

  • emitFn(event): void

  • 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

emitLocal

  • emitLocal(event): void

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

    +

    Parameters

    • event: T

    Returns void

emitLocal

  • emitLocal(event): 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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
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 9154dc6627..a4fb5ed434 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

constructor +

Type Parameters

Constructors

constructor

Properties

pdpfId pdpfIdRegexString projectInterfacesToLayerOver providedProjectInterfaces

Methods

getAvailableProjects

Constructors

constructor

Properties

pdpfId

pdpfId: string

ProtectedpdpfIdRegexString

pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

-

AbstractprojectInterfacesToLayerOver

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

pdpfId: string

ProtectedpdpfIdRegexString

pdpfIdRegexString: string

Regex-escaped string of this pdpfId.

+

AbstractprojectInterfacesToLayerOver

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.
    • -

    AbstractprovidedProjectInterfaces

    providedProjectInterfaces: SupportedProjectInterfaces

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

    +

    AbstractprovidedProjectInterfaces

    providedProjectInterfaces: SupportedProjectInterfaces

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

    Example

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

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

    -

    Methods

    getAvailableProjects

    Methods

    getAvailableProjects

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Parameters

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    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 da3c671b21..638251d07f 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 @@

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    notifyUpdate

    Constructors

    constructor

    Methods

    notifyUpdate

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Parameters

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    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 4a5b9df2e0..867c2a23a0 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.

    See

    IWebViewProvider for more information on extending this class.

    -

    Type Parameters

    Implements

    Constructors

    constructor +

    Type Parameters

    Implements

    Constructors

    constructor

    Properties

    webViewType

    Methods

    createWebViewController dispose getWebView getWebViewDefinition -

    Constructors

    constructor

    Properties

    ReadonlywebViewType

    webViewType: WebViewType

    Methods

    AbstractcreateWebViewController

    Constructors

    constructor

    Properties

    ReadonlywebViewType

    webViewType: WebViewType

    Methods

    AbstractcreateWebViewController

    • createWebViewController(webViewDefinition, webViewNonce): Promise<WebViewControllers[WebViewType]>

    • 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.

    -

    dispose

    • dispose(): Promise<boolean>

    • Disposes of all WVCs that were created by this provider

      -

      Returns Promise<boolean>

    getWebView

    dispose

    • dispose(): Promise<boolean>

    • Disposes of all WVCs that were created by this provider

      +

      Returns Promise<boolean>

    getWebView

    AbstractgetWebViewDefinition

    AbstractgetWebViewDefinition

    • getWebViewDefinition(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • 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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    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 21203a483e..dddc7d746d 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

    Classdefault

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    Classdefault

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -20,9 +20,9 @@ validateBaseDocument validateContribution validateOutput -

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

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

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    -

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      +

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

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

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: "Project Setting" = 'Project Setting'

    Name for type of setting to use in error messages

    +

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties 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

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    ProtectedgetLocalizedOutput

    ProtectedgetLocalizedOutput

    getLocalizedProjectSettingsContributionInfo

    getLocalizedProjectSettingsContributionInfo

    getProjectSettingsContributionInfo

    getProjectSettingsContributionInfo

    ProtectedperformSchemaValidation

    rebuild

    ProtectedperformSchemaValidation

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    Returns JsonDocumentLike

    Transformed contributed document

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    updateBaseDocument

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    Returns void

    ProtectedvalidateContribution

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    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 52f89fe250..b34213ead0 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

    ClassdefaultAbstract

    Hierarchy (view full)

    Constructors

    constructor +default | papi-dts

    ClassdefaultAbstract

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -18,9 +18,9 @@ validateBaseDocument validateContribution validateOutput -

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

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

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: string

    Name for type of setting to use in error messages

    -

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      +

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike>

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined>

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

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Protected ReadonlysettingTypeName

    settingTypeName: string

    Name for type of setting to use in error messages

    +

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties 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

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    ProtectedgetLocalizedOutput

    ProtectedgetLocalizedOutput

    Protected AbstractperformSchemaValidation

    rebuild

    Protected AbstractperformSchemaValidation

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    Returns JsonDocumentLike

    Transformed contributed document

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    updateBaseDocument

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    Returns void

    ProtectedvalidateContribution

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    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 78d902d4ad..dd1bb8267c 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

    EnumerationEntryType

    Type of file system item in a directory

    -

    Enumeration Members

    Directory +

    Enumeration Members

    Directory File Unknown -

    Enumeration Members

    Directory

    Directory

    File

    File

    Unknown

    Unknown

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Directory

    Directory

    File

    File

    Unknown

    Unknown

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html b/papi-dts/enums/_shared_data_rpc_model_.ConnectionStatus.html index d06286036c..33c4f4b8a7 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

    EnumerationConnectionStatus

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

    -

    Enumeration Members

    Connected +

    Enumeration Members

    Connected Connecting Disconnected

    Enumeration Members

    Connected

    Connected

    Finished setting up its connection

    -

    Connecting

    Connecting

    Attempting to connect to the network

    -

    Disconnected

    Disconnected

    Not connected to the network

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Connecting

    Connecting

    Attempting to connect to the network

    +

    Disconnected

    Disconnected

    Not connected to the network

    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/enums/_shared_global_this_model_.ProcessType.html b/papi-dts/enums/_shared_global_this_model_.ProcessType.html index 383b7ab2a2..3fa681267a 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

    EnumerationProcessType

    Type of Paranext process

    -

    Enumeration Members

    ExtensionHost +

    Enumeration Members

    ExtensionHost Main Renderer -

    Enumeration Members

    ExtensionHost

    ExtensionHost

    Main

    Main

    Renderer

    Renderer

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    ExtensionHost

    ExtensionHost

    Main

    Main

    Renderer

    Renderer

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    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 633c882b36..7a12b12143 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

    EnumerationElevatedPrivilegeNames

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

    -

    Enumeration Members

    createProcess +

    Enumeration Members

    createProcess manageExtensions -

    Enumeration Members

    createProcess

    createProcess

    manageExtensions

    manageExtensions

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    createProcess

    createProcess

    manageExtensions

    manageExtensions

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    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 f2a0b6762e..41b3d7e756 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

    EnumerationWebViewContentType

    The type of code that defines a webview's content

    -

    Enumeration Members

    HTML +

    Enumeration Members

    HTML React URL

    Enumeration Members

    HTML

    HTML

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

    -

    React

    React

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

    React

    React

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

    -

    URL

    URL

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

    URL

    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.

    -

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/papi-dts/functions/__papi_backend_.fetch.html b/papi-dts/functions/__papi_backend_.fetch.html index 5467ba6653..f6985e156c 100644 --- a/papi-dts/functions/__papi_backend_.fetch.html +++ b/papi-dts/functions/__papi_backend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Functionfetch

    This is just an alias for internet.fetch

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

    • MDN Reference

      -

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

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

    • Parameters

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

      Returns Promise<Response>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<Response>

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

  • Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility
    diff --git a/papi-dts/functions/__papi_frontend_.fetch.html b/papi-dts/functions/__papi_frontend_.fetch.html index a65e20e80b..48094b4475 100644 --- a/papi-dts/functions/__papi_frontend_.fetch.html +++ b/papi-dts/functions/__papi_frontend_.fetch.html @@ -1,3 +1,3 @@ fetch | papi-dts

    Functionfetch

    This is just an alias for internet.fetch

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

    • MDN Reference

      -

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

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

    • Parameters

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

      Returns Promise<Response>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<Response>

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

  • Parameters

    Returns Promise<Response>

    • Settings

    Member Visibility
    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 d0dcc1e390..16c67e2fe3 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

    FunctioncreateWebSocket

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

    • createWebSocket(url): Promise<WebSocket>

    • Parameters

      • url: string

      Returns Promise<WebSocket>

      WebSocket

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0c1b85eaf3..51eba08020 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

    FunctionbuildExtensionPathFromName

    • buildExtensionPathFromName(extensionName, fileName): string

    • Return a path to the specified file within the extension's installation directory

      -

      Parameters

      • extensionName: string
      • fileName: string

      Returns string

    Settings

    Member Visibility
    +

    Parameters

    Returns string

    Settings

    Member Visibility
    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 c2d69efbdf..85d7baf5bb 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

    FunctionsetExtensionUris

    • setExtensionUris(urisPerExtension): void

    • 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

    Settings

    Member Visibility
    +

    Parameters

    Returns void

    Settings

    Member Visibility
    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 8bf5ddd2fd..e7fc007f5b 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>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    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 0f967e7fec..29b53e4972 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

    FunctioncreateDir

    • createDir(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 704ca2861e..860c5275ef 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

    FunctiondeleteDir

    • deleteDir(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ebef6c566b..31cc494e4a 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

    FunctiondeleteFile

    • deleteFile(uri): Promise<void>

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 4bd39392d0..e5aee8e9a2 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8cf038e94c..0d6941c22f 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

    FunctionmoveFile

    • moveFile(sourceUri, destinationUri): Promise<void>

    • 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>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    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 ddceadbd81..ff2efcac19 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 a8d9413a7c..63875a9f33 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

    FunctionreadFileBinary

    • readFileBinary(uri): Promise<Buffer>

    • Read a binary file

      Parameters

      • uri: string

        URI of file

      Returns Promise<Buffer>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 768ff84ad5..7c5ea61487 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

    FunctionreadFileText

    • readFileText(uri): Promise<string>

    • Read a text file

      Parameters

      • uri: string

        URI of file

      Returns Promise<string>

      Promise that resolves to the contents of the file

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 6624d97d41..222765557b 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

    Functiontouch

    • touch(uri, date): Promise<void>

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 d6d51765e2..159baed71c 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createNonce.html b/papi-dts/functions/_node_utils_crypto_util_.createNonce.html index 6958328b9f..6c423f7aaf 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

    FunctioncreateNonce

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.createUuid.html b/papi-dts/functions/_node_utils_crypto_util_.createUuid.html index b8327e1e33..248a50ad85 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

    FunctioncreateUuid

    Settings

    Member Visibility
    +createUuid | papi-dts

    FunctioncreateUuid

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html b/papi-dts/functions/_node_utils_crypto_util_.generateHashFromBuffer.html index 9e45b21e11..729c3f4fb2 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)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.getAppDir.html b/papi-dts/functions/_node_utils_util_.getAppDir.html index fd5412e72b..2aaa5df21c 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

    FunctiongetAppDir

    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

    clear +

    Properties

    clear

    Properties

    clear

    clear: (() => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/functions/_node_utils_util_.getPathFromUri.html b/papi-dts/functions/_node_utils_util_.getPathFromUri.html index f451fd8f13..71ca00d5c0 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

    FunctiongetPathFromUri

    • getPathFromUri(uri): string

    • Resolves the uri to a path

      Parameters

      • uri: string

        The uri to resolve

      Returns string

      Real path to the uri supplied

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html b/papi-dts/functions/_node_utils_util_.isNoisyDevModeEnvVariableSet.html index dd42b7738d..4c4bbfb9a9 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

    • isNoisyDevModeEnvVariableSet(): boolean

    • Returns boolean

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.joinUriPaths.html b/papi-dts/functions/_node_utils_util_.joinUriPaths.html index 679aecfba1..c127a86ff5 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html index 0a46f5608d..d6c7378609 100644 --- a/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html +++ b/papi-dts/functions/_node_utils_util_.resolveHtmlPath.html @@ -1 +1 @@ -resolveHtmlPath | papi-dts

    FunctionresolveHtmlPath

    Settings

    Member Visibility
    +resolveHtmlPath | papi-dts

    FunctionresolveHtmlPath

    Settings

    Member Visibility
    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 5afe5719c7..c088c9d8cb 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

    Settings

    Member Visibility
    +

    Returns void

    Settings

    Member Visibility
    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 55a6c6bd57..b661988605 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1c77ed3da4..67fbd758d6 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 35682d66ca..2e2c2a484f 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 15fae92680..690a87ab19 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 44ecb7ee58..54a0a16df0 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 09a945905e..e4eaeef41d 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 -
  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?: Partial<DialogOptions & UseDialogCallbackOptions>) => Promise<void>)

  • Enables using papi.dialogs.showDialog in React more easily. Returns a callback to run that will +

  • default<DialogTabType, DialogOptions>(dialogType, options, resolveCallback): ((optionOverrides?: Partial<DialogOptions & UseDialogCallbackOptions>) => Promise<void>)

  • 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 989f700e4e..589992463f 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 dc916d1f02..08ab8737c6 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 172b051718..f9f98f18b1 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 d9288cd000..1e2ee3fea2 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0b18ed6c23..f900b8a18c 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 98b245fffe..a373ae1173 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0bbaaff2b8..ffdc0b8f32 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7704ba5181..7e119678c4 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

    FunctionblockWebSocketsToPapiNetwork

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 bd3bab7305..55cc30e1cd 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

    FunctiongetScrRefSync

    • getScrRefSync(scrollGroupId?): ScriptureReference

    • See IScrollGroupRemoteService.getScrRef

      -

      Parameters

      • OptionalscrollGroupId: number

      Returns ScriptureReference

    Settings

    Member Visibility
    +

    Parameters

    Returns ScriptureReference

    Settings

    Member Visibility
    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 ff0ab7ab75..a25869eee0 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

    FunctiononDidUpdateScrRef

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5ad844bd98..586460ed13 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

    Settings

    Member Visibility
    +

    Returns boolean

    Settings

    Member Visibility
    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 ac2f7d9b5f..7f710e27c1 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

    FunctionstartScrollGroupService

    • startScrollGroupService(): Promise<void>

    • Register the network object that backs the scroll group service

      -

      Returns Promise<void>

    Settings

    Member Visibility
    +

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createErrorResponse.html index 24342b3fe0..479b03cb15 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createRequest.html b/papi-dts/functions/_shared_data_rpc_model_.createRequest.html index d068a66c6f..de2977a2c8 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html b/papi-dts/functions/_shared_data_rpc_model_.createSuccessResponse.html index 2a9f9c1225..e70331ee0c 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html b/papi-dts/functions/_shared_data_rpc_model_.deserializeMessage.html index 62c289c494..625a4fc7c7 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)[]

    Settings

    Member Visibility
    +

    Parameters

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

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html b/papi-dts/functions/_shared_data_rpc_model_.fixupResponse.html index 781e7b07f5..9443ab68de 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

    FunctionfixupResponse

    • fixupResponse(response): JSONRPCResponse

    • 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

    Settings

    Member Visibility
    +

    Parameters

    Returns JSONRPCResponse

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html b/papi-dts/functions/_shared_data_rpc_model_.requestWithRetry.html index a2a5ed7584..78f1daac21 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html b/papi-dts/functions/_shared_data_rpc_model_.sendPayloadToWebSocket.html index 3b8fcd1d7f..04fa3fe3e6 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

    FunctionsendPayloadToWebSocket

    • sendPayloadToWebSocket(ws, payload): void

    • Serialize a payload, if needed, and send it over the provided WebSocket

      -

      Parameters

      • ws: undefined | WebSocket
      • payload: unknown

      Returns void

    Settings

    Member Visibility
    +

    Parameters

    Returns void

    Settings

    Member Visibility
    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 4754f32620..28f8c825cf 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

    FunctiongetDataProviderDataTypeFromFunctionName

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f0fab87898..3fca29bd04 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c7c1e2edbb..e15ef7710e 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7c3be9e59a..ba6db96edf 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

    FunctiongetPDPFactoryIdFromNetworkObjectName

    • getPDPFactoryIdFromNetworkObjectName(pdpFactoryNetworkObjectName): string

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e33e0c56a5..85219a0bf0 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

    FunctiongetPDPFactoryNetworkObjectNameFromId

    • getPDPFactoryNetworkObjectNameFromId(pdpFactoryId): string

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 bc7fb41709..0b3cd3ce30 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[]>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<ProjectMetadata[]>

    Settings

    Member Visibility
    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 55ea591141..692e60f5b6 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

    FunctiontransformGetMetadataForProjectParametersToFilter

    • transformGetMetadataForProjectParametersToFilter(projectId?, projectInterface?, pdpFactoryId?): {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

    • 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

    Settings

    Member Visibility
    +transformGetMetadataForProjectParametersToFilter | papi-dts

    FunctiontransformGetMetadataForProjectParametersToFilter

    • transformGetMetadataForProjectParametersToFilter(projectId?, projectInterface?, pdpFactoryId?): {
          includePdpFactoryIds: string | undefined;
          includeProjectIds: string | undefined;
          includeProjectInterfaces: string | undefined;
      }

    • 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

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html b/papi-dts/functions/_shared_services_command_service_.createSendCommandFunction.html index 1258fe4228..804944461b 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_command_service_.registerCommand.html b/papi-dts/functions/_shared_services_command_service_.registerCommand.html index 4b9e38c006..7eb1b41c3b 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

    • 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_command_service_.sendCommand.html b/papi-dts/functions/_shared_services_command_service_.sendCommand.html index b3595a9cbb..234d7dc61f 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

    FunctionsendCommand

    Send a command to the backend.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 73a34e5efe..6a74e57666 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

    FunctiongetByType

    • getByType<T>(providerName): Promise<T | undefined>

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 61d99d5e89..393725a8de 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_logger_service_.formatLog.html b/papi-dts/functions/_shared_services_logger_service_.formatLog.html index 92e21d26d3..04652e16db 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1951c43b68..0e5ecfd643 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

    FunctiononDidCreateNetworkObject

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ced8f41c11..3b753dca4e 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

    FunctiononDidDisposeNetworkObject

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

    -
    • onDidDisposeNetworkObject(callback): Unsubscriber

    • Parameters

      • callback: PlatformEventHandler<string>

      Returns Unsubscriber

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 76956e330e..06991852f1 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

    FunctionoverrideDispose

    • overrideDispose(objectToMutate, newDispose): void

    • If dispose already exists on objectToMutate, we will call it in addition to newDispose

      -

      Parameters

      • objectToMutate: IDisposableObject
      • newDispose: UnsubscriberAsync

      Returns void

    Settings

    Member Visibility
    +

    Parameters

    Returns void

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html b/papi-dts/functions/_shared_services_network_service_.createNetworkEventEmitter.html index 827ed38306..ef8e51c38e 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.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html b/papi-dts/functions/_shared_services_network_service_.createRequestFunction.html index 7528504712..58be2f66e0 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html b/papi-dts/functions/_shared_services_network_service_.getNetworkEvent.html index 059fb9df22..9745ff57c1 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

    FunctiongetNetworkEvent

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

    • getNetworkEvent<T>(eventType): PlatformEvent<T>

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.initialize.html b/papi-dts/functions/_shared_services_network_service_.initialize.html index dba7f1bc89..b655ce44a2 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

    Functioninitialize

    Settings

    Member Visibility
    +initialize | papi-dts

    Functioninitialize

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html b/papi-dts/functions/_shared_services_network_service_.registerRequestHandler.html index b2974d26c2..69f15ed8f2 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.request.html b/papi-dts/functions/_shared_services_network_service_.request.html index 638d45a3b0..fd5984c16c 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_services_network_service_.shutdown.html b/papi-dts/functions/_shared_services_network_service_.shutdown.html index f3d85516cb..13601d6b57 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

    Functionshutdown

    Closes the network services gracefully

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b5e4f9b975..87c32eceea 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 @@

    Throws

    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)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e5970206ca..9a4451f236 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 98d81c8bb3..15120d35d8 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 53958f57bc..8c587f43f8 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

    FunctioncreateRpcHandler

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 55d6f836eb..507225c4fb 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

    FunctiongetWebViewController

    Settings

    Member Visibility
    +getWebViewController | papi-dts

    FunctiongetWebViewController

    Settings

    Member Visibility
    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 740f480d72..3375f5c01c 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

    FunctiongetWebViewControllerObjectId

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c45fff6789..dc938d0e0d 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

    FunctiongetWebViewMessageRequestType

    • getWebViewMessageRequestType(webViewId): `${string}:${string}`

    • Get request type for posting a message to a web view

      -

      Parameters

      • webViewId: string

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

    Settings

    Member Visibility
    +

    Parameters

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

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html b/papi-dts/functions/_shared_utils_internal_util_.getProcessType.html index e890fc6289..abb49f7b28 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

    FunctiongetProcessType

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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isClient.html b/papi-dts/functions/_shared_utils_internal_util_.isClient.html index 6d7c7db960..c6a2167078 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

    FunctionisClient

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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html b/papi-dts/functions/_shared_utils_internal_util_.isExtensionHost.html index 45f0d8107d..03280ab4bb 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

    FunctionisExtensionHost

    Determine if running on the extension host

    • isExtensionHost(): boolean

    • Returns boolean

      Returns true if running on the extension host, false otherwise

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html b/papi-dts/functions/_shared_utils_internal_util_.isRenderer.html index 1eefbb0e77..f932eb90d6 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

    FunctionisRenderer

    Determine if running on the renderer process

    • isRenderer(): boolean

    • Returns boolean

      Returns true if running on the renderer, false otherwise

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_internal_util_.isServer.html b/papi-dts/functions/_shared_utils_internal_util_.isServer.html index 99c147aa38..52694f36f5 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

    FunctionisServer

    Determine if running on the server process (main)

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.bindClassMethods.html b/papi-dts/functions/_shared_utils_util_.bindClassMethods.html index 006b094fef..6c90b5517b 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

    Settings

    Member Visibility
    +

    Type Parameters

    Parameters

    Returns void

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html b/papi-dts/functions/_shared_utils_util_.deserializeRequestType.html index dc4933814a..e2ca847172 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

    FunctiondeserializeRequestType

    Settings

    Member Visibility
    +

    Parameters

    Returns RequestType

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html b/papi-dts/functions/_shared_utils_util_.getModuleSimilarApiMessage.html index a814470299..459e360883 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

    FunctiongetModuleSimilarApiMessage

    • getModuleSimilarApiMessage(moduleName): string

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.newNonce.html b/papi-dts/functions/_shared_utils_util_.newNonce.html index 73f242a804..d75887fcfb 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

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/_shared_utils_util_.serializeRequestType.html b/papi-dts/functions/_shared_utils_util_.serializeRequestType.html index 6b4b568367..250bd919d3 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/getSavedWebViewDefinition.html b/papi-dts/functions/getSavedWebViewDefinition.html index 3a78dc307d..47acf6f693 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/getSavedWebViewDefinitionById.html b/papi-dts/functions/getSavedWebViewDefinitionById.html index cb18778dcf..ab95bc4999 100644 --- a/papi-dts/functions/getSavedWebViewDefinitionById.html +++ b/papi-dts/functions/getSavedWebViewDefinitionById.html @@ -1 +1 @@ -getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    Settings

    Member Visibility
    +getSavedWebViewDefinitionById | papi-dts

    FunctiongetSavedWebViewDefinitionById

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/getWebViewState.html b/papi-dts/functions/getWebViewState.html index d56b02edb4..f5d86b5f23 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/resetWebViewState.html b/papi-dts/functions/resetWebViewState.html index f72920740f..e3b69a36b9 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/setWebViewState.html b/papi-dts/functions/setWebViewState.html index ec671105f0..1d3a750936 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.

    -
    • setWebViewState<T>(stateKey, stateValue): void

    • Type Parameters

      • T

      Parameters

      • stateKey: string
      • stateValue: T

      Returns void

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/updateWebViewDefinition.html b/papi-dts/functions/updateWebViewDefinition.html index c9a732ed77..2312cc9fe4 100644 --- a/papi-dts/functions/updateWebViewDefinition.html +++ b/papi-dts/functions/updateWebViewDefinition.html @@ -7,4 +7,4 @@ 
    updateWebViewDefinition({ title: `Hello ${name}` });
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/updateWebViewDefinitionById.html b/papi-dts/functions/updateWebViewDefinitionById.html index 18e9d226a7..e4b2e807c8 100644 --- a/papi-dts/functions/updateWebViewDefinitionById.html +++ b/papi-dts/functions/updateWebViewDefinitionById.html @@ -1 +1 @@ -updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    Settings

    Member Visibility
    +updateWebViewDefinitionById | papi-dts

    FunctionupdateWebViewDefinitionById

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/useWebViewScrollGroupScrRef.html b/papi-dts/functions/useWebViewScrollGroupScrRef.html index 26a650ff31..9ec3781d59 100644 --- a/papi-dts/functions/useWebViewScrollGroupScrRef.html +++ b/papi-dts/functions/useWebViewScrollGroupScrRef.html @@ -16,4 +16,4 @@ 
    const [scrRef, setScrRef, scrollGroupId, setScrollGroupId] = useWebViewScrollGroupScrRef();
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/useWebViewState.html b/papi-dts/functions/useWebViewState.html index 98d9747274..42908c8509 100644 --- a/papi-dts/functions/useWebViewState.html +++ b/papi-dts/functions/useWebViewState.html @@ -25,4 +25,4 @@ 
    const [lastPersonSeen, setLastPersonSeen] = useWebViewState('lastSeen', 'No one');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/functions/webViewComponent.html b/papi-dts/functions/webViewComponent.html index 2881112a11..b278345921 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

    contextTypes? +

    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 cb6503b058..1f1acc40cc 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

    InterfaceIExtension

    Interface for all extensions to implement

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

    Properties

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

    Properties

    activate deactivate?

    Properties

    activate

    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>

    Optionaldeactivate

    deactivate?: UnsubscriberAsync

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

    Returns Promise<void>

    Optionaldeactivate

    deactivate?: UnsubscriberAsync

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

    Returns

    Promise that resolves to true if successfully deactivated

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 d6949653ff..a2925c3b0b 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

    InterfaceExtensionStorageService

    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

    InterfaceExtensionStorageService

    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 readBinaryFileFromInstallDirectory readTextFileFromInstallDirectory readUserData @@ -8,23 +8,23 @@

    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

    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

    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

    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

    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

    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

    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

    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

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html index 172feb1e0e..01e7d8d467 100644 --- a/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html +++ b/papi-dts/interfaces/_papi_shared_types_.CommandHandlers.html @@ -7,7 +7,7 @@

    Example

    declare module 'papi-shared-types' {
      export interface CommandHandlers {
        'myExtension.myCommand1': (foo: string, bar: number) => string;
        'myExtension.myCommand2': (foo: string) => Promise<void>;
      }
    }
    -
    interface CommandHandlers {
        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.openProjectSettings +
    interface CommandHandlers {
        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.openProjectSettings platform.openSettings platform.openUserSettings platform.quit @@ -19,7 +19,7 @@ test.throwError test.throwErrorExtensionHost

    Properties

    platform.openProjectSettings

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

    Deprecated

    3 December 2024. Renamed to platform.openSettings

    -

    platform.openSettings

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

    platform.openUserSettings

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

    Deprecated

    3 December 2024. Renamed to platform.openSettings

    -

    platform.quit

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

    Shut down the application

    -

    platform.restart

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

    Restart the application

    -

    platform.restartExtensionHost

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

    test.addMany

    test.addMany: ((...nums: number[]) => number)

    test.echo

    test.echo: ((message: string) => string)

    test.echoExtensionHost

    test.echoExtensionHost: ((message: string) => Promise<string>)

    test.throwError

    test.throwError: ((message: string) => void)

    test.throwErrorExtensionHost

    test.throwErrorExtensionHost: ((message: string) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    +

    platform.openSettings

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

    platform.openUserSettings

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

    Deprecated

    3 December 2024. Renamed to platform.openSettings

    +

    platform.quit

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

    Shut down the application

    +

    platform.restart

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

    Restart the application

    +

    platform.restartExtensionHost

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

    test.addMany

    test.addMany: ((...nums: number[]) => number)

    test.echo

    test.echo: ((message: string) => string)

    test.echoExtensionHost

    test.echoExtensionHost: ((message: string) => Promise<string>)

    test.throwError

    test.throwError: ((message: string) => void)

    test.throwErrorExtensionHost

    test.throwErrorExtensionHost: ((message: string) => void)

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html index 6a97a9c364..86aca103aa 100644 --- a/papi-dts/interfaces/_papi_shared_types_.DataProviders.html +++ b/papi-dts/interfaces/_papi_shared_types_.DataProviders.html @@ -11,6 +11,6 @@

    Example

    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>;
    }

    Properties

    platform.placeholder +
    interface DataProviders {
        platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>;
        platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>;
    }

    Properties

    platform.placeholder platform.stuff -

    Properties

    platform.placeholder

    platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>

    platform.stuff

    platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    platform.placeholder

    platform.placeholder: "shared/models/data-provider.interface".default<PlaceholderDataTypes>

    platform.stuff

    platform.stuff: "shared/models/data-provider.interface".default<StuffDataTypes>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html index 091f7f3e3a..6cedb15da4 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectDataProviderInterfaces.html @@ -34,10 +34,10 @@

    Example

    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

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

    Properties

    platform.base platform.notesOnly platform.placeholder

    Properties

    platform.base

    platform.base: IBaseProjectDataProvider<MandatoryProjectDataTypes>

    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

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    platform.notesOnly

    platform.notesOnly: IProjectDataProvider<NotesOnlyProjectDataTypes>

    platform.placeholder

    platform.placeholder: IProjectDataProvider<PlaceholderDataTypes>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html index 589cee080e..61522947d6 100644 --- a/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.ProjectSettingTypes.html @@ -10,7 +10,7 @@

    Example

    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

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

    Properties

    platform.fullName platform.isEditable platform.language platform.name @@ -18,17 +18,17 @@

    Example

    'World English Bible'
    -

    platform.isEditable

    platform.isEditable: boolean

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

    platform.isEditable

    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

    platform.language: string

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

    platform.language

    platform.language: string

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

    Example

    'English'
    -

    platform.name

    platform.name: string

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

    platform.name

    platform.name: string

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

    Example

    'WEB'
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html index 8177407b4e..ef0810304e 100644 --- a/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html +++ b/papi-dts/interfaces/_papi_shared_types_.SettingTypes.html @@ -9,19 +9,19 @@

    Example

    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;
    }

    Properties

    platform.commentsEnabled +
    interface SettingTypes {
        platform.commentsEnabled: boolean;
        platform.interfaceLanguage: string[];
        platform.paratextDataLastRegistryDataCachedTimes: {
            [key: string]: string;
        };
        platform.ptxUtilsMementoData: {
            [key: string]: string;
        };
        platform.verseRef: ScriptureReference;
    }

    Properties

    platform.commentsEnabled platform.interfaceLanguage platform.paratextDataLastRegistryDataCachedTimes platform.ptxUtilsMementoData platform.verseRef

    Properties

    platform.commentsEnabled

    platform.commentsEnabled: boolean

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

    -

    platform.interfaceLanguage

    platform.interfaceLanguage: string[]

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

    platform.interfaceLanguage

    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

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

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

    platform.paratextDataLastRegistryDataCachedTimes

    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

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

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

    platform.ptxUtilsMementoData

    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

    platform.verseRef: ScriptureReference

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

    platform.verseRef

    platform.verseRef: ScriptureReference

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html index 30f0e0b05b..ac440fab1d 100644 --- a/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html +++ b/papi-dts/interfaces/_papi_shared_types_.WebViewControllers.html @@ -18,6 +18,6 @@

    Example

    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>;
        }>;
    }

    Properties

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

    Properties

    platform.placeholderWebView platform.stuffWebView -

    Properties

    platform.placeholderWebView

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

    platform.stuffWebView

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

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    platform.placeholderWebView

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

    platform.stuffWebView

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

    Settings

    Member Visibility

    On This Page

    Properties
    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 bd4b318fbb..81cf1ec145 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

    InterfaceDialogTypes

    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

    -
    interface DialogTypes {
        platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>;
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

    platform.selectBooks +
    interface DialogTypes {
        platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>;
        platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>;
        platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>;
    }

    Properties

    platform.selectBooks platform.selectMultipleProjects platform.selectProject -

    Properties

    platform.selectBooks

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>

    platform.selectMultipleProjects

    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    platform.selectBooks

    platform.selectBooks: DialogDataTypes<SelectBooksDialogOptions, string[]>

    platform.selectMultipleProjects

    platform.selectMultipleProjects: DialogDataTypes<SelectMultipleProjectsDialogOptions, string[]>

    platform.selectProject

    platform.selectProject: DialogDataTypes<ProjectDialogOptionsBase, string>

    Settings

    Member Visibility

    On This Page

    Properties
    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 be7bcedd8d..01c560e07f 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

    InterfaceFloatLayout

    Information about a floating window

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

    Properties

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

    Properties

    floatSize? position? type -

    Properties

    OptionalfloatSize

    floatSize?: FloatSize

    Optionalposition

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    -

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalfloatSize

    floatSize?: FloatSize

    Optionalposition

    position?: FloatPosition

    Where to display the floating window. Defaults to cascade

    +

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    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 9a428d9345..4441f46fcb 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

    InterfacePanelLayout

    Information about a panel

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

    Properties

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

    Properties

    direction? targetTabId? type -

    Properties

    Optionaldirection

    direction?: PanelDirection

    OptionaltargetTabId

    targetTabId?: string

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

    -

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionaldirection

    direction?: PanelDirection

    OptionaltargetTabId

    targetTabId?: string

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

    +

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    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 77b8ece1a9..b696830e8f 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

    InterfaceTabLayout

    Information about a tab in a panel

    -
    interface TabLayout {
        type: "tab";
    }

    Properties

    type -

    Properties

    type

    type

    Settings

    Member Visibility

    On This Page

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

    Properties

    type +

    Properties

    type

    type

    Settings

    Member Visibility

    On This Page

    Properties
    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 44079ed9d4..9fc87acd62 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

    InterfaceNetworkObjectStatusRemoteServiceType

    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails +NetworkObjectStatusRemoteServiceType | papi-dts

    InterfaceNetworkObjectStatusRemoteServiceType

    interface NetworkObjectStatusRemoteServiceType {
        getAllNetworkObjectDetails: (() => Promise<Record<string, NetworkObjectDetails>>);
    }

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails

    Properties

    getAllNetworkObjectDetails

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

    Get details about all available network objects

    Type declaration

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 ddca328cdd..76c7aebe3e 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

    InterfaceNetworkObjectStatusServiceType

    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

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

    Hierarchy (view full)

    Properties

    getAllNetworkObjectDetails waitForNetworkObject

    Properties

    getAllNetworkObjectDetails

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

    Get details about all available network objects

    Type declaration

    waitForNetworkObject

    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

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 761e7370cc..541421d73c 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

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

    Type Parameters

    Methods

    createProjectDataProviderEngine getAvailableProjects

    Methods

    createProjectDataProviderEngine

    getAvailableProjects

    getAvailableProjects

    • getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>

    • 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[]>

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    Settings

    Member Visibility

    On This Page

    Methods
    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 efe292c700..d75cda422d 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

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

    Hierarchy

    • Dispose
      • default

    Properties

    dispose

    Methods

    getAvailableProjects getProjectDataProviderId

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Methods

    getAvailableProjects

    Methods

    getAvailableProjects

    • getAvailableProjects(layeringFilters?): Promise<ProjectMetadataWithoutFactoryInfo[]>

    • 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[]>

    getProjectDataProviderId

    Returns Promise<ProjectMetadataWithoutFactoryInfo[]>

    getProjectDataProviderId

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcHandler.html index 2c6e98b93d..dbcb2e84ca 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

    connect +
    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

    connect connectionStatus disconnect emitEventOnNetwork @@ -18,19 +18,19 @@

    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: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    disconnect

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

    Disconnects from the connection:

    +

    disconnect

    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

    emitEventOnNetwork: EventHandler

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

    emitEventOnNetwork

    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.

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event data to emit on the network

    -

    request

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

    Send a request and resolve after receiving a response

    +

    request

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html b/papi-dts/interfaces/_shared_models_rpc_interface_.IRpcMethodRegistrar.html index 7522702a9b..59bced8642 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) => Promise<boolean>);
        request: ((requestType: `${string}:${string}`, requestParams: RequestParams) => Promise<JSONRPCResponse>);
        unregisterMethod: ((methodName: string) => Promise<boolean>);
    }

    Hierarchy (view full)

    Implemented by

    Properties

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

    Hierarchy (view full)

    Implemented by

    Properties

    connect connectionStatus disconnect emitEventOnNetwork @@ -21,21 +21,21 @@

    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: ConnectionStatus

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

    connectionStatus

    connectionStatus: ConnectionStatus

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

    -

    disconnect

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

    Disconnects from the connection:

    +

    disconnect

    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

    emitEventOnNetwork: EventHandler

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

    emitEventOnNetwork

    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.

    Param: eventType

    Unique network event type for coordinating between processes

    Param: event

    Event data to emit on the network

    -

    registerMethod

    registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>)

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

    -

    request

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

    Send a request and resolve after receiving a response

    +

    registerMethod

    registerMethod: ((methodName: string, method: InternalRequestHandler) => Promise<boolean>)

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

    +

    request

    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

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

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    unregisterMethod

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

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

    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 324a9d195a..4a4c07b14d 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

    InterfaceIDisposableWebViewProvider

    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

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

    Hierarchy (view full)

    Properties

    dispose onDidDispose

    Methods

    getWebView

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    • getWebView(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • 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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 d7b6df4a81..1474be7d13 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

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

    Hierarchy (view full)

    Properties

    onDidDispose

    Methods

    getWebView

    Properties

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    Methods

    getWebView

    • getWebView(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • 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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 95d03d85fa..f06bf610b7 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

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

    Hierarchy (view full)

    Implemented by

    Properties

    dispose? onDidDispose?

    Methods

    getWebView

    Properties

    Optionaldispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Methods

    getWebView

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Methods

    getWebView

    • getWebView(savedWebViewDefinition, getWebViewOptions, webViewNonce): Promise<undefined | WebViewDefinition>

    • 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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 94b4401aad..b95549c1e1 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

    InterfaceDataProviderService

    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

    InterfaceDataProviderService

    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.

    See

    IDataProviderEngine for more information on extending this class.

    -

    decorators

    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

    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

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

    Get a data provider that has previously been set up

    +

    get

    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

    Param: providerName

    Name of the desired data provider

    Returns

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

    -

    hasKnown

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

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

    hasKnown

    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

    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

    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.

        Returns

        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.

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 844b3750c1..2bda047af5 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

    InterfaceDialogService

    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

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

    Methods

    selectProject showDialog

    Methods

    selectProject

    • selectProject(options?): Promise<undefined | string>

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

      Parameters

      Returns Promise<undefined | string>

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

      -

    showDialog

    showDialog

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html b/papi-dts/interfaces/_shared_services_internet_service_.InternetService.html index ec46c59c90..588b9b34aa 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

    InterfaceInternetService

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

    Properties

    fetch +InternetService | papi-dts

    InterfaceInternetService

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

    Properties

    fetch

    Properties

    fetch

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

    Type declaration

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

      • MDN Reference

        -

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

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

      • Parameters

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

        Returns Promise<Response>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Parameters

    • input: RequestInfo | URL
    • Optionalinit: RequestInit

    Returns Promise<Response>

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

  • Parameters

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

    Returns Promise<Response>

    • Settings

    Member Visibility

    On This Page

    Properties
    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 0721239dc2..c0e0f17c96 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

    InterfaceMinimalNetworkObjectService

    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;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +MinimalNetworkObjectService | papi-dts

    InterfaceMinimalNetworkObjectService

    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;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get onDidCreateNetworkObject set

    Properties

    get

    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

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

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

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        +

    onDidCreateNetworkObject

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

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

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): 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

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 c15b06e18f..f5713c9006 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

    InterfaceNetworkObjectService

    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;
        }) => Promise<DisposableNetworkObject<T>>);
    }

    Hierarchy (view full)

    Properties

    get +NetworkObjectService | papi-dts

    InterfaceNetworkObjectService

    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;
        }) => 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

    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

    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

    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

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

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

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): Promise<DisposableNetworkObject<T>>

      • Set up an object to be shared on the network.

        +

    initialize

    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

    onDidCreateNetworkObject: PlatformEvent<NetworkObjectDetails>

    set

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

    Type declaration

      • <T>(id, objectToShare, objectType?, objectAttributes?): 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

        Returns Promise<DisposableNetworkObject<T>>

        objectToShare modified to be a network object

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html b/papi-dts/interfaces/_shared_services_network_service_.PapiNetworkService.html index 3c9fd7efe1..18e130cc1b 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

    InterfacePapiNetworkService

    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter +PapiNetworkService | papi-dts

    InterfacePapiNetworkService

    interface PapiNetworkService {
        createNetworkEventEmitter: (<T>(eventType: string) => PlatformEventEmitter<T>);
        getNetworkEvent: (<T>(eventType: string) => PlatformEvent<T>);
    }

    Properties

    createNetworkEventEmitter getNetworkEvent

    Properties

    createNetworkEventEmitter

    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

    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

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 6e57d159fc..389e1e31e2 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

    InterfacePapiBackendProjectDataProviderService

    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

    InterfacePapiBackendProjectDataProviderService

    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 registerProjectDataProviderEngineFactory

    Properties

    get

    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 @@

          Throws

          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

    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

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 b197afd9a5..b431d93c28 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

    InterfacePapiFrontendProjectDataProviderService

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

    Properties

    get +PapiFrontendProjectDataProviderService | papi-dts

    InterfacePapiFrontendProjectDataProviderService

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

    Properties

    get

    Properties

    get

    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 @@

          Throws

          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)

          -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 9b747a5b62..4d2dcd1472 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

    InterfaceIProjectSettingsService

    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

    getDefault +
    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

    getDefault getLocalizedContributionInfo isValid registerValidator @@ -11,10 +11,10 @@

    Type Parameters

    Parameters

    Returns Promise<ProjectSettingTypes[ProjectSettingName]>

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

    Throws

    If a default value is not registered for the setting

    -

    getLocalizedContributionInfo

    • 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;
              };
          };
      }>

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

    getLocalizedContributionInfo

    • 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;
              };
          };
      }>

    • 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

      -

    isValid

    isValid

    • isValid<ProjectSettingName>(key, newValue, currentValue, allChanges?): Promise<boolean>

    • 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

    -

    registerValidator

    registerValidator

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    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 cbc47f6f07..ef6636e3fd 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

    InterfaceIScrollGroupRemoteService

    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

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

    Hierarchy (view full)

    Methods

    getScrRef setScrRef

    Methods

    getScrRef

    • getScrRef(scrollGroupId?): Promise<ScriptureReference>

    • 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

      -

    setScrRef

    • setScrRef(scrollGroupId, scrRef): Promise<boolean>

    • Sets the ScriptureReference associated with the provided scroll group

      +

    setScrRef

    • setScrRef(scrollGroupId, scrRef): Promise<boolean>

    • 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

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    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 edec8b276e..46e760f215 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

    InterfaceIScrollGroupService

    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

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

    Hierarchy (view full)

    Properties

    onDidUpdateScrRef

    Methods

    getScrRef setScrRef

    Properties

    onDidUpdateScrRef

    onDidUpdateScrRef: PlatformEvent<ScrollGroupUpdateInfo>

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

    -

    Methods

    getScrRef

    • getScrRef(scrollGroupId?): Promise<ScriptureReference>

    • Get the ScriptureReference associated with the provided scroll group

      +

    Methods

    getScrRef

    • getScrRef(scrollGroupId?): Promise<ScriptureReference>

    • 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

      -

    setScrRef

    setScrRef

    • setScrRef(scrollGroupId, scrRef): Promise<boolean>

    • 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

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    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 6c200270ef..63ec81aed0 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

    InterfacePapiWebViewProviderService

    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

    InterfacePapiWebViewProviderService

    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

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

    Deprecated

    13 November 2024. Renamed to registerWebViewProvider

    -

    registerWebViewController

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

    Type declaration

    Returns Promise<void>

    register

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

    Deprecated

    13 November 2024. Renamed to registerWebViewProvider

    +

    registerWebViewController

    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

    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

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 391cdf6a1a..c5f5224355 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

    InterfaceWebViewProviderService

    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

    InterfaceWebViewProviderService

    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 initialize postMessageToWebView registerWebViewController @@ -6,8 +6,8 @@

    Properties

    getWebViewProvider

    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

    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

    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

    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

    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

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

    Type declaration

    Returns Promise<void>

    registerWebViewController

    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

    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

    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

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    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 a7f863524a..3bf1eb5751 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

    InterfaceWebViewServiceType

    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

    getWebView +
    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 onDidAddWebView onDidCloseWebView onDidOpenWebView @@ -11,11 +11,11 @@ getSavedWebViewDefinition getWebViewController

    Properties

    getWebView

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

    Deprecated

    6 November 2024. Renamed to openWebView.

    -

    onDidAddWebView

    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    Deprecated

    13 November 2024. Renamed to onDidOpenWebView

    -

    onDidCloseWebView

    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    -

    onDidOpenWebView

    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    -

    onDidUpdateWebView

    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    -

    openWebView

    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

    onDidAddWebView: PlatformEvent<OpenWebViewEvent>

    Deprecated

    13 November 2024. Renamed to onDidOpenWebView

    +

    onDidCloseWebView

    onDidCloseWebView: PlatformEvent<CloseWebViewEvent>

    Event that emits with webView info when a webView is closed

    +

    onDidOpenWebView

    onDidOpenWebView: PlatformEvent<OpenWebViewEvent>

    Event that emits with webView info when a webView is created

    +

    onDidUpdateWebView

    onDidUpdateWebView: PlatformEvent<UpdateWebViewEvent>

    Event that emits with webView info when a webView is updated

    +

    openWebView

    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.

    Throws

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

    -

    Methods

    getOpenWebViewDefinition

    • getOpenWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>

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

      +

    Methods

    getOpenWebViewDefinition

    • getOpenWebViewDefinition(webViewId): Promise<undefined | SavedWebViewDefinition>

    • 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

      -

    getSavedWebViewDefinition

    getWebViewController

    getSavedWebViewDefinition

    getWebViewController

    • getWebViewController<WebViewType>(webViewType, webViewId): Promise<undefined | NetworkObject<WebViewControllers[WebViewType]>>

    • 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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/papi-dts/modules/__papi_backend_.html b/papi-dts/modules/__papi_backend_.html index b3cb0fdb28..88972f46d8 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 0dca15e5b5..c3831252db 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

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

    Namespace"@papi/core"

    References

    DataProviderDataType DataProviderSubscriberOptions DataProviderUpdateInstructions DialogOptions diff --git a/papi-dts/modules/__papi_frontend_.html b/papi-dts/modules/__papi_frontend_.html index ac030f9e4f..2cf60bece0 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

    Papi

    Variables

    commands dataProviders default diff --git a/papi-dts/modules/__papi_frontend_react_.html b/papi-dts/modules/__papi_frontend_react_.html index ba8a5e6c8a..ecf83deb7d 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 695b565a04..2d31f9ee89 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_client_services_web_socket_factory_.html b/papi-dts/modules/_client_services_web_socket_factory_.html index 7781e14ac8..7ec267bcdf 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

    createWebSocket

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_client_services_web_socket_interface_.html b/papi-dts/modules/_client_services_web_socket_interface_.html index 10b223a439..3e35df888d 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

    IWebSocket

    Settings

    Member Visibility
    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 608638e5dd..fcda415eb1 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

    ExecutionActivationContext

    Settings

    Member Visibility
    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 dc987ad219..55b67ecd58 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

    IExtension

    Settings

    Member Visibility
    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 9e11f2168b..47e74385f6 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

    ExtensionManifest

    Settings

    Member Visibility
    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 20bdff4c16..d445a4c75f 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

    default

    Classes

    default

    Settings

    Member Visibility
    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 718fb4c36c..849dc21e0e 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

    ExtensionStorageService

    Variables

    default

    Functions

    buildExtensionPathFromName setExtensionUris diff --git a/papi-dts/modules/_main_services_rpc_server_.html b/papi-dts/modules/_main_services_rpc_server_.html index b6dbda56cf..35987bc8fd 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

    default

    Type Aliases

    PropagateEventMethod

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_main_services_rpc_websocket_listener_.html b/papi-dts/modules/_main_services_rpc_websocket_listener_.html index 3da01d0894..d0e1dc23c8 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_node_models_execution_token_model_.html b/papi-dts/modules/_node_models_execution_token_model_.html index 06552d97c8..ab76d22f4f 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

    ExecutionToken

    Type Aliases

    ExecutionTokenType

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_node_services_execution_token_service_.html b/papi-dts/modules/_node_services_execution_token_service_.html index b80a4d3045..6555f696ed 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

    default

    Settings

    Member Visibility
    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 96f4c7b32c..75e0c46e12 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

    EntryType

    Type Aliases

    DirectoryEntries

    Functions

    copyFile createDir diff --git a/papi-dts/modules/_node_utils_crypto_util_.html b/papi-dts/modules/_node_utils_crypto_util_.html index 743e7f69e1..8a743d5834 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

    Namespace"node/utils/crypto-util"

    Index

    Functions

    createNonce createUuid generateHashFromBuffer

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_node_utils_util_.html b/papi-dts/modules/_node_utils_util_.html index 3a434459d4..d9562f8395 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

    FILE_PROTOCOL RESOURCES_PROTOCOL

    Functions

    getAppDir getPathFromUri diff --git a/papi-dts/modules/_papi_shared_types_.html b/papi-dts/modules/_papi_shared_types_.html index 90ed33da69..c26ac2780a 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 34552e75f2..b9c8b768c8 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

    DialogDefinitionBase DialogProps

    Variables

    default

    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 ddeb435417..c46e8d785a 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

    DialogTypes

    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 0d89b6862b..a28a3d4c0c 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

    default

    Settings

    Member Visibility
    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 78bf8e7f45..48975e54ee 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html b/papi-dts/modules/_renderer_hooks_papi_hooks_index_.html index 6d4c11a201..bab14eaa5e 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 8bb53e2985..54421dd61d 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

    default

    Settings

    Member Visibility
    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 3d58205433..547b4e24ac 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

    default

    Settings

    Member Visibility
    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 b9acbc569a..e1b2c26b34 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

    default

    Settings

    Member Visibility
    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 c73cc6a7ca..ed4b4ce57f 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

    UseDialogCallbackOptions

    Functions

    default

    Settings

    Member Visibility
    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 63ddbe24c6..99e51ecf4c 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

    default

    Settings

    Member Visibility
    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 5ecb154c95..34c8840b20 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

    default

    Settings

    Member Visibility
    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 45c57c7ec8..700552539a 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

    default

    Settings

    Member Visibility
    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 e40c83d53d..46e7a3f477 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

    default

    Settings

    Member Visibility
    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 13bec1dc5d..3135e18b48 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

    default

    Settings

    Member Visibility
    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 58c5f691cf..2a2a17936d 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

    default

    Settings

    Member Visibility
    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 291767d86d..1d13193856 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

    default

    Settings

    Member Visibility
    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 eb1d32ca3f..f0b1a248ce 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

    default

    Functions

    blockWebSocketsToPapiNetwork

    Settings

    Member Visibility
    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 8ecffc38dd..720a79e65d 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

    default

    Settings

    Member Visibility
    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 472304558f..30c124a614 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

    availableScrollGroupIds

    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 598c8dd52c..8581fd7c7f 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

    Uri

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_data_platform_data_.html b/papi-dts/modules/_shared_data_platform_data_.html index b2be42b62e..0d2a418a6c 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

    Namespace"shared/data/platform.data"

    Index

    Variables

    DEV_MODE_RENDERER_INDICATOR PLATFORM_NAMESPACE

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_data_rpc_model_.html b/papi-dts/modules/_shared_data_rpc_model_.html index 7bb4f8389e..3f6e18a256 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

    ConnectionStatus

    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 e8f54de741..3ca2e2d725 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

    ProcessType

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_log_error_model_.html b/papi-dts/modules/_shared_log_error_model_.html index c1eaabadf0..5bc68208f1 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

    default

    Settings

    Member Visibility
    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 24f672ecd0..fc2adc33e2 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

    BaseProjectDataProviderEngine

    Type Aliases

    IBaseProjectDataProviderEngine

    Settings

    Member Visibility
    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 ea32d941ae..91cdbb3377 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 ba05a0fa99..fbc95cba5a 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

    DataProviderEngine

    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 36c066ad4a..4d4cedbe54 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

    default IDisposableDataProvider

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_data_provider_model_.html b/papi-dts/modules/_shared_models_data_provider_model_.html index cc4e8a356a..e1e165ea79 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 fb3f7e6b47..5448bd355e 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

    Namespace"shared/models/dialog-options.model"

    Index

    Type Aliases

    DialogData DialogOptions

    Variables

    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_docking_framework_model_.html b/papi-dts/modules/_shared_models_docking_framework_model_.html index 47a6302a4b..f453e0bb37 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

    FloatLayout PanelLayout TabLayout

    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 aa3ec89e8a..98070b64b9 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

    ElevatedPrivilegeNames

    Type Aliases

    ElevatedPrivileges

    Settings

    Member Visibility
    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 ed6bc56dc0..eff55fc82b 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

    ExtensionBasicData

    Settings

    Member Visibility
    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 96fd36427b..29e8c733ee 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

    default

    Settings

    Member Visibility
    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 9c3aa48f79..97db86b081 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 8fc9599b9b..867f088911 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 be8520ca6c..6fc9531585 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

    Namespace"shared/models/network-object-status.service-model"

    Index

    Interfaces

    NetworkObjectStatusRemoteServiceType NetworkObjectStatusServiceType

    Variables

    networkObjectStatusServiceNetworkObjectName

    Settings

    Member Visibility
    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 9dbd86529b..832ad07cc8 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

    default

    Settings

    Member Visibility
    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 03e095aee0..6d480d5518 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

    Namespace"shared/models/project-data-provider-engine-factory.model"

    Index

    Classes

    LayeringProjectDataProviderEngineFactory

    Interfaces

    IProjectDataProviderEngineFactory

    Settings

    Member Visibility
    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 8d6d4fc204..784bf585bc 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

    ProjectDataProviderEngine

    Type Aliases

    IProjectDataProviderEngine

    Settings

    Member Visibility
    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 c9b4d8d101..166645e45e 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

    default

    Type Aliases

    ProjectMetadataFilterOptions

    Variables

    PDP_FACTORY_OBJECT_TYPE

    Settings

    Member Visibility
    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 1b2da453e8..9895c0e3a7 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

    ExtensionDataScope MandatoryProjectDataTypes WithProjectDataProviderEngineExtensionDataMethods

    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 284ebcc379..2412a9a757 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

    ProjectLookupServiceType

    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 d3e765e2d2..af6b48925e 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

    Namespace"shared/models/project-metadata.model"

    Index

    Type Aliases

    ProjectDataProviderFactoryMetadataInfo ProjectMetadata ProjectMetadataWithoutFactoryInfo

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_rpc_interface_.html b/papi-dts/modules/_shared_models_rpc_interface_.html index b18c78b661..f1b7b37ba9 100644 --- a/papi-dts/modules/_shared_models_rpc_interface_.html +++ b/papi-dts/modules/_shared_models_rpc_interface_.html @@ -1,3 +1,3 @@ -"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

    IRpcHandler IRpcMethodRegistrar

    Settings

    Member Visibility
    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 7ad90f9934..aab9de13bd 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

    WebViewFactory

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_models_web_view_model_.html b/papi-dts/modules/_shared_models_web_view_model_.html index a02c8d7481..67e6465367 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

    WebViewContentType

    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 5ffc2919ea..b21d6a8ae5 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

    Namespace"shared/models/web-view-provider.model"

    Index

    Interfaces

    IDisposableWebViewProvider IRegisteredWebViewProvider IWebViewProvider

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_command_service_.html b/papi-dts/modules/_shared_services_command_service_.html index a98a0ed99b..6fc08c642e 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

    moduleSummaryComments

    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 726ef96ec2..7222a2ecb6 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

    DataProviderService

    Variables

    default

    Functions

    getByType registerEngineByType diff --git a/papi-dts/modules/_shared_services_dialog_service_.html b/papi-dts/modules/_shared_services_dialog_service_.html index bcabb699a6..7c22749aec 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_dialog_service_model_.html b/papi-dts/modules/_shared_services_dialog_service_model_.html index 32dae28fec..cfdb5cb39b 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

    DialogService

    Variables

    CATEGORY_DIALOG

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_internet_service_.html b/papi-dts/modules/_shared_services_internet_service_.html index 0b09557833..111612406b 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

    InternetService

    Variables

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_localization_service_.html b/papi-dts/modules/_shared_services_localization_service_.html index 063065019f..c536565d2e 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_localization_service_model_.html b/papi-dts/modules/_shared_services_localization_service_model_.html index cd9353b63d..18ca615d5f 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 e684aec13e..cd7f90c5ee 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

    default WARN_TAG

    Functions

    formatLog

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_menu_data_service_.html b/papi-dts/modules/_shared_services_menu_data_service_.html index c44b5da88f..d7df09a763 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

    default

    Settings

    Member Visibility
    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 9271e45327..2032acecdf 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

    IMenuDataService MenuDataDataTypes

    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 8f0c269739..3ff1b148eb 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

    MinimalNetworkObjectService NetworkObjectService

    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 71a34538f7..3ac1a6b433 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_network_service_.html b/papi-dts/modules/_shared_services_network_service_.html index 512f9cddcc..8f7931e26b 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

    PapiNetworkService

    Variables

    papiNetworkService

    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 eb2d7c96b4..7372d948b0 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

    PapiBackendProjectDataProviderService PapiFrontendProjectDataProviderService

    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 163292ea63..2c063df10c 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_project_settings_service_.html b/papi-dts/modules/_shared_services_project_settings_service_.html index 194a31fc2b..c973c4ca3c 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

    Namespace"shared/services/project-settings.service"

    Index

    Variables

    default

    Functions

    filterProjectSettingsContributionsByProjectInterfaces

    Settings

    Member Visibility
    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 53e5d98bb9..3eaa0a0cd8 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

    IProjectSettingsService

    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 1df8da40ba..41d2ec78dd 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

    createRpcHandler

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_scroll_group_service_.html b/papi-dts/modules/_shared_services_scroll_group_service_.html index a4d708b9ba..c7208963c7 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

    default

    Settings

    Member Visibility
    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 9ddf3301d6..3e36f57b62 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

    IScrollGroupRemoteService IScrollGroupService

    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 15cfc30d63..71687b7fbd 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

    default

    Settings

    Member Visibility
    diff --git a/papi-dts/modules/_shared_services_settings_service_model_.html b/papi-dts/modules/_shared_services_settings_service_model_.html index cb86efaedc..fd67074780 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 ae0b28d611..e543fcc4c8 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

    PapiWebViewProviderService WebViewProviderService

    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 7b40255ee4..c760764592 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

    default

    Settings

    Member Visibility
    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 193a7d4aa4..1e116d23b8 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

    WebViewServiceType

    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 d8873a9d6d..836fd54e9f 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 d265855a3c..5bcbecd2aa 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

    default

    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 3b4cff979c..2f7d9b7054 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

    default

    Type Aliases

    AllSettingsInfo LocalizedSettingsContributionInfo SettingInfo diff --git a/papi-dts/modules/_shared_utils_util_.html b/papi-dts/modules/_shared_utils_util_.html index 2289995cd8..5f46518739 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

    RequestType SerializedRequestType

    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 d91b8b7f83..4273b6bb47 100644 --- a/papi-dts/types/__papi_frontend_.Papi.html +++ b/papi-dts/types/__papi_frontend_.Papi.html @@ -1 +1 @@ -Papi | papi-dts

    Type AliasPapi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility
    +Papi | papi-dts

    Type AliasPapi

    Papi: typeof "@papi/frontend".default

    Settings

    Member Visibility
    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 06b1ccdf99..4d58d4301e 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 832ebe0f77..0d05e302bb 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1b76b3f20d..cd84786d09 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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html b/papi-dts/types/_main_services_rpc_server_.PropagateEventMethod.html index 6cfdbb57a5..acac243fdd 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

    Type AliasPropagateEventMethod

    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)

    Settings

    Member Visibility
    +PropagateEventMethod | papi-dts

    Type AliasPropagateEventMethod

    PropagateEventMethod: (<T>(source: "main/services/rpc-server".default, eventType: string, event: T) => void)

    Settings

    Member Visibility
    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 8d9461bcde..6e80d3cd5a 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

    Type AliasExecutionTokenType

    ExecutionTokenType

    For now this is just for extensions, but maybe we will want to expand this in the future

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c0a53ae20e..6d7c55d79a 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

    Type AliasDirectoryEntries

    DirectoryEntries: Readonly<{
        [entryType in EntryType]: Uri[]
    }>

    All entries in a directory, mapped from entry type to array of uris for the entries

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.CommandNames.html b/papi-dts/types/_papi_shared_types_.CommandNames.html index f220e8a7fa..a06eb74b11 100644 --- a/papi-dts/types/_papi_shared_types_.CommandNames.html +++ b/papi-dts/types/_papi_shared_types_.CommandNames.html @@ -3,4 +3,4 @@

    Example

    'platform.quit';
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderNames.html b/papi-dts/types/_papi_shared_types_.DataProviderNames.html index c59590870d..038d019d16 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderNames.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderNames.html @@ -3,4 +3,4 @@

    Example

    'platform.placeholder'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html index 4ec7880295..6e3dab2229 100644 --- a/papi-dts/types/_papi_shared_types_.DataProviderTypes.html +++ b/papi-dts/types/_papi_shared_types_.DataProviderTypes.html @@ -4,4 +4,4 @@

    Example

    DataProviderTypes['helloSomeone.people'] => {
        Greeting: DataProviderDataType<string, string | undefined, string>;
        Age: DataProviderDataType<string, number | undefined, number>;
        People: DataProviderDataType<undefined, PeopleData, never>;
      }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html b/papi-dts/types/_papi_shared_types_.DisposableDataProviders.html index 7ec9a62898..6efad98a5c 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IBaseProjectDataProvider.html index c9023b0a58..f74bde823d 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html b/papi-dts/types/_papi_shared_types_.IProjectDataProvider.html index bd2d82f43d..bcfc0e43e0 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html b/papi-dts/types/_papi_shared_types_.NotesOnlyProjectDataTypes.html index 7362d742cc..75748ba39f 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html index 8ad47de4e2..7bfc1e8b1a 100644 --- a/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.PlaceholderDataTypes.html @@ -1 +1 @@ -PlaceholderDataTypes | papi-dts

    Type AliasPlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Settings

    Member Visibility
    +PlaceholderDataTypes | papi-dts

    Type AliasPlaceholderDataTypes

    PlaceholderDataTypes: {
        Placeholder: DataProviderDataType<{
            thing: number;
        }, string[], number>;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html index fec8199efd..7f0411ee30 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaceDataTypes.html @@ -8,4 +8,4 @@

    Example

    ProjectInterfaceDataTypes['MyExtensionProjectInterfaceName'] => MandatoryProjectDataTypes & {
        MyProjectData: DataProviderDataType<string, string, string>;
      }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html index f3a23e6d3f..bd95510a7a 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html +++ b/papi-dts/types/_papi_shared_types_.ProjectInterfaces.html @@ -7,4 +7,4 @@

    Example

    'platform.notesOnly'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html index 96a8d76da3..ee1a32dbc6 100644 --- a/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html +++ b/papi-dts/types/_papi_shared_types_.ProjectSettingNames.html @@ -4,4 +4,4 @@

    Example

    'platform.fullName'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.SettingNames.html b/papi-dts/types/_papi_shared_types_.SettingNames.html index 22b14f53ea..890028b49e 100644 --- a/papi-dts/types/_papi_shared_types_.SettingNames.html +++ b/papi-dts/types/_papi_shared_types_.SettingNames.html @@ -3,4 +3,4 @@

    Example

    'platform.verseRef'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html index 01beb88750..c5bca3c0e2 100644 --- a/papi-dts/types/_papi_shared_types_.StuffDataTypes.html +++ b/papi-dts/types/_papi_shared_types_.StuffDataTypes.html @@ -1 +1 @@ -StuffDataTypes | papi-dts

    Type AliasStuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Settings

    Member Visibility
    +StuffDataTypes | papi-dts

    Type AliasStuffDataTypes

    StuffDataTypes: {
        Stuff: DataProviderDataType<string, number, never>;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html index 7bbc59a7a1..939b8afbf1 100644 --- a/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html +++ b/papi-dts/types/_papi_shared_types_.WebViewControllerTypes.html @@ -4,4 +4,4 @@

    Example

    'platform.placeholderWebView'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html b/papi-dts/types/_papi_shared_types_.WithProjectDataProviderEngineSettingMethods.html index 7bfc99012c..76b1e03505 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).

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 94ff815089..6572502006 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3f6517ad68..41e6db3526 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

    Type AliasDialogProps<TData>

    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
      • cancelDialog(): void

      • Cancels the dialog request (resolves the response with undefined) and closes the dialog

        -

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • Rejects the dialog request with the specified message and closes the dialog

        +

        Returns void

    • rejectDialog:function
      • rejectDialog(errorMessage): void

      • 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
      • submitDialog(data): void

      • Sends the data as a resolved response to the dialog request and closes the dialog

        +

    Returns void

  • submitDialog:function
    • submitDialog(data): void

    • 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

    • Settings

    Member Visibility
    +

    Returns void

    Settings

    Member Visibility
    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 27536f42a9..9dfbba26d7 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 04bfe51dee..73968d2430 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

    Type AliasDialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility
    +DialogDefinition | papi-dts

    Type AliasDialogDefinition<DialogTabType>

    DialogDefinition<DialogTabType>: Readonly<DialogDefinitionBase & {
        Component: ((props: DialogProps<DialogTypes[DialogTabType]["responseType"]> & DialogTypes[DialogTabType]["options"]) => ReactElement);
        tabType: DialogTabType;
    }>

    Type Parameters

    Settings

    Member Visibility
    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 d6dbefb790..d2534d96f1 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

    Type AliasDialogTabTypes

    DialogTabTypes: keyof DialogTypes

    Each type of dialog. These are the tab types used in the dock layout

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 68e8707fbb..03ab52b854 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

    Type AliasProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility
    +ProjectDialogOptionsBase | papi-dts

    Type AliasProjectDialogOptionsBase

    ProjectDialogOptionsBase: DialogOptions & ProjectMetadataFilterOptions

    Settings

    Member Visibility
    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 7863fcc311..ed93beae30 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

    Type AliasSelectBooksDialogOptions

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 79a32e1bcc..98c0b4d6e3 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

    Type AliasSelectMultipleProjectsDialogOptions

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3ac4fc5823..25fa20e0ca 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

    Type AliasSelectProjectDialogOptions

    SelectProjectDialogOptions: ProjectDialogOptionsBase

    Options to provide when showing the Select Project dialog

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b63fd377d6..b5475e3861 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

    Type AliasUseDialogCallbackOptions

    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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 87c684d900..7ca43000df 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.EventHandler.html b/papi-dts/types/_shared_data_rpc_model_.EventHandler.html index fbc003df90..8b318044b3 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

    Type AliasEventHandler

    EventHandler: (<T>(eventType: string, event: T) => void)

    Function that processes an event received locally or over the network

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html b/papi-dts/types/_shared_data_rpc_model_.InternalRequestHandler.html index ef7dbdaf8a..1cec6b6032 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

    Type AliasInternalRequestHandler

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestId.html b/papi-dts/types/_shared_data_rpc_model_.RequestId.html index b569885927..cf960b4016 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

    Type AliasRequestId

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_data_rpc_model_.RequestParams.html b/papi-dts/types/_shared_data_rpc_model_.RequestParams.html index 28bfd640c5..6c75a7dcc3 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

    Type AliasRequestParams

    RequestParams: any[]

    Parameters provided to an RPC request message

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 4c4506db92..6cad1e43a5 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 1c5d8cd55c..77ad81137d 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

    Type AliasCreateProcess

    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }

    Settings

    Member Visibility
    +CreateProcess | papi-dts

    Type AliasCreateProcess

    CreateProcess: {
        fork: PlatformFork;
        osData: OperatingSystemData;
        spawn: PlatformSpawn;
    }

    Settings

    Member Visibility
    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 98a534cd97..8062eddfc9 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8e3da3901b..08838d6804 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'); -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 39762849f1..18b1b3a00f 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 @@ } -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7f1e349bc6..3afb311de4 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 8a9e25d191..48aee96f9f 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.
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e9ab5e67f3..34f16a5ad0 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 43f11d7fa1..00657aa402 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

    See

    IDataProvider

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1f3801319e..3611efd937 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 3afd2b1baa..e417c78c0f 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3f42ffd340..1b05238b8d 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>;
    }
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 faeb9dcb9b..b09d6b1658 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

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 22b5c8faf5..8ac22ba41c 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

    See

    DataProviderGetter for more information

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 fead2ff94a..bb9b8ce024 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).

    See

    DataProviderUpdateInstructions for more info on what to return

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0daf839d00..29a1b47f4c 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

    See

    DataProviderSetter for more information

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1f65e8b132..30a513a390 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9738de082e..50e29012ad 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 @@

    Default

    'deeply-equal'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c465f3b810..1a5a426940 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

    See

    DataProviderSubscriber for more information

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 fbe8c0ebf4..7d2614e8ba 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 485f8f3348..683b9d2e64 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

    Type AliasDataTypeNames<TDataTypes>

    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

    See

    DataProviderDataTypes for more information

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7908227a62..56341066f4 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

    See

    IDataProvider

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b192c7d429..8c4105ac2c 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

    Type AliasDialogData

    DialogData: DialogOptions & {
        isDialog: true;
    }

    Data in each tab that is a dialog. Added to DialogOptions in dialog.service-host.ts

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f5d9985624..b33d84ddd9 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9488a38a2f..4c0d6304f7 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 da61c50367..38aed1aa02 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

    Type AliasFloatSize

    FloatSize: {
        height: number;
        width: number;
    }

    The dimensions for a floating tab in CSS px units

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 62e862dcd8..697a9a0ffb 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

    Type AliasLayout

    Layout: TabLayout | FloatLayout | PanelLayout

    Information about how a Paranext tab fits into the dock layout

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 00fa5b3302..d759726cff 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 08d07a67b4..da98ac7b1d 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

    Type AliasPanelDirection

    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"

    Settings

    Member Visibility
    +PanelDirection | papi-dts

    Type AliasPanelDirection

    PanelDirection:
        | "left"
        | "right"
        | "bottom"
        | "top"
        | "before-tab"
        | "after-tab"
        | "maximize"
        | "move"
        | "active"
        | "update"

    Settings

    Member Visibility
    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 6800af9ea8..190e3639a1 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 fb50ca974a..a9bf39f519 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 07c07fa530..28f13db6a7 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 807e0225cb..8e5e40ad6e 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

    Type AliasTabLoader

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 74bf61e0ef..f94e5cd40a 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

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 bdc83de321..a443bd7b30 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

    Type AliasWebViewTabProps

    WebViewTabProps: WebViewDefinition

    Props that are passed to the web view tab component

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b09fdfed02..7c57f96241 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

    Type AliasElevatedPrivileges

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 a026ec54a0..dc966ac4b9 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

    Type AliasExtensionBasicData

    ExtensionBasicData: {
        name: string;
    }

    Represents an object that contains the most basic information about an extension

    Type declaration

    • name: string

      Name of an extension

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 d288150d84..dc84819c9f 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

    Settings

    Member Visibility
    +

    Type Parameters

    • TDataProvider

    Settings

    Member Visibility
    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 3bc61e5623..44ad238c7c 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

    Type AliasDisableExtensionFunction

    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

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 89bc7cea14..8ab8414a0f 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

    Type AliasEnableExtensionFunction

    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

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 edbe1cf5d5..642449cea8 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

    Type AliasExtensionIdentifier

    ExtensionIdentifier: {
        extensionName: string;
        extensionVersion: string;
    }

    Represents an extension that can be enabled or disabled

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8f911c7487..c112e67c5b 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

    Type AliasGetInstalledExtensionsFunction

    GetInstalledExtensionsFunction: (() => Promise<InstalledExtensions>)

    Get extension identifiers of all extensions on the system

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9ace7ac899..e2609cf144 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

    Type AliasHashValues

    HashValues: Partial<{
        sha256: string;
        sha512: string;
    }>

    Base64 encoded hash values

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ae33b0d24e..cc1a9c6805 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 cf4b855329..6559d62207 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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9b4a715da6..4306e16d0d 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 da74fcc9a8..f528540972 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

    Type AliasDisposableNetworkObject<T>

    DisposableNetworkObject<T>: NetworkObject<T> & Dispose

    An object of this type is returned from networkObjectService.set.

    Type Parameters

    See

    networkObjectService

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ef002dd1c7..a939e87dfd 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

    See

    networkObjectService

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3c8189c629..42d77b3c34 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

    See

    networkObjectService

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7f99c2fc3b..73096fba47 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e669a7acf8..52b1e3b508 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

    Type AliasNetworkableObject<T>

    NetworkableObject<T>: T & CannotHaveOnDidDispose

    An object of this type is passed into networkObjectService.set.

    Type Parameters

    • T = object

    See

    networkObjectService

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b143e1c0ad..71d7481c1b 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 cd77e9ac7f..b5feca5254 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

    Type AliasProjectMetadataFilterOptions

    ProjectMetadataFilterOptions: ModifierProject & {
        excludeProjectIds?: string | string[];
        includeProjectIds?: string | string[];
    }

    Type declaration

    • OptionalexcludeProjectIds?: string | string[]

      Project IDs to exclude

    • OptionalincludeProjectIds?: string | string[]

      Project IDs to include

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1d16031c2c..aaf4c63282 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8423c2d7f1..a88362c22e 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. -

    Settings

    Member Visibility

    On This Page

    SettingExtensionData
    +

    Settings

    Member Visibility

    On This Page

    SettingExtensionData
    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 1759f0d54f..2eab3f0098 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

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 06bf320ef7..7c1cb7ae2e 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

    • Settings

    Member Visibility
    +
  • mergeMetadataFilters:function

    • Settings

    Member Visibility
    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 9008cd0873..c9cfa4af08 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

    Type AliasProjectDataProviderFactoryMetadataInfo

    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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 de14f980eb..0842904384 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)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 bac297d5b1..8973473a34 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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 97d33abe1f..dfee6ae456 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

    Type AliasGetSavedWebViewDefinition

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 83c713401b..351a2091b6 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7dc83fbbd9..32ca5cf8d8 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

    Type AliasSavedWebViewDefinition

    SavedWebViewDefinition: (Partial<Omit<WebViewDefinitionReact, SavedWebViewDefinitionOmittedKeys>> | Partial<Omit<WebViewDefinitionHtml, SavedWebViewDefinitionOmittedKeys>> | Partial<Omit<WebViewDefinitionURL, SavedWebViewDefinitionOmittedKeys>>) & Pick<WebViewDefinitionBase, "id" | "webViewType">

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 22940dbbe3..9118b05d70 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

    Type AliasSavedWebViewDefinitionOmittedKeys

    SavedWebViewDefinitionOmittedKeys: typeof SAVED_WEBVIEW_DEFINITION_OMITTED_KEYS[number]

    The keys of properties on a WebViewDefinition that are omitted when converting to a SavedWebViewDefinition

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 a6e6f852ca..2a062eb8ad 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}` });
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5927bb2d9b..d575338977 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();
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 6180f36827..c8a9cdc5aa 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');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b2a1542ebb..bcddc87c79 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

    Type AliasWebViewDefinition

    WebViewDefinition: WebViewDefinitionReact | WebViewDefinitionHtml | WebViewDefinitionURL

    Properties defining a type of WebView created by extensions to show web content

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f61adc21a4..27da95af3b 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 2d85cf2c8f..b54e96ed3a 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

    Type AliasWebViewDefinitionHtml

    WebViewDefinitionHtml: WebViewDefinitionBase & {
        contentType: HTML;
    }

    WebView representation using HTML

    Type declaration

    • contentType: HTML

      Indicates this WebView uses HTML

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 a4ba89650b..eb386ea387 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

    Type AliasWebViewDefinitionReact

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 bca8a09303..4e747e1b72 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

    Type AliasWebViewDefinitionURL

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 57f676404e..39be7ffd2e 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

    Type AliasWebViewDefinitionUpdatableProperties

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 b9144a6d96..cb08524411 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

    Type AliasWebViewDefinitionUpdateInfo

    WebViewDefinitionUpdateInfo: Partial<WebViewDefinitionUpdatableProperties>

    WebViewDefinition properties for updating a WebView that is already displayed. Any unspecified properties will stay the same

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 c1607441d9..03799e0410 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

    Type AliasWebViewId

    WebViewId: string

    ID for a specific WebView. Each WebView has a unique ID

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 cd9354f543..8a71a4eb2c 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');
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9104b2e281..515f4b648b 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

    Type AliasWebViewType

    WebViewType: string

    What type a WebView is. Each WebView definition must have a unique type.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html b/papi-dts/types/_shared_services_command_service_.moduleSummaryComments.html index 2b6ba12256..847bce9cad 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

    Type AliasmoduleSummaryComments

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5f27962abc..c8718438ec 100644 --- a/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html +++ b/papi-dts/types/_shared_services_localization_service_model_.ILocalizationService.html @@ -9,8 +9,8 @@

    Returns Promise<LocalizationData>

    Object whose keys are localizeKeys and values are localized strings

  • setLocalizedString:function
  • setLocalizedStrings:function
  • setLocalizedStrings:function

    • Type declaration

    Type declaration

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<string>

    Settings

    Member Visibility
    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 b0b32ad1ec..0af4933d15 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

    Type AliasLocalizationData

    LocalizationData: LanguageStrings

    Settings

    Member Visibility
    +LocalizationData | papi-dts

    Type AliasLocalizationData

    LocalizationData: LanguageStrings

    Settings

    Member Visibility
    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 9745954144..1047869041 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

    Type AliasLocalizationDataDataTypes

    LocalizationDataDataTypes: {
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }

    Settings

    Member Visibility
    +LocalizationDataDataTypes | papi-dts

    Type AliasLocalizationDataDataTypes

    LocalizationDataDataTypes: {
        LocalizedString: DataProviderDataType<LocalizationSelector, string, never>;
        LocalizedStrings: DataProviderDataType<LocalizationSelectors, LocalizationData, never>;
    }

    Settings

    Member Visibility
    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 6b155a0a88..b39d54240a 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

    Type AliasLocalizationSelector

    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }

    Settings

    Member Visibility
    +LocalizationSelector | papi-dts

    Type AliasLocalizationSelector

    LocalizationSelector: {
        locales?: string[];
        localizeKey: LocalizeKey;
    }

    Settings

    Member Visibility
    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 be3ca1287d..4f2be93296 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

    Type AliasLocalizationSelectors

    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }

    Settings

    Member Visibility
    +LocalizationSelectors | papi-dts

    Type AliasLocalizationSelectors

    LocalizationSelectors: {
        locales?: string[];
        localizeKeys: LocalizeKey[];
    }

    Settings

    Member Visibility
    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 078acd9966..4808cf4d30 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 ce1ce9547f..b4c8b789ac 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

    Type AliasMenuDataDataTypes

    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }

    Settings

    Member Visibility
    +MenuDataDataTypes | papi-dts

    Type AliasMenuDataDataTypes

    MenuDataDataTypes: {
        MainMenu: DataProviderDataType<undefined, Localized<MultiColumnMenu>, never>;
        WebViewMenu: DataProviderDataType<ReferencedItem, Localized<WebViewMenu>, never>;
    }

    Settings

    Member Visibility
    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 16137a49c7..f57d86adb8 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

    Type AliasAllProjectSettingsValidators

    AllProjectSettingsValidators: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingValidator<ProjectSettingName>
    }

    Validators for all project settings. Keys are setting keys, values are functions to validate new settings

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e1bbe7144c..5e0fd8f5d8 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

    Settings

    Member Visibility
    +

    Returns Promise<boolean>

    Settings

    Member Visibility
    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 183bc1b038..3735dc1d7d 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

    Type AliasSimultaneousProjectSettingsChanges

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 648bc8ba6f..0a9a8dd045 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f2a6947418..3f0e8ce798 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

    Type AliasScrollGroupUpdateInfo

    ScrollGroupUpdateInfo: {
        scrollGroupId: ScrollGroupId;
        scrRef: ScriptureReference;
    }

    Information about an update to a scroll group. Informs about the new ScriptureReference at a ScrollGroupId

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 474ad6a1a6..22369ad8ab 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

    Type AliasAllSettingsData

    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }

    Settings

    Member Visibility
    +AllSettingsData | papi-dts

    Type AliasAllSettingsData

    AllSettingsData: {
        [SettingName in SettingNames]: SettingTypes[SettingName]
    }

    Settings

    Member Visibility
    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 0b8615b332..8a4e79facd 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

    Type AliasAllSettingsValidators

    AllSettingsValidators: {
        [SettingName in SettingNames]: SettingValidator<SettingName>
    }

    Validators for all settings. Keys are setting keys, values are functions to validate new settings

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 75fbc27035..b5d2138624 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

    Throws

    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

    • Settings

    Member Visibility
    +
  • OptionalallChanges: Partial<SettingTypes>

    • Returns Promise<boolean>

    Settings

    Member Visibility
    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 1d8c4e4d1b..2bb32c711a 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]>;
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8fd9e2e122..71c3eb0788 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

    Type AliasSettingValidator<SettingName>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 16ad5745f9..0870b41803 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

    Type AliasCloseWebViewEvent

    CloseWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are closed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1ae3fec748..35489d8fdb 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

    Type AliasOpenWebViewEvent

    OpenWebViewEvent: {
        layout: Layout;
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are created

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f8c8385d27..01d2120011 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

    Type AliasUpdateWebViewEvent

    UpdateWebViewEvent: {
        webView: SavedWebViewDefinition;
    }

    Event emitted when webViews are updated

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1b67738e6f..7bd99908e4 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

    Type AliasWebViewMessageRequestHandler

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 60590a5d06..b48649569a 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

    Type AliasAllProjectSettingsInfo

    AllProjectSettingsInfo: {
        [ProjectSettingName in ProjectSettingNames]: ProjectSettingInfo<ProjectSettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 f87f6b8b12..20416045dd 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

    Type AliasLocalizedProjectSettingsContributionInfo

    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>

    Settings

    Member Visibility
    +LocalizedProjectSettingsContributionInfo | papi-dts

    Type AliasLocalizedProjectSettingsContributionInfo

    LocalizedProjectSettingsContributionInfo: Localized<ProjectSettingsContributionInfo>

    Settings

    Member Visibility
    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 0c35b2dcee..b47550fbf8 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

    Type AliasProjectSettingInfo<ProjectSettingName>

    ProjectSettingInfo<ProjectSettingName>: ProjectSetting & {
        default: ProjectSettingTypes[ProjectSettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 7c9697eeb9..0b3dcf561d 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

    Type AliasProjectSettingsContributionInfo

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 2e91e462ca..85dc8f9a7e 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

    Type AliasAllSettingsInfo

    AllSettingsInfo: {
        [SettingName in SettingNames]: SettingInfo<SettingName>
    }

    Information about all settings. Keys are setting keys, values are information for that setting

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 29dd62dae8..a419a3b93e 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

    Type AliasLocalizedSettingsContributionInfo

    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>

    Settings

    Member Visibility
    +LocalizedSettingsContributionInfo | papi-dts

    Type AliasLocalizedSettingsContributionInfo

    LocalizedSettingsContributionInfo: Localized<SettingsContributionInfo>

    Settings

    Member Visibility
    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 554b1bea32..305af8cc94 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

    Type AliasSettingInfo<SettingName>

    SettingInfo<SettingName>: Setting & {
        default: SettingTypes[SettingName];
    }

    Information about one specific setting. Basically just Setting but with specific default type info

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    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 7da83ea12e..e6e44af48a 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

    Type AliasSettingsContributionInfo

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_util_.RequestType.html b/papi-dts/types/_shared_utils_util_.RequestType.html index 52d1620fff..3d290acb97 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

    Type AliasRequestType

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/types/_shared_utils_util_.SerializedRequestType.html b/papi-dts/types/_shared_utils_util_.SerializedRequestType.html index 717029f76e..4c55e56379 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html index e3d4215c44..5915433da0 100644 --- a/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.BaseProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    See

    IBaseProjectDataProviderEngine for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.DataProviderEngine.html b/papi-dts/variables/__papi_backend_.DataProviderEngine.html index fd4c6267b7..944d442f70 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.

    See

    IDataProviderEngine for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html b/papi-dts/variables/__papi_backend_.LayeringProjectDataProviderEngineFactory.html index 5f1f74fa6b..0be33c8469 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html index 66f27d0895..f8c481aed2 100644 --- a/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html +++ b/papi-dts/variables/__papi_backend_.ProjectDataProviderEngine.html @@ -7,4 +7,4 @@

    See

    IProjectDataProviderEngine for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.WebViewFactory.html b/papi-dts/variables/__papi_backend_.WebViewFactory.html index 0b6b995c6b..19943a8645 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.

    See

    IWebViewProvider for more information on extending this class.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.commands.html b/papi-dts/variables/__papi_backend_.commands.html index c94c2eb0eb..c02d03109e 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

    commands: typeof "shared/services/command.service"

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.dataProviders.html b/papi-dts/variables/__papi_backend_.dataProviders.html index 19fe7cf4e1..33ce1e8be2 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.default.html b/papi-dts/variables/__papi_backend_.default.html index 7ad8c195db..db14a76880 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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.dialogs.html b/papi-dts/variables/__papi_backend_.dialogs.html index 93d2107833..4d3c248a8c 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.internet.html b/papi-dts/variables/__papi_backend_.internet.html index 47e4d3f25f..f3578a13ab 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.localization.html b/papi-dts/variables/__papi_backend_.localization.html index 41a908af4c..449778abe5 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.logger.html b/papi-dts/variables/__papi_backend_.logger.html index 664efa0d90..992935d6c5 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.menuData.html b/papi-dts/variables/__papi_backend_.menuData.html index ab61926d0b..a03c531bf0 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

    menuData: IMenuDataService

    Service that allows to get and store menu data

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.network.html b/papi-dts/variables/__papi_backend_.network.html index dabdb0234c..bdef1e6355 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

    network: PapiNetworkService

    Service that provides a way to send and receive network events

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.networkObjectStatus.html b/papi-dts/variables/__papi_backend_.networkObjectStatus.html index d8d7a5012a..0f580815b2 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.networkObjects.html b/papi-dts/variables/__papi_backend_.networkObjects.html index ec8fb6e102..ab37d504ab 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.projectDataProviders.html b/papi-dts/variables/__papi_backend_.projectDataProviders.html index d498c4c62f..a338f21610 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

    projectDataProviders: PapiBackendProjectDataProviderService

    Service that registers and gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.projectLookup.html b/papi-dts/variables/__papi_backend_.projectLookup.html index 7e4504286b..7bb79c1a09 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.projectSettings.html b/papi-dts/variables/__papi_backend_.projectSettings.html index 3a150e1059..20a8c30c6a 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.scrollGroups.html b/papi-dts/variables/__papi_backend_.scrollGroups.html index 4bb3f23779..8fb692e28f 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.settings.html b/papi-dts/variables/__papi_backend_.settings.html index a86ad52048..6af3b233d9 100644 --- a/papi-dts/variables/__papi_backend_.settings.html +++ b/papi-dts/variables/__papi_backend_.settings.html @@ -1 +1 @@ -settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    +settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.storage.html b/papi-dts/variables/__papi_backend_.storage.html index 8704bb4851..e80e91bdc6 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

    storage: ExtensionStorageService

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.webViewProviders.html b/papi-dts/variables/__papi_backend_.webViewProviders.html index f6c0adaa3b..3a9526fe15 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_backend_.webViews.html b/papi-dts/variables/__papi_backend_.webViews.html index 6aff36bc32..904a69bd58 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

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_core_.default.html b/papi-dts/variables/__papi_core_.default.html index da40dd9d00..647e174813 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.WebSocket.html b/papi-dts/variables/__papi_frontend_.WebSocket.html index 8c05b0fa39..40e5578dc1 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html b/papi-dts/variables/__papi_frontend_.XMLHttpRequest.html index 6adfc87f27..4301b69169 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.commands.html b/papi-dts/variables/__papi_frontend_.commands.html index 5477212f68..47554743ae 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

    commands: typeof "shared/services/command.service"

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.dataProviders.html b/papi-dts/variables/__papi_frontend_.dataProviders.html index f676069044..ce9deb1de0 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.default.html b/papi-dts/variables/__papi_frontend_.default.html index bf819a5dac..6516cf2b82 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.dialogs.html b/papi-dts/variables/__papi_frontend_.dialogs.html index 8a5f7c1e43..051d7a9105 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.internet.html b/papi-dts/variables/__papi_frontend_.internet.html index 517213c580..6900b1264c 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.localization.html b/papi-dts/variables/__papi_frontend_.localization.html index 25af462b45..7f364dacfa 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.logger.html b/papi-dts/variables/__papi_frontend_.logger.html index 6d51d7760c..e16d2d421e 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.menuData.html b/papi-dts/variables/__papi_frontend_.menuData.html index 4e5b04ed9a..2ed25869ff 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

    menuData: IMenuDataService

    Service that allows to get and store menu data

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.network.html b/papi-dts/variables/__papi_frontend_.network.html index ea48e41689..fb26f6c073 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

    network: PapiNetworkService

    Service that provides a way to send and receive network events

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.projectDataProviders.html b/papi-dts/variables/__papi_frontend_.projectDataProviders.html index 81a92cf065..d9c8cac70a 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

    projectDataProviders: PapiFrontendProjectDataProviderService

    Service that registers and gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.projectLookup.html b/papi-dts/variables/__papi_frontend_.projectLookup.html index c373b8dc88..df6aedc8d7 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.react.html b/papi-dts/variables/__papi_frontend_.react.html index 96463b61de..3c02738605 100644 --- a/papi-dts/variables/__papi_frontend_.react.html +++ b/papi-dts/variables/__papi_frontend_.react.html @@ -1,2 +1,2 @@ react | papi-dts

    VariablereactConst

    react: typeof "@papi/frontend/react"

    React hooks that enable interacting with the papi in React components more easily.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.scrollGroups.html b/papi-dts/variables/__papi_frontend_.scrollGroups.html index 821b2bc8f2..fb55223204 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.settings.html b/papi-dts/variables/__papi_frontend_.settings.html index 2e6f9451f9..922c708b6f 100644 --- a/papi-dts/variables/__papi_frontend_.settings.html +++ b/papi-dts/variables/__papi_frontend_.settings.html @@ -1 +1 @@ -settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    +settings | papi-dts

    VariablesettingsConst

    settings: ISettingsService

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/__papi_frontend_.webViews.html b/papi-dts/variables/__papi_frontend_.webViews.html index e132810742..78d2962155 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

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 a4c41b690d..a00f687129 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

    VariabledefaultConst

    default: ExtensionStorageService

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5a1dfe48d1..15dc5268fa 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

    VariabledefaultConst

    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: {
        registerExtension: typeof registerExtension;
        tokenIsValid: typeof tokenIsValid;
        unregisterExtension: typeof unregisterExtension;
    }

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.FILE_PROTOCOL.html index 11db3e9f0c..e08540c3b4 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://'

    Settings

    Member Visibility
    +FILE_PROTOCOL | papi-dts

    VariableFILE_PROTOCOLConst

    FILE_PROTOCOL: "file://" = 'file://'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html b/papi-dts/variables/_node_utils_util_.RESOURCES_PROTOCOL.html index faa95be6a3..2a31df74e4 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://'

    Settings

    Member Visibility
    +RESOURCES_PROTOCOL | papi-dts

    VariableRESOURCES_PROTOCOLConst

    RESOURCES_PROTOCOL: "resources://" = 'resources://'

    Settings

    Member Visibility
    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 7baac2ef67..d5129c2bd3 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 }

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0e03005192..a63683dd34 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

    VariableSELECT_BOOKS_DIALOG_TYPEConst

    SELECT_BOOKS_DIALOG_TYPE: "platform.selectBooks" = 'platform.selectBooks'

    The tabType for the select books dialog in select-books.dialog.tsx

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 2bf873d2a9..55b4691700 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

    VariableSELECT_MULTIPLE_PROJECTS_DIALOG_TYPEConst

    SELECT_MULTIPLE_PROJECTS_DIALOG_TYPE: "platform.selectMultipleProjects" = 'platform.selectMultipleProjects'

    The tabType for the select multiple projects dialog in select-multiple-projects.dialog.tsx

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9a2dd9e5ef..a5bc089228 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

    VariableSELECT_PROJECT_DIALOG_TYPEConst

    SELECT_PROJECT_DIALOG_TYPE: "platform.selectProject" = 'platform.selectProject'

    The tabType for the select project dialog in select-project.dialog.tsx

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5f981228d2..33b2b9d7b2 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

    VariableavailableScrollGroupIdsConst

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0b9c6f1868..6b3219de69 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

    VariableDEV_MODE_RENDERER_INDICATORConst

    DEV_MODE_RENDERER_INDICATOR: "?noisyDevMode" = '?noisyDevMode'

    Query string passed to the renderer when starting if it should enable noisy dev mode

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 2dc4f2abe5..87e040260a 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

    VariablePLATFORM_NAMESPACEConst

    PLATFORM_NAMESPACE: "platform" = 'platform'

    Namespace to use for features like commands, settings, etc. on the PAPI that are provided by Platform.Bible core

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 57ab68d535..2d376c488c 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

    VariableCATEGORY_COMMANDConst

    CATEGORY_COMMAND: "command" = 'command'

    Prefix on requests that indicates that the request is a command

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 fbf9339801..ba467702c4 100644 --- a/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html +++ b/papi-dts/variables/_shared_data_rpc_model_.GET_METHODS.html @@ -1,2 +1,2 @@ GET_METHODS | papi-dts

    VariableGET_METHODSConst

    GET_METHODS: "network:getMethods" = 'network:getMethods'

    Get all methods that are currently registered on the network.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 36bb810b9b..52edc8bdbb 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

    VariableREGISTER_METHODConst

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 3c16e62e81..77d9e77222 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

    VariableUNREGISTER_METHODConst

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 df7bb94cb0..2baa45b3b5 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

    VariableWEBSOCKET_PORTConst

    WEBSOCKET_PORT = 8876

    Port to use for the WebSocket

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 30dbd93868..88b147da11 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

    VariableDIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYSConst

    DIALOG_OPTIONS_LOCALIZABLE_PROPERTY_KEYS: readonly ["title", "prompt"]

    Keys of properties on DialogOptions that should be localized if they are LocalizeKeys

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 9852b3476f..448ca85dd6 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

    VariablenetworkObjectStatusServiceNetworkObjectNameConst

    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

    Settings

    Member Visibility
    +networkObjectStatusServiceNetworkObjectName | papi-dts

    VariablenetworkObjectStatusServiceNetworkObjectNameConst

    networkObjectStatusServiceNetworkObjectName: "NetworkObjectStatusService" = 'NetworkObjectStatusService'

    Settings

    Member Visibility
    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 b2343d5dcf..da7a06cb1f 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

    VariablePDP_FACTORY_OBJECT_TYPEConst

    PDP_FACTORY_OBJECT_TYPE: string

    Settings

    Member Visibility
    +PDP_FACTORY_OBJECT_TYPE | papi-dts

    VariablePDP_FACTORY_OBJECT_TYPEConst

    PDP_FACTORY_OBJECT_TYPE: string

    Settings

    Member Visibility
    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 f815acef3c..35d2e497e6 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

    VariablePROJECT_INTERFACE_PLATFORM_BASEConst

    PROJECT_INTERFACE_PLATFORM_BASE: "platform.base" = 'platform.base'

    The name of the projectInterface representing the essential methods every Base Project Data Provider must implement

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7c8ab9a9e7..b28e6fb44b 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

    VariableNETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICEConst

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'

    Settings

    Member Visibility
    +NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICEConst

    NETWORK_OBJECT_NAME_PROJECT_LOOKUP_SERVICE: "ProjectLookupService" = 'ProjectLookupService'

    Settings

    Member Visibility
    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 2f7be2a391..79f217b315 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

    VariableprojectLookupServiceBaseConst

    projectLookupServiceBase: ProjectLookupServiceType

    Local object of functions to run locally on each process as part of the project lookup service

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 89b77ed821..f3f53f8f29 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

    VariabletestingProjectLookupServiceConst

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 dd7b7a03b9..7f413f6c75 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8b37483b1d..6352ac4a33 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8cad4f5f6d..abf5bd6223 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

    VariabledefaultConst

    default: DataProviderService

    Service that allows extensions to send and receive data to/from other extensions

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_dialog_service_.default.html b/papi-dts/variables/_shared_services_dialog_service_.default.html index 530088bfe8..b22cd9728c 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

    VariabledefaultConst

    default: DialogService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: DialogService

    Settings

    Member Visibility
    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 4b58239355..798df17170 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

    VariableCATEGORY_DIALOGConst

    CATEGORY_DIALOG: "dialog" = 'dialog'

    Prefix on requests that indicates that the request is related to dialog operations

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_internet_service_.default.html b/papi-dts/variables/_shared_services_internet_service_.default.html index 52e289a123..22c1644770 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

    VariabledefaultConst

    default: InternetService

    Service that provides a way to call fetch since the original function is not available

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_localization_service_.default.html b/papi-dts/variables/_shared_services_localization_service_.default.html index 3f454e080b..458a9d4195 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

    VariabledefaultConst

    default: ILocalizationService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: ILocalizationService

    Settings

    Member Visibility
    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 2b2a218423..c15695e95a 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

    VariablelocalizationServiceObjectToProxyConst

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8694039f42..6ab108fa53 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

    VariablelocalizationServiceProviderNameConst

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e2422753b6..5e98439139 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

    VariableWARN_TAGConst

    WARN_TAG: "<WARN>" = '<WARN>'

    Settings

    Member Visibility
    +WARN_TAG | papi-dts

    VariableWARN_TAGConst

    WARN_TAG: "<WARN>" = '<WARN>'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_logger_service_.default.html b/papi-dts/variables/_shared_services_logger_service_.default.html index b61507593c..e8532f1700 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

    VariabledefaultConst

    default: log.MainLogger & {
        default: log.MainLogger;
    }

    All extensions and services should use this logger to provide a unified output of logs

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 cae38133db..1256c5a826 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

    VariabledefaultConst

    default: IMenuDataService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: IMenuDataService

    Settings

    Member Visibility
    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 d0340d1cb4..157f3734ec 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

    VariablemenuDataServiceObjectToProxyConst

    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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8024b2033d..83a764cc4f 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

    VariablemenuDataServiceProviderNameConst

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 4503d792ab..d3c018d374 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 e30ece48cb..d6bb99120b 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 56ad610c20..23023ca62f 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

    VariabledefaultConst

    default: NetworkObjectStatusServiceType

    Provides functions related to the set of available network objects

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 4eecb1ca98..70f7582b88 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

    VariablepapiNetworkServiceConst

    papiNetworkService: PapiNetworkService

    Service that provides a way to send and receive network events

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0518e7f736..8e2c0d53c0 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

    VariablepapiBackendProjectDataProviderServiceConst

    papiBackendProjectDataProviderService: PapiBackendProjectDataProviderService

    Service that registers and gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 75248591a5..18e0168121 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

    VariablepapiFrontendProjectDataProviderServiceConst

    papiFrontendProjectDataProviderService: {
        get: typeof get;
    }

    Service that gets project data providers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 2b0b11618e..9261d69f36 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

    VariabledefaultConst

    default: "shared/models/project-lookup.service-model"

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: "shared/models/project-lookup.service-model"

    Settings

    Member Visibility
    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 2a9ec9138d..6eb70cca98 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

    VariabledefaultConst

    default: IProjectSettingsService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: IProjectSettingsService

    Settings

    Member Visibility
    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 1cd4119b55..4e31a5bf88 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

    VariableCATEGORY_EXTENSION_PROJECT_SETTING_VALIDATORConst

    CATEGORY_EXTENSION_PROJECT_SETTING_VALIDATOR: "extensionProjectSettingValidator" = 'extensionProjectSettingValidator'

    Name prefix for registered commands that call project settings validators

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 cb033d22f8..5965a8f07d 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

    VariableprojectSettingsServiceNetworkObjectNameConst

    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

    Settings

    Member Visibility
    +projectSettingsServiceNetworkObjectName | papi-dts

    VariableprojectSettingsServiceNetworkObjectNameConst

    projectSettingsServiceNetworkObjectName: "ProjectSettingsService" = 'ProjectSettingsService'

    Settings

    Member Visibility
    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 93d86331be..d49f08594b 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 721408aab6..04f1936628 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

    VariabledefaultConst

    default: IScrollGroupService

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 d8a00f4e87..5ccef1d177 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

    VariableEVENT_NAME_ON_DID_UPDATE_SCR_REFConst

    EVENT_NAME_ON_DID_UPDATE_SCR_REF: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 409d07d6a5..57b9beb438 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

    VariableNETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICEConst

    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'

    Settings

    Member Visibility
    +NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICEConst

    NETWORK_OBJECT_NAME_SCROLL_GROUP_SERVICE: "ScrollGroupService" = 'ScrollGroupService'

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/_shared_services_settings_service_.default.html b/papi-dts/variables/_shared_services_settings_service_.default.html index b75cc0149f..8876f8b588 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

    VariabledefaultConst

    default: ISettingsService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: ISettingsService

    Settings

    Member Visibility
    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 bd366195be..5230e708b7 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

    VariableCATEGORY_EXTENSION_SETTING_VALIDATORConst

    CATEGORY_EXTENSION_SETTING_VALIDATOR: "extensionSettingValidator" = 'extensionSettingValidator'

    Name prefix for registered commands that call settings validators

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 8c20be75cc..b26115c527 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

    VariablesettingsServiceDataProviderNameConst

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 709de7aeb0..b966b99a5b 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 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 6362677aa8..646f0dde8b 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

    VariabledefaultConst

    default: WebViewProviderService

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: WebViewProviderService

    Settings

    Member Visibility
    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 4f4c9472d5..3eb068fdf2 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

    VariablepapiWebViewProviderServiceConst

    papiWebViewProviderService: PapiWebViewProviderService

    Interface for registering webView providers, registering webView controllers, and performing privileged interactions with web views

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 5729b1a330..747009d1c7 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

    VariabledefaultConst

    default: WebViewServiceType

    Settings

    Member Visibility
    +default | papi-dts

    VariabledefaultConst

    default: WebViewServiceType

    Settings

    Member Visibility
    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 3831eea0dc..5148881edc 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

    VariableEVENT_NAME_ON_DID_ADD_WEB_VIEWConst

    EVENT_NAME_ON_DID_ADD_WEB_VIEW: `${string}:${string}`

    Deprecated

    13 November 2024. Renamed to EVENT_NAME_ON_DID_OPEN_WEB_VIEW

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 7d37972c8f..05a1179ba3 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

    VariableEVENT_NAME_ON_DID_CLOSE_WEB_VIEWConst

    EVENT_NAME_ON_DID_CLOSE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are closed

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 66682204e3..6c1ec28219 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

    VariableEVENT_NAME_ON_DID_OPEN_WEB_VIEWConst

    EVENT_NAME_ON_DID_OPEN_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are created

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 1c9e27b788..ba630fb3a3 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

    VariableEVENT_NAME_ON_DID_UPDATE_WEB_VIEWConst

    EVENT_NAME_ON_DID_UPDATE_WEB_VIEW: `${string}:${string}`

    Name to use when creating a network event that is fired when webViews are updated

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 263d1af92c..ef5ed1e389 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

    VariableNETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

    Settings

    Member Visibility
    +NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE | papi-dts

    VariableNETWORK_OBJECT_NAME_WEB_VIEW_SERVICEConst

    NETWORK_OBJECT_NAME_WEB_VIEW_SERVICE: "WebViewService" = 'WebViewService'

    Settings

    Member Visibility
    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 17afb02e9c..44ca384e97 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

    VariableWEB_VIEW_CONTROLLER_OBJECT_TYPEConst

    WEB_VIEW_CONTROLLER_OBJECT_TYPE: "webViewController" = 'webViewController'

    Network object type for web view controllers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 21c6a669e8..9734310343 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    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 0b696aad33..4c76f14de7 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/isNoisyDevModeEnabled.html b/papi-dts/variables/isNoisyDevModeEnabled.html index c8b97b479b..67e2ba85ff 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/isPackaged.html b/papi-dts/variables/isPackaged.html index 4e0d0ae1a0..4a5eea2f37 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/logLevel.html b/papi-dts/variables/logLevel.html index 89ac47b027..bec645ac84 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/processType.html b/papi-dts/variables/processType.html index 4907112d1e..7f6778a947 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/resourcesPath.html b/papi-dts/variables/resourcesPath.html index 8e4ba5c819..4734243d34 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/papi-dts/variables/webViewId.html b/papi-dts/variables/webViewId.html index 48bb1b2802..bdf713613c 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/enums/BookSelectionMode.html b/platform-bible-react/enums/BookSelectionMode.html index 0f312455cd..819d7ca8e3 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

    EnumerationBookSelectionMode

    Enumeration Members

    CHOOSE_BOOKS CURRENT_BOOK -

    Enumeration Members

    CHOOSE_BOOKS

    CHOOSE_BOOKS

    CURRENT_BOOK

    CURRENT_BOOK

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    CHOOSE_BOOKS

    CHOOSE_BOOKS

    CURRENT_BOOK

    CURRENT_BOOK

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/platform-bible-react/enums/DropdownMenuItemType.html b/platform-bible-react/enums/DropdownMenuItemType.html index 7b0b77a3b4..853d34655a 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

    EnumerationDropdownMenuItemType

    Enumeration Members

    Check Radio -

    Enumeration Members

    Check

    Check

    Radio

    Radio

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    Check

    Check

    Radio

    Radio

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/platform-bible-react/functions/Alert.html b/platform-bible-react/functions/Alert.html index 35e9233832..34c96da952 100644 --- a/platform-bible-react/functions/Alert.html +++ b/platform-bible-react/functions/Alert.html @@ -1,4 +1,4 @@ -Alert | platform-bible-react

    FunctionAlert

    • Alert(props): ReactNode

    • Parameters

      • props: HTMLAttributes<HTMLDivElement> & VariantProps<((props?: ConfigVariants<{ variant: { default: string; destructive: string; }; }> & ClassProp) => string)> & RefAttributes<HTMLDivElement>

      Returns ReactNode

    Properties

    $$typeof +Alert | platform-bible-react

    FunctionAlert

    • Alert(props): ReactNode

    • 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 91a56c30eb..8fc9e9d9f2 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 d84109a903..7c248dcde5 100644 --- a/platform-bible-react/functions/AlertTitle.html +++ b/platform-bible-react/functions/AlertTitle.html @@ -1,4 +1,4 @@ -AlertTitle | platform-bible-react

    FunctionAlertTitle

    Properties

    $$typeof +AlertTitle | platform-bible-react

    FunctionAlertTitle

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Badge.html b/platform-bible-react/functions/Badge.html index 6ae8b1d787..5c99f92c70 100644 --- a/platform-bible-react/functions/Badge.html +++ b/platform-bible-react/functions/Badge.html @@ -1 +1 @@ -Badge | platform-bible-react

    FunctionBadge

    Settings

    Member Visibility
    +Badge | platform-bible-react

    FunctionBadge

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/BookChapterControl.html b/platform-bible-react/functions/BookChapterControl.html index 1893f2e62e..f0f25dbe0b 100644 --- a/platform-bible-react/functions/BookChapterControl.html +++ b/platform-bible-react/functions/BookChapterControl.html @@ -1 +1 @@ -BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    Settings

    Member Visibility
    +BookChapterControl | platform-bible-react

    FunctionBookChapterControl

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/BookSelector.html b/platform-bible-react/functions/BookSelector.html index dd824ffc3d..d526afe2e0 100644 --- a/platform-bible-react/functions/BookSelector.html +++ b/platform-bible-react/functions/BookSelector.html @@ -1 +1 @@ -BookSelector | platform-bible-react

    FunctionBookSelector

    Settings

    Member Visibility
    +BookSelector | platform-bible-react

    FunctionBookSelector

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Button.html b/platform-bible-react/functions/Button.html index 8e3986edf1..d8dcc2886e 100644 --- a/platform-bible-react/functions/Button.html +++ b/platform-bible-react/functions/Button.html @@ -1,4 +1,4 @@ -Button | platform-bible-react

    FunctionButton

    Properties

    $$typeof +Button | platform-bible-react

    FunctionButton

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Card.html b/platform-bible-react/functions/Card.html index b61c90c0d2..2ddeaf2739 100644 --- a/platform-bible-react/functions/Card.html +++ b/platform-bible-react/functions/Card.html @@ -1,4 +1,4 @@ -Card | platform-bible-react

    FunctionCard

    Properties

    $$typeof +Card | platform-bible-react

    FunctionCard

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardContent.html b/platform-bible-react/functions/CardContent.html index 66b3306ae0..d869aa418d 100644 --- a/platform-bible-react/functions/CardContent.html +++ b/platform-bible-react/functions/CardContent.html @@ -1,4 +1,4 @@ -CardContent | platform-bible-react

    FunctionCardContent

    Properties

    $$typeof +CardContent | platform-bible-react

    FunctionCardContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardDescription.html b/platform-bible-react/functions/CardDescription.html index d69c5d9740..a2ac91fc60 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 39d0d26129..9234ef7903 100644 --- a/platform-bible-react/functions/CardFooter.html +++ b/platform-bible-react/functions/CardFooter.html @@ -1,4 +1,4 @@ -CardFooter | platform-bible-react

    FunctionCardFooter

    Properties

    $$typeof +CardFooter | platform-bible-react

    FunctionCardFooter

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardHeader.html b/platform-bible-react/functions/CardHeader.html index bf4239001d..7e0ac64601 100644 --- a/platform-bible-react/functions/CardHeader.html +++ b/platform-bible-react/functions/CardHeader.html @@ -1,4 +1,4 @@ -CardHeader | platform-bible-react

    FunctionCardHeader

    Properties

    $$typeof +CardHeader | platform-bible-react

    FunctionCardHeader

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/CardTitle.html b/platform-bible-react/functions/CardTitle.html index 23123d4871..4ae622441b 100644 --- a/platform-bible-react/functions/CardTitle.html +++ b/platform-bible-react/functions/CardTitle.html @@ -1,4 +1,4 @@ -CardTitle | platform-bible-react

    FunctionCardTitle

    Properties

    $$typeof +CardTitle | platform-bible-react

    FunctionCardTitle

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ChapterRangeSelector.html b/platform-bible-react/functions/ChapterRangeSelector.html index 430e1588ad..4e27acb85f 100644 --- a/platform-bible-react/functions/ChapterRangeSelector.html +++ b/platform-bible-react/functions/ChapterRangeSelector.html @@ -1 +1 @@ -ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    Settings

    Member Visibility
    +ChapterRangeSelector | platform-bible-react

    FunctionChapterRangeSelector

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Checkbox.html b/platform-bible-react/functions/Checkbox.html index e467e2a963..d6e6aeeab5 100644 --- a/platform-bible-react/functions/Checkbox.html +++ b/platform-bible-react/functions/Checkbox.html @@ -1,4 +1,4 @@ -Checkbox | platform-bible-react

    FunctionCheckbox

    Properties

    $$typeof +Checkbox | platform-bible-react

    FunctionCheckbox

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Checklist.html b/platform-bible-react/functions/Checklist.html index efc2b09ee8..aeabfb38ef 100644 --- a/platform-bible-react/functions/Checklist.html +++ b/platform-bible-react/functions/Checklist.html @@ -1,2 +1,2 @@ Checklist | platform-bible-react

    FunctionChecklist

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/ComboBox.html b/platform-bible-react/functions/ComboBox.html index 00d98091fd..8d99892a65 100644 --- a/platform-bible-react/functions/ComboBox.html +++ b/platform-bible-react/functions/ComboBox.html @@ -1,4 +1,4 @@ ComboBox | platform-bible-react

    FunctionComboBox

    Settings

    Member Visibility
    +

    Type Parameters

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/DataTable.html b/platform-bible-react/functions/DataTable.html index 67d649e058..d624588eac 100644 --- a/platform-bible-react/functions/DataTable.html +++ b/platform-bible-react/functions/DataTable.html @@ -1,3 +1,3 @@ DataTable | platform-bible-react

    FunctionDataTable

    Settings

    Member Visibility
    +

    Type Parameters

    • TData
    • TValue

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/DisableButton.html b/platform-bible-react/functions/DisableButton.html index db16f5bc39..bad8f0c8ba 100644 --- a/platform-bible-react/functions/DisableButton.html +++ b/platform-bible-react/functions/DisableButton.html @@ -1,4 +1,4 @@ DisableButton | platform-bible-react

    FunctionDisableButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/DropdownMenu.html b/platform-bible-react/functions/DropdownMenu.html index 3b79558c4d..c825df4804 100644 --- a/platform-bible-react/functions/DropdownMenu.html +++ b/platform-bible-react/functions/DropdownMenu.html @@ -1,5 +1,5 @@ DropdownMenu | platform-bible-react

    FunctionDropdownMenu

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuCheckboxItem.html b/platform-bible-react/functions/DropdownMenuCheckboxItem.html index 123b36c6b4..cf799cb61a 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 9c7eefffa2..c84baf3311 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 189000c874..abe7145fa4 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 e6f2d760f6..ccd9ddcb69 100644 --- a/platform-bible-react/functions/DropdownMenuItem.html +++ b/platform-bible-react/functions/DropdownMenuItem.html @@ -1,6 +1,6 @@ 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 +

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuLabel.html b/platform-bible-react/functions/DropdownMenuLabel.html index 6211754a0f..4f489b6217 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 a0f665fec4..497b4a57f9 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

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuRadioGroup.html b/platform-bible-react/functions/DropdownMenuRadioGroup.html index d2a677bd57..046ca6c825 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 35f1b5a070..25588dc120 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 b2f61f4030..66385c4d15 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 eec7722726..8afa172adb 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

    displayName -

    Properties

    displayName

    displayName: string

    Settings

    Member Visibility

    On This Page

    Properties
    +DropdownMenuShortcut | platform-bible-react

    FunctionDropdownMenuShortcut

    Properties

    displayName +

    Properties

    displayName

    displayName: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-react/functions/DropdownMenuSub.html b/platform-bible-react/functions/DropdownMenuSub.html index dc33404755..639d4ad198 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

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/DropdownMenuSubContent.html b/platform-bible-react/functions/DropdownMenuSubContent.html index 3334e07737..ca46a979ec 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 951a1d4bd2..7841e030b4 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 b77e18a0a1..a66ce6f91a 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 43f4040629..d909a49d51 100644 --- a/platform-bible-react/functions/EnableButton.html +++ b/platform-bible-react/functions/EnableButton.html @@ -1,4 +1,4 @@ EnableButton | platform-bible-react

    FunctionEnableButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/FilterButton.html b/platform-bible-react/functions/FilterButton.html index 2a41357752..64ad094721 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

    $$typeof +

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/FilterDropdown.html b/platform-bible-react/functions/FilterDropdown.html index 7479503c01..fd0fb9d004 100644 --- a/platform-bible-react/functions/FilterDropdown.html +++ b/platform-bible-react/functions/FilterDropdown.html @@ -1,4 +1,4 @@ FilterDropdown | platform-bible-react

    FunctionFilterDropdown

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Footer.html b/platform-bible-react/functions/Footer.html index e14b980bb3..ecac3b8c58 100644 --- a/platform-bible-react/functions/Footer.html +++ b/platform-bible-react/functions/Footer.html @@ -1,4 +1,4 @@ Footer | platform-bible-react

    FunctionFooter

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/GridMenu.html b/platform-bible-react/functions/GridMenu.html index 940e9f22cf..329e58090f 100644 --- a/platform-bible-react/functions/GridMenu.html +++ b/platform-bible-react/functions/GridMenu.html @@ -1 +1 @@ -GridMenu | platform-bible-react

    FunctionGridMenu

    Settings

    Member Visibility
    +GridMenu | platform-bible-react

    FunctionGridMenu

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/HamburgerMenuButton.html b/platform-bible-react/functions/HamburgerMenuButton.html index 81792cf598..156ac9a19b 100644 --- a/platform-bible-react/functions/HamburgerMenuButton.html +++ b/platform-bible-react/functions/HamburgerMenuButton.html @@ -1 +1 @@ -HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    Settings

    Member Visibility
    +HamburgerMenuButton | platform-bible-react

    FunctionHamburgerMenuButton

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/IconButton.html b/platform-bible-react/functions/IconButton.html index fdb4cbf0d6..463bdbdb51 100644 --- a/platform-bible-react/functions/IconButton.html +++ b/platform-bible-react/functions/IconButton.html @@ -1,4 +1,4 @@ IconButton | platform-bible-react

    FunctionIconButton

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Input.html b/platform-bible-react/functions/Input.html index 790ff33b52..03f11f03e7 100644 --- a/platform-bible-react/functions/Input.html +++ b/platform-bible-react/functions/Input.html @@ -1,4 +1,4 @@ -Input | platform-bible-react

    FunctionInput

    Properties

    $$typeof +Input | platform-bible-react

    FunctionInput

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/InstallButton.html b/platform-bible-react/functions/InstallButton.html index 87d911fedc..83cea7069b 100644 --- a/platform-bible-react/functions/InstallButton.html +++ b/platform-bible-react/functions/InstallButton.html @@ -1,4 +1,4 @@ InstallButton | platform-bible-react

    FunctionInstallButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Inventory.html b/platform-bible-react/functions/Inventory.html index 0ad2e128e3..997d171019 100644 --- a/platform-bible-react/functions/Inventory.html +++ b/platform-bible-react/functions/Inventory.html @@ -1,2 +1,2 @@ Inventory | platform-bible-react

    FunctionInventory

    Settings

    Member Visibility
    +

    Parameters

    • __namedParameters: InventoryProps

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Label.html b/platform-bible-react/functions/Label.html index 59d0ec3c44..0ba5e108eb 100644 --- a/platform-bible-react/functions/Label.html +++ b/platform-bible-react/functions/Label.html @@ -1,4 +1,4 @@ -Label | platform-bible-react

    FunctionLabel

    Properties

    $$typeof +Label | platform-bible-react

    FunctionLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/MarkdownRenderer.html b/platform-bible-react/functions/MarkdownRenderer.html index cab97d72c9..9031273656 100644 --- a/platform-bible-react/functions/MarkdownRenderer.html +++ b/platform-bible-react/functions/MarkdownRenderer.html @@ -1,4 +1,4 @@ MarkdownRenderer | platform-bible-react

    FunctionMarkdownRenderer

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/MenuItem.html b/platform-bible-react/functions/MenuItem.html index 343cc25642..95caf29479 100644 --- a/platform-bible-react/functions/MenuItem.html +++ b/platform-bible-react/functions/MenuItem.html @@ -1 +1 @@ -MenuItem | platform-bible-react

    FunctionMenuItem

    Settings

    Member Visibility
    +MenuItem | platform-bible-react

    FunctionMenuItem

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/MoreInfo.html b/platform-bible-react/functions/MoreInfo.html index 5b0ca95571..0801742f9b 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/MultiSelectComboBox.html b/platform-bible-react/functions/MultiSelectComboBox.html index fbfce9ea37..dc419161b8 100644 --- a/platform-bible-react/functions/MultiSelectComboBox.html +++ b/platform-bible-react/functions/MultiSelectComboBox.html @@ -1 +1 @@ -MultiSelectComboBox | platform-bible-react

    FunctionMultiSelectComboBox

    Settings

    Member Visibility
    +MultiSelectComboBox | platform-bible-react

    FunctionMultiSelectComboBox

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/NavigationContentSearch.html b/platform-bible-react/functions/NavigationContentSearch.html index 70f752d68e..509a4c67a2 100644 --- a/platform-bible-react/functions/NavigationContentSearch.html +++ b/platform-bible-react/functions/NavigationContentSearch.html @@ -1 +1 @@ -NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    Settings

    Member Visibility
    +NavigationContentSearch | platform-bible-react

    FunctionNavigationContentSearch

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/NoExtensionsFound.html b/platform-bible-react/functions/NoExtensionsFound.html index 72e15361d9..e4c38a7122 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.
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/RadioGroup.html b/platform-bible-react/functions/RadioGroup.html index 7829cebaca..2005bcb85e 100644 --- a/platform-bible-react/functions/RadioGroup.html +++ b/platform-bible-react/functions/RadioGroup.html @@ -1,4 +1,4 @@ -RadioGroup | platform-bible-react

    FunctionRadioGroup

    Properties

    $$typeof +RadioGroup | platform-bible-react

    FunctionRadioGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/RadioGroupItem.html b/platform-bible-react/functions/RadioGroupItem.html index 706cae34ac..feeab78040 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 c449452bbe..caddb1f449 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

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/ScrollGroupSelector.html b/platform-bible-react/functions/ScrollGroupSelector.html index c748e5fb31..cedc20271e 100644 --- a/platform-bible-react/functions/ScrollGroupSelector.html +++ b/platform-bible-react/functions/ScrollGroupSelector.html @@ -1,2 +1,2 @@ ScrollGroupSelector | platform-bible-react

    FunctionScrollGroupSelector

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SearchBar.html b/platform-bible-react/functions/SearchBar.html index b0c978fc34..52687fe5db 100644 --- a/platform-bible-react/functions/SearchBar.html +++ b/platform-bible-react/functions/SearchBar.html @@ -1 +1 @@ -SearchBar | platform-bible-react

    FunctionSearchBar

    Settings

    Member Visibility
    +SearchBar | platform-bible-react

    FunctionSearchBar

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Select.html b/platform-bible-react/functions/Select.html index e3d3806f9a..8bd5591325 100644 --- a/platform-bible-react/functions/Select.html +++ b/platform-bible-react/functions/Select.html @@ -1,5 +1,5 @@ Select | platform-bible-react

    FunctionSelect

    Properties

    contextTypes? +

    Returns ReactNode

    Properties

    contextTypes? defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectContent.html b/platform-bible-react/functions/SelectContent.html index 4f17106419..f40f052682 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 be817e38cb..33e2d2b2e5 100644 --- a/platform-bible-react/functions/SelectGroup.html +++ b/platform-bible-react/functions/SelectGroup.html @@ -1,4 +1,4 @@ -SelectGroup | platform-bible-react

    FunctionSelectGroup

    Properties

    $$typeof +SelectGroup | platform-bible-react

    FunctionSelectGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectItem.html b/platform-bible-react/functions/SelectItem.html index 23284292b7..56ae909eb0 100644 --- a/platform-bible-react/functions/SelectItem.html +++ b/platform-bible-react/functions/SelectItem.html @@ -1,4 +1,4 @@ -SelectItem | platform-bible-react

    FunctionSelectItem

    Properties

    $$typeof +SelectItem | platform-bible-react

    FunctionSelectItem

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectLabel.html b/platform-bible-react/functions/SelectLabel.html index 086c284f64..cb2a02bfd7 100644 --- a/platform-bible-react/functions/SelectLabel.html +++ b/platform-bible-react/functions/SelectLabel.html @@ -1,4 +1,4 @@ -SelectLabel | platform-bible-react

    FunctionSelectLabel

    Properties

    $$typeof +SelectLabel | platform-bible-react

    FunctionSelectLabel

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SelectScrollDownButton.html b/platform-bible-react/functions/SelectScrollDownButton.html index bc3a2229c0..d5614d33ef 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 6b90ba153f..9ab9b7b4a6 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 872e6d94da..4f2e35b78b 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 5460af0d06..f050c9ac08 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 a1b3e9401f..024690d11b 100644 --- a/platform-bible-react/functions/SelectValue.html +++ b/platform-bible-react/functions/SelectValue.html @@ -1,4 +1,4 @@ -SelectValue | platform-bible-react

    FunctionSelectValue

    Properties

    $$typeof +SelectValue | platform-bible-react

    FunctionSelectValue

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Separator.html b/platform-bible-react/functions/Separator.html index 35a730034b..d199606735 100644 --- a/platform-bible-react/functions/Separator.html +++ b/platform-bible-react/functions/Separator.html @@ -1,4 +1,4 @@ -Separator | platform-bible-react

    FunctionSeparator

    Properties

    $$typeof +Separator | platform-bible-react

    FunctionSeparator

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/SettingsList.html b/platform-bible-react/functions/SettingsList.html index a5660786ee..6657bbe8bd 100644 --- a/platform-bible-react/functions/SettingsList.html +++ b/platform-bible-react/functions/SettingsList.html @@ -1,4 +1,4 @@ SettingsList | platform-bible-react

    FunctionSettingsList

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SettingsListHeader.html b/platform-bible-react/functions/SettingsListHeader.html index e2108e86d6..ff780702d9 100644 --- a/platform-bible-react/functions/SettingsListHeader.html +++ b/platform-bible-react/functions/SettingsListHeader.html @@ -1,3 +1,3 @@ SettingsListHeader | platform-bible-react

    FunctionSettingsListHeader

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SettingsListItem.html b/platform-bible-react/functions/SettingsListItem.html index 966d43fc4e..d5d5379ac7 100644 --- a/platform-bible-react/functions/SettingsListItem.html +++ b/platform-bible-react/functions/SettingsListItem.html @@ -1,3 +1,3 @@ SettingsListItem | platform-bible-react

    FunctionSettingsListItem

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SettingsSidebar.html b/platform-bible-react/functions/SettingsSidebar.html index e209c511d8..464b9819c7 100644 --- a/platform-bible-react/functions/SettingsSidebar.html +++ b/platform-bible-react/functions/SettingsSidebar.html @@ -1 +1 @@ -SettingsSidebar | platform-bible-react

    FunctionSettingsSidebar

    Settings

    Member Visibility
    +SettingsSidebar | platform-bible-react

    FunctionSettingsSidebar

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/SettingsSidebarContentSearch.html b/platform-bible-react/functions/SettingsSidebarContentSearch.html index b1b9a9a8ed..8933f03502 100644 --- a/platform-bible-react/functions/SettingsSidebarContentSearch.html +++ b/platform-bible-react/functions/SettingsSidebarContentSearch.html @@ -1 +1 @@ -SettingsSidebarContentSearch | platform-bible-react

    FunctionSettingsSidebarContentSearch

    Settings

    Member Visibility
    +SettingsSidebarContentSearch | platform-bible-react

    FunctionSettingsSidebarContentSearch

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Slider.html b/platform-bible-react/functions/Slider.html index 23ef36d250..16e19eb2a8 100644 --- a/platform-bible-react/functions/Slider.html +++ b/platform-bible-react/functions/Slider.html @@ -1,4 +1,4 @@ -Slider | platform-bible-react

    FunctionSlider

    Properties

    $$typeof +Slider | platform-bible-react

    FunctionSlider

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Sonner-1.html b/platform-bible-react/functions/Sonner-1.html index efb8fab18f..27218daf89 100644 --- a/platform-bible-react/functions/Sonner-1.html +++ b/platform-bible-react/functions/Sonner-1.html @@ -1 +1 @@ -Sonner | platform-bible-react

    FunctionSonner

    Settings

    Member Visibility
    +Sonner | platform-bible-react

    FunctionSonner

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/Spinner.html b/platform-bible-react/functions/Spinner.html index 86b047f58a..fc1ef857bd 100644 --- a/platform-bible-react/functions/Spinner.html +++ b/platform-bible-react/functions/Spinner.html @@ -1,4 +1,4 @@ -Spinner | platform-bible-react

    FunctionSpinner

    Properties

    $$typeof +Spinner | platform-bible-react

    FunctionSpinner

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Switch.html b/platform-bible-react/functions/Switch.html index 712520dacc..1afc954745 100644 --- a/platform-bible-react/functions/Switch.html +++ b/platform-bible-react/functions/Switch.html @@ -1,4 +1,4 @@ -Switch | platform-bible-react

    FunctionSwitch

    Properties

    $$typeof +Switch | platform-bible-react

    FunctionSwitch

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Table.html b/platform-bible-react/functions/Table.html index 9c1b15b18a..4ec2352f4d 100644 --- a/platform-bible-react/functions/Table.html +++ b/platform-bible-react/functions/Table.html @@ -1,4 +1,4 @@ -Table | platform-bible-react

    FunctionTable

    Properties

    $$typeof +Table | platform-bible-react

    FunctionTable

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableBody.html b/platform-bible-react/functions/TableBody.html index ad5ec8a6dc..d179d3f870 100644 --- a/platform-bible-react/functions/TableBody.html +++ b/platform-bible-react/functions/TableBody.html @@ -1,4 +1,4 @@ -TableBody | platform-bible-react

    FunctionTableBody

    Properties

    $$typeof +TableBody | platform-bible-react

    FunctionTableBody

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCaption.html b/platform-bible-react/functions/TableCaption.html index 00221bbbb4..ea210a70b4 100644 --- a/platform-bible-react/functions/TableCaption.html +++ b/platform-bible-react/functions/TableCaption.html @@ -1,4 +1,4 @@ -TableCaption | platform-bible-react

    FunctionTableCaption

    Properties

    $$typeof +TableCaption | platform-bible-react

    FunctionTableCaption

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableCell.html b/platform-bible-react/functions/TableCell.html index bd64a200cf..48c503be9d 100644 --- a/platform-bible-react/functions/TableCell.html +++ b/platform-bible-react/functions/TableCell.html @@ -1,4 +1,4 @@ -TableCell | platform-bible-react

    FunctionTableCell

    Properties

    $$typeof +TableCell | platform-bible-react

    FunctionTableCell

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableFooter.html b/platform-bible-react/functions/TableFooter.html index 8a36d79dab..f676c2c393 100644 --- a/platform-bible-react/functions/TableFooter.html +++ b/platform-bible-react/functions/TableFooter.html @@ -1,4 +1,4 @@ -TableFooter | platform-bible-react

    FunctionTableFooter

    Properties

    $$typeof +TableFooter | platform-bible-react

    FunctionTableFooter

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHead.html b/platform-bible-react/functions/TableHead.html index 905faf1cb3..cd4edde092 100644 --- a/platform-bible-react/functions/TableHead.html +++ b/platform-bible-react/functions/TableHead.html @@ -1,4 +1,4 @@ -TableHead | platform-bible-react

    FunctionTableHead

    Properties

    $$typeof +TableHead | platform-bible-react

    FunctionTableHead

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableHeader.html b/platform-bible-react/functions/TableHeader.html index 35260ec82d..e2c07ca286 100644 --- a/platform-bible-react/functions/TableHeader.html +++ b/platform-bible-react/functions/TableHeader.html @@ -1,4 +1,4 @@ -TableHeader | platform-bible-react

    FunctionTableHeader

    Properties

    $$typeof +TableHeader | platform-bible-react

    FunctionTableHeader

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TableRow.html b/platform-bible-react/functions/TableRow.html index ef5285c835..14ad198056 100644 --- a/platform-bible-react/functions/TableRow.html +++ b/platform-bible-react/functions/TableRow.html @@ -1,4 +1,4 @@ -TableRow | platform-bible-react

    FunctionTableRow

    Properties

    $$typeof +TableRow | platform-bible-react

    FunctionTableRow

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/Tabs.html b/platform-bible-react/functions/Tabs.html index f55ca81cd3..f25175683e 100644 --- a/platform-bible-react/functions/Tabs.html +++ b/platform-bible-react/functions/Tabs.html @@ -1,4 +1,4 @@ -Tabs | platform-bible-react

    FunctionTabs

    Properties

    $$typeof +Tabs | platform-bible-react

    FunctionTabs

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsContent.html b/platform-bible-react/functions/TabsContent.html index daf1ad3e31..115087913a 100644 --- a/platform-bible-react/functions/TabsContent.html +++ b/platform-bible-react/functions/TabsContent.html @@ -1,4 +1,4 @@ -TabsContent | platform-bible-react

    FunctionTabsContent

    Properties

    $$typeof +TabsContent | platform-bible-react

    FunctionTabsContent

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsList.html b/platform-bible-react/functions/TabsList.html index cbfaf361db..370e6fdb6c 100644 --- a/platform-bible-react/functions/TabsList.html +++ b/platform-bible-react/functions/TabsList.html @@ -1,4 +1,4 @@ -TabsList | platform-bible-react

    FunctionTabsList

    Properties

    $$typeof +TabsList | platform-bible-react

    FunctionTabsList

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TabsTrigger.html b/platform-bible-react/functions/TabsTrigger.html index 4059016b41..d3c10d4c7d 100644 --- a/platform-bible-react/functions/TabsTrigger.html +++ b/platform-bible-react/functions/TabsTrigger.html @@ -1,4 +1,4 @@ -TabsTrigger | platform-bible-react

    FunctionTabsTrigger

    Properties

    $$typeof +TabsTrigger | platform-bible-react

    FunctionTabsTrigger

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/TextField.html b/platform-bible-react/functions/TextField.html index bf3d90936a..6bcac22082 100644 --- a/platform-bible-react/functions/TextField.html +++ b/platform-bible-react/functions/TextField.html @@ -1,4 +1,4 @@ TextField | platform-bible-react

    FunctionTextField

    Settings

    Member Visibility
    +

    Parameters

    Returns Element

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/ToggleGroup.html b/platform-bible-react/functions/ToggleGroup.html index 30c12773d0..2d935d7a71 100644 --- a/platform-bible-react/functions/ToggleGroup.html +++ b/platform-bible-react/functions/ToggleGroup.html @@ -1,4 +1,4 @@ -ToggleGroup | platform-bible-react

    FunctionToggleGroup

    Properties

    $$typeof +ToggleGroup | platform-bible-react

    FunctionToggleGroup

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/ToggleGroupItem.html b/platform-bible-react/functions/ToggleGroupItem.html index c7c00bac8d..d764825f4e 100644 --- a/platform-bible-react/functions/ToggleGroupItem.html +++ b/platform-bible-react/functions/ToggleGroupItem.html @@ -1,4 +1,4 @@ -ToggleGroupItem | platform-bible-react

    FunctionToggleGroupItem

    • ToggleGroupItem(props): ReactNode

    • 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

    • ToggleGroupItem(props): ReactNode

    • 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 cd168b8d41..673c311dcb 100644 --- a/platform-bible-react/functions/Toolbar.html +++ b/platform-bible-react/functions/Toolbar.html @@ -1 +1 @@ -Toolbar | platform-bible-react

    FunctionToolbar

    Settings

    Member Visibility
    +Toolbar | platform-bible-react

    FunctionToolbar

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/UpdateButton.html b/platform-bible-react/functions/UpdateButton.html index 9dd01037e8..b069242c33 100644 --- a/platform-bible-react/functions/UpdateButton.html +++ b/platform-bible-react/functions/UpdateButton.html @@ -1,4 +1,4 @@ UpdateButton | platform-bible-react

    FunctionUpdateButton

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/VersionHistory.html b/platform-bible-react/functions/VersionHistory.html index 313bf28f82..78e6850079 100644 --- a/platform-bible-react/functions/VersionHistory.html +++ b/platform-bible-react/functions/VersionHistory.html @@ -1,4 +1,4 @@ VersionHistory | platform-bible-react

    FunctionVersionHistory

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/VerticalTabs.html b/platform-bible-react/functions/VerticalTabs.html index 3f207d12ae..51ba1e5040 100644 --- a/platform-bible-react/functions/VerticalTabs.html +++ b/platform-bible-react/functions/VerticalTabs.html @@ -1,4 +1,4 @@ -VerticalTabs | platform-bible-react

    FunctionVerticalTabs

    Properties

    $$typeof +VerticalTabs | platform-bible-react

    FunctionVerticalTabs

    Properties

    $$typeof defaultProps? displayName? propTypes? diff --git a/platform-bible-react/functions/VerticalTabsContent.html b/platform-bible-react/functions/VerticalTabsContent.html index ccc5bcbdf9..825213c0a0 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 3123d55cd0..da9f164fc9 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 0bf855f556..d5e1004bfa 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 d59916bd46..6153dd771c 100644 --- a/platform-bible-react/functions/badgeVariants.html +++ b/platform-bible-react/functions/badgeVariants.html @@ -1 +1 @@ -badgeVariants | platform-bible-react

    FunctionbadgeVariants

    Settings

    Member Visibility
    +badgeVariants | platform-bible-react

    FunctionbadgeVariants

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/buttonVariants.html b/platform-bible-react/functions/buttonVariants.html index 396e8578bf..d97aa4fc01 100644 --- a/platform-bible-react/functions/buttonVariants.html +++ b/platform-bible-react/functions/buttonVariants.html @@ -1 +1 @@ -buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • buttonVariants(props?): string

    • 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

    Settings

    Member Visibility
    +buttonVariants | platform-bible-react

    FunctionbuttonVariants

    • buttonVariants(props?): string

    • 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

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/cn.html b/platform-bible-react/functions/cn.html index 3c044378f1..d11863b9b8 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.
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getBookNumFromId.html b/platform-bible-react/functions/getBookNumFromId.html index 2073a475b5..c662f643fa 100644 --- a/platform-bible-react/functions/getBookNumFromId.html +++ b/platform-bible-react/functions/getBookNumFromId.html @@ -2,4 +2,4 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getLinesFromUSFM.html b/platform-bible-react/functions/getLinesFromUSFM.html index 347d027f71..2a7e102b83 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getNumberFromUSFM.html b/platform-bible-react/functions/getNumberFromUSFM.html index 47acc63889..62fab7768a 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/getStatusForItem.html b/platform-bible-react/functions/getStatusForItem.html index 987f9ecb62..e8e5a84719 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/inventoryCountColumn.html b/platform-bible-react/functions/inventoryCountColumn.html index b0be6a352b..1f99706797 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.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/inventoryItemColumn.html b/platform-bible-react/functions/inventoryItemColumn.html index eb5908e7a6..e369fc01f9 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/inventoryStatusColumn.html b/platform-bible-react/functions/inventoryStatusColumn.html index e0afcf98c9..523cbbf475 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/useEvent.html b/platform-bible-react/functions/useEvent.html index 551947707e..371efc2bb3 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

    Settings

    Member Visibility
    +

    Returns void

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/useEventAsync.html b/platform-bible-react/functions/useEventAsync.html index 4c66de8201..fa7647ca06 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

    Settings

    Member Visibility
    +

    Returns void

    Settings

    Member Visibility
    diff --git a/platform-bible-react/functions/usePromise.html b/platform-bible-react/functions/usePromise.html index c232e752fb..14997f60ae 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
    • -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/interfaces/BadgeProps.html b/platform-bible-react/interfaces/BadgeProps.html index 97ee16b25b..5b416a76e4 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

    about? accessKey? aria-activedescendant? aria-atomic? @@ -383,4 +383,4 @@

    See

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    OptionalitemID

    itemID?: string

    OptionalitemProp

    itemProp?: string

    OptionalitemRef

    itemRef?: string

    OptionalitemScope

    itemScope?: boolean

    OptionalitemType

    itemType?: string

    Optionallang

    lang?: string

    Optionalnonce

    nonce?: string

    OptionalonAbort

    onAbort?: ReactEventHandler<HTMLDivElement>

    OptionalonAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLDivElement>

    OptionalonAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>

    OptionalonAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLDivElement>

    OptionalonAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>

    OptionalonAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLDivElement>

    OptionalonAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>

    OptionalonAuxClick

    onAuxClick?: MouseEventHandler<HTMLDivElement>

    OptionalonAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonBeforeInput

    onBeforeInput?: FormEventHandler<HTMLDivElement>

    OptionalonBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLDivElement>

    OptionalonBlur

    onBlur?: FocusEventHandler<HTMLDivElement>

    OptionalonBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLDivElement>

    OptionalonCanPlay

    onCanPlay?: ReactEventHandler<HTMLDivElement>

    OptionalonCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLDivElement>

    OptionalonCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonChange

    onChange?: FormEventHandler<HTMLDivElement>

    OptionalonChangeCapture

    onChangeCapture?: FormEventHandler<HTMLDivElement>

    OptionalonClick

    onClick?: MouseEventHandler<HTMLDivElement>

    OptionalonClickCapture

    onClickCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLDivElement>

    OptionalonCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>

    OptionalonCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLDivElement>

    OptionalonCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>

    OptionalonCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>

    OptionalonCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>

    OptionalonContextMenu

    onContextMenu?: MouseEventHandler<HTMLDivElement>

    OptionalonContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonCopy

    onCopy?: ClipboardEventHandler<HTMLDivElement>

    OptionalonCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLDivElement>

    OptionalonCut

    onCut?: ClipboardEventHandler<HTMLDivElement>

    OptionalonCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLDivElement>

    OptionalonDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLDivElement>

    OptionalonDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonDrag

    onDrag?: DragEventHandler<HTMLDivElement>

    OptionalonDragCapture

    onDragCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDragEnd

    onDragEnd?: DragEventHandler<HTMLDivElement>

    OptionalonDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDragEnter

    onDragEnter?: DragEventHandler<HTMLDivElement>

    OptionalonDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDragExit

    onDragExit?: DragEventHandler<HTMLDivElement>

    OptionalonDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDragLeave

    onDragLeave?: DragEventHandler<HTMLDivElement>

    OptionalonDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDragOver

    onDragOver?: DragEventHandler<HTMLDivElement>

    OptionalonDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDragStart

    onDragStart?: DragEventHandler<HTMLDivElement>

    OptionalonDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDrop

    onDrop?: DragEventHandler<HTMLDivElement>

    OptionalonDropCapture

    onDropCapture?: DragEventHandler<HTMLDivElement>

    OptionalonDurationChange

    onDurationChange?: ReactEventHandler<HTMLDivElement>

    OptionalonDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonEmptied

    onEmptied?: ReactEventHandler<HTMLDivElement>

    OptionalonEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonEncrypted

    onEncrypted?: ReactEventHandler<HTMLDivElement>

    OptionalonEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonEnded

    onEnded?: ReactEventHandler<HTMLDivElement>

    OptionalonEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonError

    onError?: ReactEventHandler<HTMLDivElement>

    OptionalonErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonFocus

    onFocus?: FocusEventHandler<HTMLDivElement>

    OptionalonFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLDivElement>

    OptionalonGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonInput

    onInput?: FormEventHandler<HTMLDivElement>

    OptionalonInputCapture

    onInputCapture?: FormEventHandler<HTMLDivElement>

    OptionalonInvalid

    onInvalid?: FormEventHandler<HTMLDivElement>

    OptionalonInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLDivElement>

    OptionalonKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLDivElement>

    OptionalonKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>

    OptionalonKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLDivElement>

    Deprecated

    Use onKeyUp or onKeyDown instead

    OptionalonKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>

    Deprecated

    Use onKeyUpCapture or onKeyDownCapture instead

    -

    OptionalonKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLDivElement>

    OptionalonKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>

    OptionalonLoad

    onLoad?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedData

    onLoadedData?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadStart

    onLoadStart?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonMouseDown

    onMouseDown?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseMove

    onMouseMove?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOut

    onMouseOut?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOver

    onMouseOver?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseUp

    onMouseUp?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonPaste

    onPaste?: ClipboardEventHandler<HTMLDivElement>

    OptionalonPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>

    OptionalonPause

    onPause?: ReactEventHandler<HTMLDivElement>

    OptionalonPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonPlay

    onPlay?: ReactEventHandler<HTMLDivElement>

    OptionalonPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonPlaying

    onPlaying?: ReactEventHandler<HTMLDivElement>

    OptionalonPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerDown

    onPointerDown?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerMove

    onPointerMove?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOut

    onPointerOut?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOver

    onPointerOver?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerUp

    onPointerUp?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonProgress

    onProgress?: ReactEventHandler<HTMLDivElement>

    OptionalonProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonRateChange

    onRateChange?: ReactEventHandler<HTMLDivElement>

    OptionalonRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonReset

    onReset?: FormEventHandler<HTMLDivElement>

    OptionalonResetCapture

    onResetCapture?: FormEventHandler<HTMLDivElement>

    OptionalonResize

    onResize?: ReactEventHandler<HTMLDivElement>

    OptionalonResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonScroll

    onScroll?: UIEventHandler<HTMLDivElement>

    OptionalonScrollCapture

    onScrollCapture?: UIEventHandler<HTMLDivElement>

    OptionalonSeeked

    onSeeked?: ReactEventHandler<HTMLDivElement>

    OptionalonSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonSeeking

    onSeeking?: ReactEventHandler<HTMLDivElement>

    OptionalonSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonSelect

    onSelect?: ReactEventHandler<HTMLDivElement>

    OptionalonSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonStalled

    onStalled?: ReactEventHandler<HTMLDivElement>

    OptionalonStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonSubmit

    onSubmit?: FormEventHandler<HTMLDivElement>

    OptionalonSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLDivElement>

    OptionalonSuspend

    onSuspend?: ReactEventHandler<HTMLDivElement>

    OptionalonSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLDivElement>

    OptionalonTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchMove

    onTouchMove?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchStart

    onTouchStart?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>

    OptionalonTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>

    OptionalonVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLDivElement>

    OptionalonVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonWaiting

    onWaiting?: ReactEventHandler<HTMLDivElement>

    OptionalonWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonWheel

    onWheel?: WheelEventHandler<HTMLDivElement>

    OptionalonWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLDivElement>

    Optionalprefix

    prefix?: string

    Optionalproperty

    property?: string

    OptionalradioGroup

    radioGroup?: string

    Optionalrel

    rel?: string

    Optionalresource

    resource?: string

    Optionalresults

    results?: number

    Optionalrev

    rev?: string

    Optionalrole

    role?: AriaRole

    Optionalsecurity

    security?: string

    Optionalslot

    slot?: string

    OptionalspellCheck

    spellCheck?: Booleanish

    Optionalstyle

    style?: CSSProperties

    OptionalsuppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    OptionalsuppressHydrationWarning

    suppressHydrationWarning?: boolean

    OptionaltabIndex

    tabIndex?: number

    Optionaltitle

    title?: string

    Optionaltranslate

    translate?: "yes" | "no"

    Optionaltypeof

    typeof?: string

    Optionalunselectable

    unselectable?: "off" | "on"

    Optionalvariant

    variant?:
        | null
        | "default"
        | "outline"
        | "muted"
        | "destructive"
        | "secondary" = ...

    Optionalvocab

    vocab?: string

    Settings

    Member Visibility

    On This Page

    Properties
    aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdraggableenterKeyHinthiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecurityslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypeofunselectablevariantvocab
    +

    OptionalonKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLDivElement>

    OptionalonKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>

    OptionalonLoad

    onLoad?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedData

    onLoadedData?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadStart

    onLoadStart?: ReactEventHandler<HTMLDivElement>

    OptionalonLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonMouseDown

    onMouseDown?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseMove

    onMouseMove?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOut

    onMouseOut?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOver

    onMouseOver?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseUp

    onMouseUp?: MouseEventHandler<HTMLDivElement>

    OptionalonMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>

    OptionalonPaste

    onPaste?: ClipboardEventHandler<HTMLDivElement>

    OptionalonPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>

    OptionalonPause

    onPause?: ReactEventHandler<HTMLDivElement>

    OptionalonPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonPlay

    onPlay?: ReactEventHandler<HTMLDivElement>

    OptionalonPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonPlaying

    onPlaying?: ReactEventHandler<HTMLDivElement>

    OptionalonPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerDown

    onPointerDown?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerMove

    onPointerMove?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOut

    onPointerOut?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOver

    onPointerOver?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerUp

    onPointerUp?: PointerEventHandler<HTMLDivElement>

    OptionalonPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>

    OptionalonProgress

    onProgress?: ReactEventHandler<HTMLDivElement>

    OptionalonProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonRateChange

    onRateChange?: ReactEventHandler<HTMLDivElement>

    OptionalonRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonReset

    onReset?: FormEventHandler<HTMLDivElement>

    OptionalonResetCapture

    onResetCapture?: FormEventHandler<HTMLDivElement>

    OptionalonResize

    onResize?: ReactEventHandler<HTMLDivElement>

    OptionalonResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonScroll

    onScroll?: UIEventHandler<HTMLDivElement>

    OptionalonScrollCapture

    onScrollCapture?: UIEventHandler<HTMLDivElement>

    OptionalonSeeked

    onSeeked?: ReactEventHandler<HTMLDivElement>

    OptionalonSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonSeeking

    onSeeking?: ReactEventHandler<HTMLDivElement>

    OptionalonSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonSelect

    onSelect?: ReactEventHandler<HTMLDivElement>

    OptionalonSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonStalled

    onStalled?: ReactEventHandler<HTMLDivElement>

    OptionalonStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonSubmit

    onSubmit?: FormEventHandler<HTMLDivElement>

    OptionalonSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLDivElement>

    OptionalonSuspend

    onSuspend?: ReactEventHandler<HTMLDivElement>

    OptionalonSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLDivElement>

    OptionalonTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchMove

    onTouchMove?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchStart

    onTouchStart?: TouchEventHandler<HTMLDivElement>

    OptionalonTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>

    OptionalonTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>

    OptionalonTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>

    OptionalonVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLDivElement>

    OptionalonVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonWaiting

    onWaiting?: ReactEventHandler<HTMLDivElement>

    OptionalonWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLDivElement>

    OptionalonWheel

    onWheel?: WheelEventHandler<HTMLDivElement>

    OptionalonWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLDivElement>

    Optionalprefix

    prefix?: string

    Optionalproperty

    property?: string

    OptionalradioGroup

    radioGroup?: string

    Optionalrel

    rel?: string

    Optionalresource

    resource?: string

    Optionalresults

    results?: number

    Optionalrev

    rev?: string

    Optionalrole

    role?: AriaRole

    Optionalsecurity

    security?: string

    Optionalslot

    slot?: string

    OptionalspellCheck

    spellCheck?: Booleanish

    Optionalstyle

    style?: CSSProperties

    OptionalsuppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    OptionalsuppressHydrationWarning

    suppressHydrationWarning?: boolean

    OptionaltabIndex

    tabIndex?: number

    Optionaltitle

    title?: string

    Optionaltranslate

    translate?: "yes" | "no"

    Optionaltypeof

    typeof?: string

    Optionalunselectable

    unselectable?: "off" | "on"

    Optionalvariant

    variant?:
        | null
        | "default"
        | "outline"
        | "muted"
        | "destructive"
        | "secondary" = ...

    Optionalvocab

    vocab?: string

    Settings

    Member Visibility

    On This Page

    Properties
    aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdraggableenterKeyHinthiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecurityslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypeofunselectablevariantvocab
    diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index 6e414701fc..bdbffd0fca 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

    about? accessKey? aria-activedescendant? aria-atomic? @@ -389,10 +389,10 @@

    Optionalaria-valuenow

    aria-valuenow?: number

    Defines the current value for a range widget.

    See

    aria-valuetext.

    Optionalaria-valuetext

    aria-valuetext?: string

    Defines the human readable text alternative of aria-valuenow for a range widget.

    -

    OptionalasChild

    asChild?: boolean

    OptionalautoCapitalize

    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"

    OptionalautoCorrect

    autoCorrect?: string

    OptionalautoFocus

    autoFocus?: boolean

    OptionalautoSave

    autoSave?: string

    Optionalchildren

    children?: ReactNode

    OptionalclassName

    className?: string

    Optionalcolor

    color?: string

    Optionalcontent

    content?: string

    OptionalcontentEditable

    contentEditable?: "inherit" | Booleanish | "plaintext-only"

    OptionalcontextMenu

    contextMenu?: string

    OptionaldangerouslySetInnerHTML

    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }

    Optionaldatatype

    datatype?: string

    OptionaldefaultChecked

    defaultChecked?: boolean

    OptionaldefaultValue

    defaultValue?: string | number | readonly string[]

    Optionaldir

    dir?: string

    Optionaldisabled

    disabled?: boolean

    Optionaldraggable

    draggable?: Booleanish

    OptionalenterKeyHint

    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"

    Optionalform

    form?: string

    OptionalformAction

    formAction?: string

    OptionalformEncType

    formEncType?: string

    OptionalformMethod

    formMethod?: string

    OptionalformNoValidate

    formNoValidate?: boolean

    OptionalformTarget

    formTarget?: string

    Optionalhidden

    hidden?: boolean

    Optionalid

    id?: string

    Optionalinlist

    inlist?: any

    OptionalinputMode

    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

    +

    OptionalasChild

    asChild?: boolean

    OptionalautoCapitalize

    autoCapitalize?:
        | "none"
        | "off"
        | "on"
        | string & {}
        | "words"
        | "sentences"
        | "characters"

    OptionalautoCorrect

    autoCorrect?: string

    OptionalautoFocus

    autoFocus?: boolean

    OptionalautoSave

    autoSave?: string

    Optionalchildren

    children?: ReactNode

    OptionalclassName

    className?: string

    Optionalcolor

    color?: string

    Optionalcontent

    content?: string

    OptionalcontentEditable

    contentEditable?: "inherit" | Booleanish | "plaintext-only"

    OptionalcontextMenu

    contextMenu?: string

    OptionaldangerouslySetInnerHTML

    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    }

    Optionaldatatype

    datatype?: string

    OptionaldefaultChecked

    defaultChecked?: boolean

    OptionaldefaultValue

    defaultValue?: string | number | readonly string[]

    Optionaldir

    dir?: string

    Optionaldisabled

    disabled?: boolean

    Optionaldraggable

    draggable?: Booleanish

    OptionalenterKeyHint

    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"

    Optionalform

    form?: string

    OptionalformAction

    formAction?: string

    OptionalformEncType

    formEncType?: string

    OptionalformMethod

    formMethod?: string

    OptionalformNoValidate

    formNoValidate?: boolean

    OptionalformTarget

    formTarget?: string

    Optionalhidden

    hidden?: boolean

    Optionalid

    id?: string

    Optionalinlist

    inlist?: any

    OptionalinputMode

    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

    See

    https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    Optionalis

    is?: string

    Specify that a standard HTML element should behave like a defined custom built-in element

    See

    https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    OptionalitemID

    itemID?: string

    OptionalitemProp

    itemProp?: string

    OptionalitemRef

    itemRef?: string

    OptionalitemScope

    itemScope?: boolean

    OptionalitemType

    itemType?: string

    Optionallang

    lang?: string

    Optionalname

    name?: string

    Optionalnonce

    nonce?: string

    OptionalonAbort

    onAbort?: ReactEventHandler<HTMLButtonElement>

    OptionalonAbortCapture

    onAbortCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonAnimationEnd

    onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationEndCapture

    onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationIteration

    onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationIterationCapture

    onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationStart

    onAnimationStart?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAnimationStartCapture

    onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>

    OptionalonAuxClick

    onAuxClick?: MouseEventHandler<HTMLButtonElement>

    OptionalonAuxClickCapture

    onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonBeforeInput

    onBeforeInput?: FormEventHandler<HTMLButtonElement>

    OptionalonBeforeInputCapture

    onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonBlur

    onBlur?: FocusEventHandler<HTMLButtonElement>

    OptionalonBlurCapture

    onBlurCapture?: FocusEventHandler<HTMLButtonElement>

    OptionalonCanPlay

    onCanPlay?: ReactEventHandler<HTMLButtonElement>

    OptionalonCanPlayCapture

    onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonCanPlayThrough

    onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>

    OptionalonCanPlayThroughCapture

    onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonChange

    onChange?: FormEventHandler<HTMLButtonElement>

    OptionalonChangeCapture

    onChangeCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonClick

    onClick?: MouseEventHandler<HTMLButtonElement>

    OptionalonClickCapture

    onClickCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonCompositionEnd

    onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionEndCapture

    onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionStart

    onCompositionStart?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionStartCapture

    onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionUpdate

    onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>

    OptionalonCompositionUpdateCapture

    onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>

    OptionalonContextMenu

    onContextMenu?: MouseEventHandler<HTMLButtonElement>

    OptionalonContextMenuCapture

    onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonCopy

    onCopy?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonCopyCapture

    onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonCut

    onCut?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonCutCapture

    onCutCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonDoubleClick

    onDoubleClick?: MouseEventHandler<HTMLButtonElement>

    OptionalonDoubleClickCapture

    onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonDrag

    onDrag?: DragEventHandler<HTMLButtonElement>

    OptionalonDragCapture

    onDragCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEnd

    onDragEnd?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEndCapture

    onDragEndCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEnter

    onDragEnter?: DragEventHandler<HTMLButtonElement>

    OptionalonDragEnterCapture

    onDragEnterCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragExit

    onDragExit?: DragEventHandler<HTMLButtonElement>

    OptionalonDragExitCapture

    onDragExitCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragLeave

    onDragLeave?: DragEventHandler<HTMLButtonElement>

    OptionalonDragLeaveCapture

    onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragOver

    onDragOver?: DragEventHandler<HTMLButtonElement>

    OptionalonDragOverCapture

    onDragOverCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDragStart

    onDragStart?: DragEventHandler<HTMLButtonElement>

    OptionalonDragStartCapture

    onDragStartCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDrop

    onDrop?: DragEventHandler<HTMLButtonElement>

    OptionalonDropCapture

    onDropCapture?: DragEventHandler<HTMLButtonElement>

    OptionalonDurationChange

    onDurationChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonDurationChangeCapture

    onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonEmptied

    onEmptied?: ReactEventHandler<HTMLButtonElement>

    OptionalonEmptiedCapture

    onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonEncrypted

    onEncrypted?: ReactEventHandler<HTMLButtonElement>

    OptionalonEncryptedCapture

    onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonEnded

    onEnded?: ReactEventHandler<HTMLButtonElement>

    OptionalonEndedCapture

    onEndedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonError

    onError?: ReactEventHandler<HTMLButtonElement>

    OptionalonErrorCapture

    onErrorCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonFocus

    onFocus?: FocusEventHandler<HTMLButtonElement>

    OptionalonFocusCapture

    onFocusCapture?: FocusEventHandler<HTMLButtonElement>

    OptionalonGotPointerCapture

    onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonGotPointerCaptureCapture

    onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonInput

    onInput?: FormEventHandler<HTMLButtonElement>

    OptionalonInputCapture

    onInputCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonInvalid

    onInvalid?: FormEventHandler<HTMLButtonElement>

    OptionalonInvalidCapture

    onInvalidCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonKeyDown

    onKeyDown?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyDownCapture

    onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyPress

    onKeyPress?: KeyboardEventHandler<HTMLButtonElement>

    Deprecated

    Use onKeyUp or onKeyDown instead

    OptionalonKeyPressCapture

    onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>

    Deprecated

    Use onKeyUpCapture or onKeyDownCapture instead

    -

    OptionalonKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonLoad

    onLoad?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedData

    onLoadedData?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStart

    onLoadStart?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonMouseDown

    onMouseDown?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMove

    onMouseMove?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOut

    onMouseOut?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOver

    onMouseOver?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUp

    onMouseUp?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonPaste

    onPaste?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPause

    onPause?: ReactEventHandler<HTMLButtonElement>

    OptionalonPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlay

    onPlay?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlaying

    onPlaying?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDown

    onPointerDown?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMove

    onPointerMove?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOut

    onPointerOut?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOver

    onPointerOver?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUp

    onPointerUp?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonProgress

    onProgress?: ReactEventHandler<HTMLButtonElement>

    OptionalonProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChange

    onRateChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonReset

    onReset?: FormEventHandler<HTMLButtonElement>

    OptionalonResetCapture

    onResetCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonResize

    onResize?: ReactEventHandler<HTMLButtonElement>

    OptionalonResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonScroll

    onScroll?: UIEventHandler<HTMLButtonElement>

    OptionalonScrollCapture

    onScrollCapture?: UIEventHandler<HTMLButtonElement>

    OptionalonSeeked

    onSeeked?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeeking

    onSeeking?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelect

    onSelect?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalled

    onStalled?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSubmit

    onSubmit?: FormEventHandler<HTMLButtonElement>

    OptionalonSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonSuspend

    onSuspend?: ReactEventHandler<HTMLButtonElement>

    OptionalonSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMove

    onTouchMove?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStart

    onTouchStart?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

    OptionalonTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

    OptionalonVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaiting

    onWaiting?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWheel

    onWheel?: WheelEventHandler<HTMLButtonElement>

    OptionalonWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLButtonElement>

    Optionalprefix

    prefix?: string

    Optionalproperty

    property?: string

    OptionalradioGroup

    radioGroup?: string

    Optionalrel

    rel?: string

    Optionalresource

    resource?: string

    Optionalresults

    results?: number

    Optionalrev

    rev?: string

    Optionalrole

    role?: AriaRole

    Optionalsecurity

    security?: string

    Optionalsize

    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...

    Optionalslot

    slot?: string

    OptionalspellCheck

    spellCheck?: Booleanish

    Optionalstyle

    style?: CSSProperties

    OptionalsuppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    OptionalsuppressHydrationWarning

    suppressHydrationWarning?: boolean

    OptionaltabIndex

    tabIndex?: number

    Optionaltitle

    title?: string

    Optionaltranslate

    translate?: "yes" | "no"

    Optionaltype

    type?: "button" | "reset" | "submit"

    Optionaltypeof

    typeof?: string

    Optionalunselectable

    unselectable?: "off" | "on"

    Optionalvalue

    value?: string | number | readonly string[]

    Optionalvariant

    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...

    Optionalvocab

    vocab?: string

    Settings

    Member Visibility

    On This Page

    Properties
    aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasChildautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdisableddraggableenterKeyHintformformActionformEncTypeformMethodformNoValidateformTargethiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnamenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecuritysizeslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypetypeofunselectablevaluevariantvocab
    +

    OptionalonKeyUp

    onKeyUp?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonKeyUpCapture

    onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>

    OptionalonLoad

    onLoad?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadCapture

    onLoadCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedData

    onLoadedData?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedDataCapture

    onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadata

    onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadedMetadataCapture

    onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStart

    onLoadStart?: ReactEventHandler<HTMLButtonElement>

    OptionalonLoadStartCapture

    onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonLostPointerCapture

    onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonLostPointerCaptureCapture

    onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonMouseDown

    onMouseDown?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseDownCapture

    onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseEnter

    onMouseEnter?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseLeave

    onMouseLeave?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMove

    onMouseMove?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseMoveCapture

    onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOut

    onMouseOut?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOutCapture

    onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOver

    onMouseOver?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseOverCapture

    onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUp

    onMouseUp?: MouseEventHandler<HTMLButtonElement>

    OptionalonMouseUpCapture

    onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>

    OptionalonPaste

    onPaste?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPasteCapture

    onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>

    OptionalonPause

    onPause?: ReactEventHandler<HTMLButtonElement>

    OptionalonPauseCapture

    onPauseCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlay

    onPlay?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayCapture

    onPlayCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlaying

    onPlaying?: ReactEventHandler<HTMLButtonElement>

    OptionalonPlayingCapture

    onPlayingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonPointerCancel

    onPointerCancel?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerCancelCapture

    onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDown

    onPointerDown?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerDownCapture

    onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerEnter

    onPointerEnter?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerLeave

    onPointerLeave?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMove

    onPointerMove?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerMoveCapture

    onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOut

    onPointerOut?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOutCapture

    onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOver

    onPointerOver?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerOverCapture

    onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUp

    onPointerUp?: PointerEventHandler<HTMLButtonElement>

    OptionalonPointerUpCapture

    onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>

    OptionalonProgress

    onProgress?: ReactEventHandler<HTMLButtonElement>

    OptionalonProgressCapture

    onProgressCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChange

    onRateChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonRateChangeCapture

    onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonReset

    onReset?: FormEventHandler<HTMLButtonElement>

    OptionalonResetCapture

    onResetCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonResize

    onResize?: ReactEventHandler<HTMLButtonElement>

    OptionalonResizeCapture

    onResizeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonScroll

    onScroll?: UIEventHandler<HTMLButtonElement>

    OptionalonScrollCapture

    onScrollCapture?: UIEventHandler<HTMLButtonElement>

    OptionalonSeeked

    onSeeked?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekedCapture

    onSeekedCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeeking

    onSeeking?: ReactEventHandler<HTMLButtonElement>

    OptionalonSeekingCapture

    onSeekingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelect

    onSelect?: ReactEventHandler<HTMLButtonElement>

    OptionalonSelectCapture

    onSelectCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalled

    onStalled?: ReactEventHandler<HTMLButtonElement>

    OptionalonStalledCapture

    onStalledCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonSubmit

    onSubmit?: FormEventHandler<HTMLButtonElement>

    OptionalonSubmitCapture

    onSubmitCapture?: FormEventHandler<HTMLButtonElement>

    OptionalonSuspend

    onSuspend?: ReactEventHandler<HTMLButtonElement>

    OptionalonSuspendCapture

    onSuspendCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdate

    onTimeUpdate?: ReactEventHandler<HTMLButtonElement>

    OptionalonTimeUpdateCapture

    onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonTouchCancel

    onTouchCancel?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchCancelCapture

    onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEnd

    onTouchEnd?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchEndCapture

    onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMove

    onTouchMove?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchMoveCapture

    onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStart

    onTouchStart?: TouchEventHandler<HTMLButtonElement>

    OptionalonTouchStartCapture

    onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>

    OptionalonTransitionEnd

    onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>

    OptionalonTransitionEndCapture

    onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>

    OptionalonVolumeChange

    onVolumeChange?: ReactEventHandler<HTMLButtonElement>

    OptionalonVolumeChangeCapture

    onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaiting

    onWaiting?: ReactEventHandler<HTMLButtonElement>

    OptionalonWaitingCapture

    onWaitingCapture?: ReactEventHandler<HTMLButtonElement>

    OptionalonWheel

    onWheel?: WheelEventHandler<HTMLButtonElement>

    OptionalonWheelCapture

    onWheelCapture?: WheelEventHandler<HTMLButtonElement>

    Optionalprefix

    prefix?: string

    Optionalproperty

    property?: string

    OptionalradioGroup

    radioGroup?: string

    Optionalrel

    rel?: string

    Optionalresource

    resource?: string

    Optionalresults

    results?: number

    Optionalrev

    rev?: string

    Optionalrole

    role?: AriaRole

    Optionalsecurity

    security?: string

    Optionalsize

    size?:
        | null
        | "default"
        | "icon"
        | "sm"
        | "lg" = ...

    Optionalslot

    slot?: string

    OptionalspellCheck

    spellCheck?: Booleanish

    Optionalstyle

    style?: CSSProperties

    OptionalsuppressContentEditableWarning

    suppressContentEditableWarning?: boolean

    OptionalsuppressHydrationWarning

    suppressHydrationWarning?: boolean

    OptionaltabIndex

    tabIndex?: number

    Optionaltitle

    title?: string

    Optionaltranslate

    translate?: "yes" | "no"

    Optionaltype

    type?: "button" | "reset" | "submit"

    Optionaltypeof

    typeof?: string

    Optionalunselectable

    unselectable?: "off" | "on"

    Optionalvalue

    value?: string | number | readonly string[]

    Optionalvariant

    variant?:
        | null
        | "link"
        | "default"
        | "outline"
        | "destructive"
        | "secondary"
        | "ghost" = ...

    Optionalvocab

    vocab?: string

    Settings

    Member Visibility

    On This Page

    Properties
    aboutaccessKeyaria-activedescendantaria-atomicaria-autocompletearia-braillelabelaria-brailleroledescriptionaria-busyaria-checkedaria-colcountaria-colindexaria-colindextextaria-colspanaria-controlsaria-currentaria-describedbyaria-descriptionaria-detailsaria-disabledaria-dropeffectaria-errormessagearia-expandedaria-flowtoaria-grabbedaria-haspopuparia-hiddenaria-invalidaria-keyshortcutsaria-labelaria-labelledbyaria-levelaria-livearia-modalaria-multilinearia-multiselectablearia-orientationaria-ownsaria-placeholderaria-posinsetaria-pressedaria-readonlyaria-relevantaria-requiredaria-roledescriptionaria-rowcountaria-rowindexaria-rowindextextaria-rowspanaria-selectedaria-setsizearia-sortaria-valuemaxaria-valueminaria-valuenowaria-valuetextasChildautoCapitalizeautoCorrectautoFocusautoSavechildrenclassNamecolorcontentcontentEditablecontextMenudangerouslySetInnerHTMLdatatypedefaultCheckeddefaultValuedirdisableddraggableenterKeyHintformformActionformEncTypeformMethodformNoValidateformTargethiddenidinlistinputModeisitemIDitemPropitemRefitemScopeitemTypelangnamenonceonAbortonAbortCaptureonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonBeforeInputonBeforeInputCaptureonBluronBlurCaptureonCanPlayonCanPlayCaptureonCanPlayThroughonCanPlayThroughCaptureonChangeonChangeCaptureonClickonClickCaptureonCompositionEndonCompositionEndCaptureonCompositionStartonCompositionStartCaptureonCompositionUpdateonCompositionUpdateCaptureonContextMenuonContextMenuCaptureonCopyonCopyCaptureonCutonCutCaptureonDoubleClickonDoubleClickCaptureonDragonDragCaptureonDragEndonDragEndCaptureonDragEnteronDragEnterCaptureonDragExitonDragExitCaptureonDragLeaveonDragLeaveCaptureonDragOveronDragOverCaptureonDragStartonDragStartCaptureonDroponDropCaptureonDurationChangeonDurationChangeCaptureonEmptiedonEmptiedCaptureonEncryptedonEncryptedCaptureonEndedonEndedCaptureonErroronErrorCaptureonFocusonFocusCaptureonGotPointerCaptureonGotPointerCaptureCaptureonInputonInputCaptureonInvalidonInvalidCaptureonKeyDownonKeyDownCaptureonKeyPressonKeyPressCaptureonKeyUponKeyUpCaptureonLoadonLoadCaptureonLoadedDataonLoadedDataCaptureonLoadedMetadataonLoadedMetadataCaptureonLoadStartonLoadStartCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPasteonPasteCaptureonPauseonPauseCaptureonPlayonPlayCaptureonPlayingonPlayingCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonProgressonProgressCaptureonRateChangeonRateChangeCaptureonResetonResetCaptureonResizeonResizeCaptureonScrollonScrollCaptureonSeekedonSeekedCaptureonSeekingonSeekingCaptureonSelectonSelectCaptureonStalledonStalledCaptureonSubmitonSubmitCaptureonSuspendonSuspendCaptureonTimeUpdateonTimeUpdateCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionEndonTransitionEndCaptureonVolumeChangeonVolumeChangeCaptureonWaitingonWaitingCaptureonWheelonWheelCaptureprefixpropertyradioGrouprelresourceresultsrevrolesecuritysizeslotspellCheckstylesuppressContentEditableWarningsuppressHydrationWarningtabIndextitletranslatetypetypeofunselectablevaluevariantvocab
    diff --git a/platform-bible-react/interfaces/CommandHandler.html b/platform-bible-react/interfaces/CommandHandler.html index 96ce566fb3..ea013dfe8a 100644 --- a/platform-bible-react/interfaces/CommandHandler.html +++ b/platform-bible-react/interfaces/CommandHandler.html @@ -1 +1 @@ -CommandHandler | platform-bible-react

    InterfaceCommandHandler

    Settings

    Member Visibility
    +CommandHandler | platform-bible-react

    InterfaceCommandHandler

    Settings

    Member Visibility
    diff --git a/platform-bible-react/interfaces/MultiColumnMenuProvider.html b/platform-bible-react/interfaces/MultiColumnMenuProvider.html index 6643b8a243..58f1fcdcc8 100644 --- a/platform-bible-react/interfaces/MultiColumnMenuProvider.html +++ b/platform-bible-react/interfaces/MultiColumnMenuProvider.html @@ -1 +1 @@ -MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • MultiColumnMenuProvider(isSupportAndDevelopment): 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;
          })[];
      }>

    • 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;
          })[];
      }>

    Settings

    Member Visibility
    +MultiColumnMenuProvider | platform-bible-react

    InterfaceMultiColumnMenuProvider

    • MultiColumnMenuProvider(isSupportAndDevelopment): 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;
          })[];
      }>

    • 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;
          })[];
      }>

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/BookSelectorLocalizedStrings.html b/platform-bible-react/types/BookSelectorLocalizedStrings.html index f27c30f10b..27329fb15c 100644 --- a/platform-bible-react/types/BookSelectorLocalizedStrings.html +++ b/platform-bible-react/types/BookSelectorLocalizedStrings.html @@ -1 +1 @@ -BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedInventoryKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    +BookSelectorLocalizedStrings | platform-bible-react

    Type AliasBookSelectorLocalizedStrings

    BookSelectorLocalizedStrings: {
        [localizedInventoryKey in typeof BOOK_SELECTOR_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ChapterRangeSelectorProps.html b/platform-bible-react/types/ChapterRangeSelectorProps.html index 05472e5153..4edb7bd734 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;
    }

    Settings

    Member Visibility
    +ChapterRangeSelectorProps | platform-bible-react

    Type AliasChapterRangeSelectorProps

    ChapterRangeSelectorProps: {
        chapterCount: number;
        endChapter: number;
        handleSelectEndChapter: ((chapter: number) => void);
        handleSelectStartChapter: ((chapter: number) => void);
        isDisabled?: boolean;
        startChapter: number;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ChecklistProps.html b/platform-bible-react/types/ChecklistProps.html index 666d7f367a..01afd5de39 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ColumnDef.html b/platform-bible-react/types/ColumnDef.html index e218ab4238..fe11fab935 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

    Settings

    Member Visibility
    +ColumnDef | platform-bible-react

    Type AliasColumnDef<TData, TValue>

    ColumnDef<TData, TValue>: TSColumnDef<TData, TValue>

    Type Parameters

    • TData
    • TValue = unknown

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ComboBoxLabelOption.html b/platform-bible-react/types/ComboBoxLabelOption.html index c44fc4b3d2..d5bce58018 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;
    }

    Settings

    Member Visibility
    +ComboBoxLabelOption | platform-bible-react

    Type AliasComboBoxLabelOption

    ComboBoxLabelOption: {
        label: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ComboBoxOption.html b/platform-bible-react/types/ComboBoxOption.html index b79cb009ce..9512729816 100644 --- a/platform-bible-react/types/ComboBoxOption.html +++ b/platform-bible-react/types/ComboBoxOption.html @@ -1 +1 @@ -ComboBoxOption | platform-bible-react

    Type AliasComboBoxOption

    ComboBoxOption: string | number | ComboBoxLabelOption

    Settings

    Member Visibility
    +ComboBoxOption | platform-bible-react

    Type AliasComboBoxOption

    ComboBoxOption: string | number | ComboBoxLabelOption

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ComboBoxProps.html b/platform-bible-react/types/ComboBoxProps.html index cf687dfcc8..ac22a56fc7 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -15,4 +15,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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownGroup.html b/platform-bible-react/types/DropdownGroup.html index c0fea782e5..8d493ab5b2 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownItem.html b/platform-bible-react/types/DropdownItem.html index b6f3b675cc..1b8ca232a2 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

    Settings

    Member Visibility
    +
      • (): void

      • Returns void

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuCheckboxItemProps.html b/platform-bible-react/types/DropdownMenuCheckboxItemProps.html index 6f50f9ced0..cc95a49f5d 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;
    }

    Settings

    Member Visibility
    +DropdownMenuCheckboxItemProps | platform-bible-react

    Type AliasDropdownMenuCheckboxItemProps

    DropdownMenuCheckboxItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.CheckboxItem> & {
        checked?: boolean;
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuContentProps.html b/platform-bible-react/types/DropdownMenuContentProps.html index 858572cf2f..dd398116d9 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;
    }

    Settings

    Member Visibility
    +DropdownMenuContentProps | platform-bible-react

    Type AliasDropdownMenuContentProps

    DropdownMenuContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Content> & {
        className?: string;
        sideOffset?: number;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuItemProps.html b/platform-bible-react/types/DropdownMenuItemProps.html index b38ffdd788..194aa9704f 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;
    }

    Settings

    Member Visibility
    +DropdownMenuItemProps | platform-bible-react

    Type AliasDropdownMenuItemProps

    DropdownMenuItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Item> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuLabelProps.html b/platform-bible-react/types/DropdownMenuLabelProps.html index 1e84497162..12368673e9 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;
    }

    Settings

    Member Visibility
    +DropdownMenuLabelProps | platform-bible-react

    Type AliasDropdownMenuLabelProps

    DropdownMenuLabelProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Label> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuRadioItemProps.html b/platform-bible-react/types/DropdownMenuRadioItemProps.html index 396176555b..ba7016f996 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;
    }

    Settings

    Member Visibility
    +DropdownMenuRadioItemProps | platform-bible-react

    Type AliasDropdownMenuRadioItemProps

    DropdownMenuRadioItemProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.RadioItem> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuSeparatorProps.html b/platform-bible-react/types/DropdownMenuSeparatorProps.html index eb6e9f2aac..8d8ef73d69 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;
    }

    Settings

    Member Visibility
    +DropdownMenuSeparatorProps | platform-bible-react

    Type AliasDropdownMenuSeparatorProps

    DropdownMenuSeparatorProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.Separator> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuShortcutProps.html b/platform-bible-react/types/DropdownMenuShortcutProps.html index 1614119068..d1bde4aa95 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;
    }

    Settings

    Member Visibility
    +DropdownMenuShortcutProps | platform-bible-react

    Type AliasDropdownMenuShortcutProps

    DropdownMenuShortcutProps: React.HTMLAttributes<HTMLSpanElement> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuSubContentProps.html b/platform-bible-react/types/DropdownMenuSubContentProps.html index a0eb85ded3..e2e0778a66 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;
    }

    Settings

    Member Visibility
    +DropdownMenuSubContentProps | platform-bible-react

    Type AliasDropdownMenuSubContentProps

    DropdownMenuSubContentProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubContent> & {
        className?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/DropdownMenuSubTriggerProps.html b/platform-bible-react/types/DropdownMenuSubTriggerProps.html index 18869bed57..1e53663d36 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;
    }

    Settings

    Member Visibility
    +DropdownMenuSubTriggerProps | platform-bible-react

    Type AliasDropdownMenuSubTriggerProps

    DropdownMenuSubTriggerProps: React.ComponentPropsWithoutRef<typeof DropdownMenuPrimitive.SubTrigger> & {
        className?: string;
        inset?: boolean;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/GridMenuInfo.html b/platform-bible-react/types/GridMenuInfo.html index 21a62dd339..3e45c9dd5d 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/GridMenuProps.html b/platform-bible-react/types/GridMenuProps.html index 0559476f57..83e70b750a 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/IconButtonProps.html b/platform-bible-react/types/IconButtonProps.html index 2cfb9e456d..6325179efd 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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/InventoryItemOccurrence.html b/platform-bible-react/types/InventoryItemOccurrence.html index f319e8da86..bd5966b5b1 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/InventoryLocalizedStrings.html b/platform-bible-react/types/InventoryLocalizedStrings.html index 4eb1933c2e..8bd206b3cb 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
    }

    Settings

    Member Visibility
    +InventoryLocalizedStrings | platform-bible-react

    Type AliasInventoryLocalizedStrings

    InventoryLocalizedStrings: {
        [localizedInventoryKey in typeof INVENTORY_STRING_KEYS[number]]?: LocalizedStringValue
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/InventoryTableData.html b/platform-bible-react/types/InventoryTableData.html index d7c79e7787..37f9b69b62 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)

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/MenuItemListProps.html b/platform-bible-react/types/MenuItemListProps.html index 311f3d0f03..a7c1581ea6 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ProjectInfo.html b/platform-bible-react/types/ProjectInfo.html index 2f1355f848..0a18945644 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;
    }

    Settings

    Member Visibility
    +ProjectInfo | platform-bible-react

    Type AliasProjectInfo

    ProjectInfo: {
        projectId: string;
        projectName: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index 4a692599b1..489417719e 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ResultsSource.html b/platform-bible-react/types/ResultsSource.html index 19adda9ed4..941a7f5567 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/RowContents.html b/platform-bible-react/types/RowContents.html index 25d868274f..67dcc3ffb9 100644 --- a/platform-bible-react/types/RowContents.html +++ b/platform-bible-react/types/RowContents.html @@ -1 +1 @@ -RowContents | platform-bible-react

    Type AliasRowContents<TData>

    RowContents<TData>: TSRow<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    +RowContents | platform-bible-react

    Type AliasRowContents<TData>

    RowContents<TData>: TSRow<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/Scope.html b/platform-bible-react/types/Scope.html index 92425d3f8a..4b65781528 100644 --- a/platform-bible-react/types/Scope.html +++ b/platform-bible-react/types/Scope.html @@ -1,2 +1,2 @@ Scope | platform-bible-react

    Type AliasScope

    Scope: "book" | "chapter" | "verse"

    Scope of scripture that the inventory can operate on

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureItemDetail.html b/platform-bible-react/types/ScriptureItemDetail.html index f2d7eaaa82..09ee04d1db 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html b/platform-bible-react/types/ScriptureResultsViewerColumnInfo.html index ed31be2b7b..3cacb1ab1f 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'.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureResultsViewerProps.html b/platform-bible-react/types/ScriptureResultsViewerProps.html index 05370a1711..7eb21badec 100644 --- a/platform-bible-react/types/ScriptureResultsViewerProps.html +++ b/platform-bible-react/types/ScriptureResultsViewerProps.html @@ -3,4 +3,4 @@
  • OptionalshowColumnHeaders?: boolean

    Flag indicating whether to display column headers. Default is false.

  • OptionalshowSourceColumn?: boolean

    Flag indicating whether to display source column. Default is false.

  • sources: ResultsSet[]

    Groups of ScriptureItemDetail objects from particular sources (e.g., Scripture checks)

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScriptureSrcItemDetail.html b/platform-bible-react/types/ScriptureSrcItemDetail.html index 292011dbc0..ba40357868 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ScrollGroupSelectorProps.html b/platform-bible-react/types/ScrollGroupSelectorProps.html index bca263a920..c4e7cf2ba4 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SearchBarProps.html b/platform-bible-react/types/SearchBarProps.html index d275ab5794..0d5fc83694 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SelectedSettingsSidebarItem.html b/platform-bible-react/types/SelectedSettingsSidebarItem.html index 2758dc62c7..4edcd37a32 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;
    }

    Settings

    Member Visibility
    +SelectedSettingsSidebarItem | platform-bible-react

    Type AliasSelectedSettingsSidebarItem

    SelectedSettingsSidebarItem: {
        label: string;
        projectId?: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SettingsSidebarProps.html b/platform-bible-react/types/SettingsSidebarProps.html index 48b72d9e6a..6f9f90f1ad 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SortDirection.html b/platform-bible-react/types/SortDirection.html index 6b65ae9277..4865a0b2d3 100644 --- a/platform-bible-react/types/SortDirection.html +++ b/platform-bible-react/types/SortDirection.html @@ -1 +1 @@ -SortDirection | platform-bible-react

    Type AliasSortDirection

    SortDirection: TSSortDirection

    Settings

    Member Visibility
    +SortDirection | platform-bible-react

    Type AliasSortDirection

    SortDirection: TSSortDirection

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/SpinnerProps.html b/platform-bible-react/types/SpinnerProps.html index 90a1aa0786..96ac4c4539 100644 --- a/platform-bible-react/types/SpinnerProps.html +++ b/platform-bible-react/types/SpinnerProps.html @@ -1 +1 @@ -SpinnerProps | platform-bible-react

    Type AliasSpinnerProps

    SpinnerProps: LucideProps

    Settings

    Member Visibility
    +SpinnerProps | platform-bible-react

    Type AliasSpinnerProps

    SpinnerProps: LucideProps

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/TabKeyValueContent.html b/platform-bible-react/types/TabKeyValueContent.html index 9bd15a6c81..570bc36914 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;
    }

    Settings

    Member Visibility
    +TabKeyValueContent | platform-bible-react

    Type AliasTabKeyValueContent

    TabKeyValueContent: {
        content: ReactNode;
        key: string;
        value: string;
    }

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/TableContents.html b/platform-bible-react/types/TableContents.html index 524156d344..a15be8b350 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

    Settings

    Member Visibility
    +TableContents | platform-bible-react

    Type AliasTableContents<TData>

    TableContents<TData>: TSTable<TData>

    Type Parameters

    • TData

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/TextFieldProps.html b/platform-bible-react/types/TextFieldProps.html index c4a26356d5..b265cb47ae 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/ToolbarProps.html b/platform-bible-react/types/ToolbarProps.html index dce1386e7e..87a94c0a27 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.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/UsePromiseOptions.html b/platform-bible-react/types/UsePromiseOptions.html index cf847567e3..48cb5b87a9 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/VersionHistoryType.html b/platform-bible-react/types/VersionHistoryType.html index 9444f3d754..38da7fe622 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/types/VersionInformation.html b/platform-bible-react/types/VersionInformation.html index c0665f5196..5aa41367c8 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html b/platform-bible-react/variables/BOOK_SELECTOR_STRING_KEYS.html index 15746af182..4652aa1e66 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-react/variables/INVENTORY_STRING_KEYS.html b/platform-bible-react/variables/INVENTORY_STRING_KEYS.html index 2c87eed334..59ed85be94 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/classes/AsyncVariable.html b/platform-bible-utils/classes/AsyncVariable.html index 9e704c10ed..d3f5f7cd7e 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

    constructor +

    Type Parameters

    • T

    Constructors

    constructor

    Accessors

    hasSettled promise

    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

    hasSettled

    • get hasSettled(): boolean

    • A simple way to see if this variable's promise was resolved or rejected already

      +

    Returns AsyncVariable<T>

    Accessors

    hasSettled

    promise

    promise

    • 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

    rejectWithReason

    Methods

    rejectWithReason

    • rejectWithReason(reason, throwIfAlreadySettled?): void

    • 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

    resolveToValue

    • resolveToValue(value, throwIfAlreadySettled?): void

    • Resolve this variable's promise to the given value

      +

    Returns void

    resolveToValue

    • resolveToValue(value, throwIfAlreadySettled?): 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/platform-bible-utils/classes/Collator.html b/platform-bible-utils/classes/Collator.html index a659a4de93..53cdcea8b4 100644 --- a/platform-bible-utils/classes/Collator.html +++ b/platform-bible-utils/classes/Collator.html @@ -1,14 +1,14 @@ Collator | platform-bible-utils

    ClassCollator

    Enables language-sensitive string comparison. Wraps Intl.Collator

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    compare resolvedOptions -

    Constructors

    constructor

    Methods

    compare

    • compare(string1, string2): number

    • Compares two strings according to the sort order of this Collator object

      +

    Constructors

    constructor

    Methods

    compare

    • compare(string1, string2): number

    • 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.

      -

    resolvedOptions

    resolvedOptions

    • resolvedOptions(): ResolvedCollatorOptions

    • Returns a new object with properties reflecting the locale and collation options computed during initialization of this collator object.

      Returns ResolvedCollatorOptions

      ResolvedCollatorOptions object

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/DateTimeFormat.html b/platform-bible-utils/classes/DateTimeFormat.html index 284df207f1..df6bf65611 100644 --- a/platform-bible-utils/classes/DateTimeFormat.html +++ b/platform-bible-utils/classes/DateTimeFormat.html @@ -1,29 +1,29 @@ DateTimeFormat | platform-bible-utils

    ClassDateTimeFormat

    Enables language-sensitive data and time formatting. Wraps Intl.DateTimeFormat

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    format formatRange formatRangeToParts formatToParts resolvedOptions -

    Constructors

    constructor

    Methods

    format

    • format(date): string

    • Formats a date according to the locale and formatting option for this DateTimeFormat object

      +

    Constructors

    constructor

    Methods

    format

    • format(date): string

    • 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

      -

    formatRange

    formatRange

    • formatRange(startDate, endDate): string

    • 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

      -

    formatRangeToParts

    formatRangeToParts

    • formatRangeToParts(startDate, endDate): DateTimeRangeFormatPart[]

    • 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

      -

    formatToParts

    formatToParts

    • formatToParts(date): DateTimeFormatPart[]

    • Allows locale-aware formatting of strings produced by this DateTimeFormat object

      Parameters

      • date: Date

        The date to format

      Returns DateTimeFormatPart[]

      Array of DateTimeFormatPart objects

      -

    resolvedOptions

    resolvedOptions

    • resolvedOptions(): ResolvedDateTimeFormatOptions

    • 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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/DocumentCombiner.html b/platform-bible-utils/classes/DocumentCombiner.html index 6c859082cf..74cde8e87b 100644 --- a/platform-bible-utils/classes/DocumentCombiner.html +++ b/platform-bible-utils/classes/DocumentCombiner.html @@ -1,6 +1,6 @@ DocumentCombiner | platform-bible-utils

    ClassDocumentCombiner

    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

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -20,8 +20,8 @@

    Constructors

    Protectedconstructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

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

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      +

    Returns DocumentCombiner

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

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

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties 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

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    rebuild

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    • transformBaseDocumentAfterValidation(baseDocument): JsonDocumentLike

    • 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

      -

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    • transformContributionAfterValidation(documentName, document): JsonDocumentLike

    • 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

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    • transformFinalOutputBeforeValidation(finalOutput): JsonDocumentLike

    • 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

    updateBaseDocument

    • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    • validateContribution(documentName, document): void

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    ProtectedvalidateContribution

    • validateContribution(documentName, document): 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

    ProtectedvalidateOutput

    • validateOutput(output): void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/platform-bible-utils/classes/Mutex.html b/platform-bible-utils/classes/Mutex.html index 0b5ce20b0e..a440fd5406 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

    constructor +

    Hierarchy

    • Mutex
      • Mutex

    Constructors

    constructor

    Methods

    acquire cancel isLocked diff --git a/platform-bible-utils/classes/MutexMap.html b/platform-bible-utils/classes/MutexMap.html index e5e09d1ecb..fe512d04f6 100644 --- a/platform-bible-utils/classes/MutexMap.html +++ b/platform-bible-utils/classes/MutexMap.html @@ -1,4 +1,4 @@ MutexMap | platform-bible-utils

    ClassMutexMap

    Map of Mutexes that automatically (lazily) generates a new Mutex for any new key

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    get -

    Constructors

    constructor

    Methods

    get

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Constructors

    constructor

    Methods

    get

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/NonValidatingDocumentCombiner.html b/platform-bible-utils/classes/NonValidatingDocumentCombiner.html index 17e4ddcf55..26f084035e 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

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    baseDocument contributions latestOutput @@ -18,8 +18,8 @@ validateBaseDocument validateContribution validateOutput -

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

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

    -

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Accessors

    output

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      +

    Constructors

    constructor

    Properties

    ProtectedbaseDocument

    baseDocument: JsonDocumentLike

    Protected Readonlycontributions

    contributions: Map<string, JsonDocumentLike> = ...

    ProtectedlatestOutput

    latestOutput: undefined | JsonDocumentLike

    ReadonlyonDidRebuild

    onDidRebuild: PlatformEvent<undefined> = ...

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

    +

    Protected Readonlyoptions

    options: DocumentCombinerOptions

    Accessors

    output

    Methods

    addOrUpdateContribution

    • addOrUpdateContribution(documentName, document): undefined | JsonDocumentLike

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

      Note: the order in which contribution documents are added can be considered to be indeterminate as it is currently ordered by however Map.forEach provides the contributions. The order matters when merging two arrays into one. Also, when options.ignoreDuplicateProperties 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

    -

    deleteAllContributions

    deleteAllContributions

    deleteContribution

    deleteContribution

    rebuild

    rebuild

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformBaseDocumentAfterValidation

    ProtectedtransformContributionAfterValidation

    ProtectedtransformContributionAfterValidation

    • transformContributionAfterValidation(documentName, document): JsonDocumentLike

    • 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

    -

    ProtectedtransformFinalOutputBeforeValidation

    ProtectedtransformFinalOutputBeforeValidation

    updateBaseDocument

    • updateBaseDocument(baseDocument): undefined | JsonDocumentLike

    • Update the starting document for composition process

      +

    Returns JsonDocumentLike

    updateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateBaseDocument

    ProtectedvalidateContribution

    • validateContribution(documentName, document): void

    • Throw an error if the provided document is not a valid contribution document.

      +

    Returns void

    ProtectedvalidateContribution

    ProtectedvalidateOutput

    • validateOutput(output): void

    • Throw an error if the provided output is not valid.

      +

    Returns void

    ProtectedvalidateOutput

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/platform-bible-utils/classes/NumberFormat.html b/platform-bible-utils/classes/NumberFormat.html index f5f05ace93..c1685c15b7 100644 --- a/platform-bible-utils/classes/NumberFormat.html +++ b/platform-bible-utils/classes/NumberFormat.html @@ -1,30 +1,30 @@ NumberFormat | platform-bible-utils

    ClassNumberFormat

    Enables language-sensitive number formatting. Wraps Intl.NumberFormat

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    format formatRange formatRangeToParts formatToParts resolvedOptions -

    Constructors

    constructor

    Methods

    format

    • format(value): string

    • Formats a number according to the locale and formatting options of this NumberFormat object

      +

    Constructors

    constructor

    Methods

    format

    • format(value): string

    • 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

      -

    formatRange

    formatRange

    • formatRange(startRange, endRange): string

    • 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

      -

    formatRangeToParts

    formatRangeToParts

    • formatRangeToParts(startRange, endRange): NumberRangeFormatPart[]

    • 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

      -

    formatToParts

    formatToParts

    • formatToParts(value): NumberFormatPart[]

    • 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

      -

    resolvedOptions

    resolvedOptions

    • resolvedOptions(): ResolvedNumberFormatOptions

    • Returns a new object with properties reflecting the locale and number formatting options computed during initialization of this NumberFormat object

      Returns ResolvedNumberFormatOptions

      ResolvedNumberFormatOptions object

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/classes/PlatformEventEmitter.html b/platform-bible-utils/classes/PlatformEventEmitter.html index b019fd94a8..33f4e6b0ec 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

    constructor +

    Type Parameters

    • T

    Implements

    Constructors

    constructor

    Properties

    subscribe

    Accessors

    event

    Methods

    assertNotDisposed @@ -16,16 +16,16 @@

    Returns

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

    Alias

    event

    -

    Accessors

    event

    • get event(): PlatformEvent<T>

    • Event for listeners to subscribe to. Subscribes a function to run when this event is emitted. +

    Accessors

    event

    Methods

    ProtectedassertNotDisposed

    dispose

    ProtecteddisposeFn

    Methods

    ProtectedassertNotDisposed

    dispose

    ProtecteddisposeFn

    emit

    emit

    ProtectedemitFn

    • emitFn(event): void

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

    Returns void

    ProtectedemitFn

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • event: T

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/platform-bible-utils/classes/UnsubscriberAsyncList.html b/platform-bible-utils/classes/UnsubscriberAsyncList.html index 7abd4fe2c3..bf0c57c9ae 100644 --- a/platform-bible-utils/classes/UnsubscriberAsyncList.html +++ b/platform-bible-utils/classes/UnsubscriberAsyncList.html @@ -1,10 +1,10 @@ UnsubscriberAsyncList | platform-bible-utils

    ClassUnsubscriberAsyncList

    Simple collection for UnsubscriberAsync objects that also provides an easy way to run them.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    unsubscribers

    Methods

    add runAllUnsubscribers -

    Constructors

    constructor

    Properties

    Readonlyunsubscribers

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    add

    • add(...unsubscribers): void

    • Add unsubscribers to the list. Note that duplicates are not added twice.

      +

    Constructors

    constructor

    Properties

    Readonlyunsubscribers

    unsubscribers: Set<Unsubscriber | UnsubscriberAsync> = ...

    Methods

    add

    runAllUnsubscribers

    • runAllUnsubscribers(): Promise<boolean>

    • Run all unsubscribers added to this list and then clear the list.

      +

    Returns void

    runAllUnsubscribers

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/platform-bible-utils/classes/UsjReaderWriter.html b/platform-bible-utils/classes/UsjReaderWriter.html index c97e85a689..bfbba572e8 100644 --- a/platform-bible-utils/classes/UsjReaderWriter.html +++ b/platform-bible-utils/classes/UsjReaderWriter.html @@ -1,5 +1,5 @@ UsjReaderWriter | platform-bible-utils

    ClassUsjReaderWriter

    Represents USJ formatted scripture with helpful utilities for working with it

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    extractText extractTextBetweenPoints findNextLocationOfMatchingText @@ -11,15 +11,15 @@ removeContentNodes usjChanged verseRefToUsjContentLocation -

    Constructors

    constructor

    Methods

    extractText

    • extractText(start, desiredLength): string

    • Return a copy of text following a given starting point

      +

    Constructors

    constructor

    Methods

    extractText

    extractTextBetweenPoints

    • extractTextBetweenPoints(start, end, maxLength?): string

    • Return a copy of text between two points

      +

    Returns string

    extractTextBetweenPoints

    findNextLocationOfMatchingText

    findNextLocationOfMatchingText

    • findNextLocationOfMatchingText(startingPoint, text, maxTextLengthToSearch?): undefined | UsjContentLocation

    • 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.

      -

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    • jsonPathToVerseRefAndOffset(jsonPathQuery, bookId?): VerseRefOffset

    • 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

      -

    nodeToJsonPath

    nodeToVerseRefAndOffset

    nodeToJsonPath

    nodeToVerseRefAndOffset

    • nodeToVerseRefAndOffset(bookId, node, nodeParent): undefined | {
          offset: number;
          verseRef: VerseRef;
      }

    • 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

      -

    removeContentNodes

    removeContentNodes

    • removeContentNodes(searchFunction): number

    • 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

      -

    usjChanged

    usjChanged

    verseRefToUsjContentLocation

    verseRefToUsjContentLocation

    • verseRefToUsjContentLocation(verseRef, verseRefOffset?): UsjContentLocation

    • 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.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html b/platform-bible-utils/functions/aggregateUnsubscriberAsyncs.html index 8e89a3697d..f69eff7ac4 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.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/aggregateUnsubscribers.html b/platform-bible-utils/functions/aggregateUnsubscribers.html index 0858739950..deec1dbe27 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.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/at.html b/platform-bible-utils/functions/at.html index cad06d5379..49a4bd9823 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/charAt.html b/platform-bible-utils/functions/charAt.html index 2ea826e37b..8072ace965 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/codePointAt.html b/platform-bible-utils/functions/codePointAt.html index 371b04b7fa..f8c9aa3ecc 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/compareScrRefs.html b/platform-bible-utils/functions/compareScrRefs.html index cc80a28dc0..567e05e306 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/createSyncProxyForAsyncObject.html b/platform-bible-utils/functions/createSyncProxyForAsyncObject.html index c2f3548b24..3688933923 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/debounce.html b/platform-bible-utils/functions/debounce.html index 240742ab89..203787fc56 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/deepClone.html b/platform-bible-utils/functions/deepClone.html index 1b38c79106..ad5208e1d0 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/deepEqual.html b/platform-bible-utils/functions/deepEqual.html index 8df0f2fced..a5fd5c4c7b 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/deserialize.html b/platform-bible-utils/functions/deserialize.html index a15fdc1483..7c5acaa80c 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

    Settings

    Member Visibility
    +

    Returns any

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/endsWith.html b/platform-bible-utils/functions/endsWith.html index 80fbb3a738..2306981108 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/ensureArray.html b/platform-bible-utils/functions/ensureArray.html index 36b978a7cc..fd13beab01 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/escapeStringRegexp.html b/platform-bible-utils/functions/escapeStringRegexp.html index 3342a0e1e8..32ab48f15c 100644 --- a/platform-bible-utils/functions/escapeStringRegexp.html +++ b/platform-bible-utils/functions/escapeStringRegexp.html @@ -6,4 +6,4 @@

    Parameters

    Returns string

    Example

    import escapeStringRegexp from 'platform-bible-utils';

        const escapedString = escapeStringRegexp('How much $ for a 🦄?');
        //=> 'How much \\$ for a 🦄\\?'

        new RegExp(escapedString);
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatBytes.html b/platform-bible-utils/functions/formatBytes.html index d02c40400b..688c735c1d 100644 --- a/platform-bible-utils/functions/formatBytes.html +++ b/platform-bible-utils/functions/formatBytes.html @@ -9,4 +9,4 @@

    Example

    FormatBytes(1024, 0) => "1 KB"
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatReplacementString.html b/platform-bible-utils/functions/formatReplacementString.html index 46535bc7ed..3cdf31c59b 100644 --- a/platform-bible-utils/functions/formatReplacementString.html +++ b/platform-bible-utils/functions/formatReplacementString.html @@ -14,4 +14,4 @@

    Example

    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.'
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatReplacementStringToArray.html b/platform-bible-utils/functions/formatReplacementStringToArray.html index a0165949bc..a763b9abcc 100644 --- a/platform-bible-utils/functions/formatReplacementStringToArray.html +++ b/platform-bible-utils/functions/formatReplacementStringToArray.html @@ -19,4 +19,4 @@

    Example

    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.']
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/formatScrRef.html b/platform-bible-utils/functions/formatScrRef.html index 31d7d2363a..a371f8c1bd 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getAllObjectFunctionNames.html b/platform-bible-utils/functions/getAllObjectFunctionNames.html index afe6b06430..15e67d0169 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getChaptersForBook.html b/platform-bible-utils/functions/getChaptersForBook.html index c5b3091e5a..1fe4ec0a7d 100644 --- a/platform-bible-utils/functions/getChaptersForBook.html +++ b/platform-bible-utils/functions/getChaptersForBook.html @@ -1 +1 @@ -getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    Settings

    Member Visibility
    +getChaptersForBook | platform-bible-utils

    FunctiongetChaptersForBook

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getCurrentLocale.html b/platform-bible-utils/functions/getCurrentLocale.html index 4b0e53364b..47548c5609 100644 --- a/platform-bible-utils/functions/getCurrentLocale.html +++ b/platform-bible-utils/functions/getCurrentLocale.html @@ -1,4 +1,4 @@ getCurrentLocale | platform-bible-utils

    FunctiongetCurrentLocale

    • getCurrentLocale(): string

    • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getErrorMessage.html b/platform-bible-utils/functions/getErrorMessage.html index 4d98383c17..b5fc435e8b 100644 --- a/platform-bible-utils/functions/getErrorMessage.html +++ b/platform-bible-utils/functions/getErrorMessage.html @@ -6,4 +6,4 @@

    Example

    `try {...} catch (e) { logger.info(getErrorMessage(e)) }`
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html index 384479dd54..57e60fe902 100644 --- a/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html +++ b/platform-bible-utils/functions/getLocalizeKeyForScrollGroupId.html @@ -1,2 +1,2 @@ getLocalizeKeyForScrollGroupId | platform-bible-utils

    FunctiongetLocalizeKeyForScrollGroupId

    Settings

    Member Visibility
    +

    Parameters

    Returns LocalizeKey

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html index ac9f93a788..4d0b71ebe2 100644 --- a/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html +++ b/platform-bible-utils/functions/getLocalizeKeysForScrollGroupIds.html @@ -5,4 +5,4 @@

    Example

    getLocalizeKeysForScrollGroupIds([undefined, 0, 1, 2, 3, 4]);
    // Gives localized string keys for the provided scroll group ids in an array
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html index 348e04cb39..a2918f1831 100644 --- a/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html +++ b/platform-bible-utils/functions/getLocalizedIdFromBookNumber.html @@ -6,4 +6,4 @@

    Parameters

    Returns Promise<string>

    Settings

    Member Visibility
    +

    Returns Promise<string>

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/groupBy.html b/platform-bible-utils/functions/groupBy.html index dee86512e0..101ac967d5 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

    -
  • groupBy<T, K, V>(items, keySelector, valueSelector): 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[]>

    • Settings

    Member Visibility
    +
  • groupBy<T, K, V>(items, keySelector, valueSelector): 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[]>

    • Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/htmlEncode.html b/platform-bible-utils/functions/htmlEncode.html index 8121dab91d..5110e4b23e 100644 --- a/platform-bible-utils/functions/htmlEncode.html +++ b/platform-bible-utils/functions/htmlEncode.html @@ -1,4 +1,4 @@ htmlEncode | platform-bible-utils

    FunctionhtmlEncode

    HTML Encodes the provided string. Thanks to ChatGPT

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/includes.html b/platform-bible-utils/functions/includes.html index cb94262db8..c516b55edf 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/indexOf.html b/platform-bible-utils/functions/indexOf.html index 6244a0c6ab..32afbe928e 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isLocalizeKey.html b/platform-bible-utils/functions/isLocalizeKey.html index 3fb7d0a0ea..cf16408790 100644 --- a/platform-bible-utils/functions/isLocalizeKey.html +++ b/platform-bible-utils/functions/isLocalizeKey.html @@ -1,2 +1,2 @@ isLocalizeKey | platform-bible-utils

    FunctionisLocalizeKey

    • isLocalizeKey(str): str is `%${string}%`

    • Determine whether the string is a LocalizeKey meant to be localized in Platform.Bible.

      -

      Parameters

      • str: string

      Returns str is `%${string}%`

    Settings

    Member Visibility
    +

    Parameters

    Returns str is `%${string}%`

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isSerializable.html b/platform-bible-utils/functions/isSerializable.html index 4162c7a524..995ed65a99 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isString.html b/platform-bible-utils/functions/isString.html index d3357498dc..4539424d8c 100644 --- a/platform-bible-utils/functions/isString.html +++ b/platform-bible-utils/functions/isString.html @@ -1,4 +1,4 @@ isString | platform-bible-utils

    FunctionisString

    • isString(o): o is string

    • 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/isSubset.html b/platform-bible-utils/functions/isSubset.html index 5b7085c54a..e4fec76721 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].

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/lastIndexOf.html b/platform-bible-utils/functions/lastIndexOf.html index 67d4dabe8f..b42faba89f 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/newGuid.html b/platform-bible-utils/functions/newGuid.html index 24c529ac5b..307c0bb0d8 100644 --- a/platform-bible-utils/functions/newGuid.html +++ b/platform-bible-utils/functions/newGuid.html @@ -1,2 +1,2 @@ newGuid | platform-bible-utils

    FunctionnewGuid

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/normalize.html b/platform-bible-utils/functions/normalize.html index dc009c6cb3..b7388d0620 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/offsetBook.html b/platform-bible-utils/functions/offsetBook.html index 737e21dc68..d566b881b1 100644 --- a/platform-bible-utils/functions/offsetBook.html +++ b/platform-bible-utils/functions/offsetBook.html @@ -1 +1 @@ -offsetBook | platform-bible-utils

    FunctionoffsetBook

    Settings

    Member Visibility
    +offsetBook | platform-bible-utils

    FunctionoffsetBook

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/offsetChapter.html b/platform-bible-utils/functions/offsetChapter.html index 0d9bb1ee2a..198cd6a4fd 100644 --- a/platform-bible-utils/functions/offsetChapter.html +++ b/platform-bible-utils/functions/offsetChapter.html @@ -1 +1 @@ -offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    Settings

    Member Visibility
    +offsetChapter | platform-bible-utils

    FunctionoffsetChapter

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/offsetVerse.html b/platform-bible-utils/functions/offsetVerse.html index 575f5d9704..54d42430c2 100644 --- a/platform-bible-utils/functions/offsetVerse.html +++ b/platform-bible-utils/functions/offsetVerse.html @@ -1 +1 @@ -offsetVerse | platform-bible-utils

    FunctionoffsetVerse

    Settings

    Member Visibility
    +offsetVerse | platform-bible-utils

    FunctionoffsetVerse

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/ordinalCompare.html b/platform-bible-utils/functions/ordinalCompare.html index 0687c12de8..2f3422dca2 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/padEnd.html b/platform-bible-utils/functions/padEnd.html index 666b4ba93b..0f240d0dc6 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/padStart.html b/platform-bible-utils/functions/padStart.html index 2a6ec861b9..debc3e3e02 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/scrRefToBBBCCCVVV.html b/platform-bible-utils/functions/scrRefToBBBCCCVVV.html index d3638129ac..5a3189ee43 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/serialize.html b/platform-bible-utils/functions/serialize.html index f229198594..d97cc3685b 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

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/slice.html b/platform-bible-utils/functions/slice.html index af76601844..97cc0a4a49 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/split.html b/platform-bible-utils/functions/split.html index b4ae37628d..2444937cde 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/startsWith.html b/platform-bible-utils/functions/startsWith.html index eadcf9fe5a..f6ad14df3b 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/stringLength.html b/platform-bible-utils/functions/stringLength.html index 63c1204c43..412649241f 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/substring.html b/platform-bible-utils/functions/substring.html index 1ab95244c9..d1481b990a 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/toArray.html b/platform-bible-utils/functions/toArray.html index 73de3bf33c..ccd3d70426 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpArray.html index cdb82d3ca0..0a6f1c3763 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html b/platform-bible-utils/functions/transformAndEnsureRegExpRegExpArray.html index 1420f52e09..dad1ead001 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/wait.html b/platform-bible-utils/functions/wait.html index 1c81283e67..61d494d440 100644 --- a/platform-bible-utils/functions/wait.html +++ b/platform-bible-utils/functions/wait.html @@ -1,2 +1,2 @@ wait | platform-bible-utils

    Functionwait

    • wait(ms): Promise<void>

    • Asynchronously waits for the specified number of milliseconds. (wraps setTimeout in a promise)

      -

      Parameters

      • ms: number

      Returns Promise<void>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/functions/waitForDuration.html b/platform-bible-utils/functions/waitForDuration.html index 8a1a58b2ab..5b00930524 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/BookInfo.html b/platform-bible-utils/interfaces/BookInfo.html index 0e836419a8..ba122cd5ca 100644 --- a/platform-bible-utils/interfaces/BookInfo.html +++ b/platform-bible-utils/interfaces/BookInfo.html @@ -1,4 +1,4 @@ -BookInfo | platform-bible-utils

    InterfaceBookInfo

    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters +BookInfo | platform-bible-utils

    InterfaceBookInfo

    interface BookInfo {
        chapters: number;
        fullNames: string[];
        shortName: string;
    }

    Properties

    chapters fullNames shortName -

    Properties

    chapters

    chapters: number

    fullNames

    fullNames: string[]

    shortName

    shortName: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    chapters

    chapters: number

    fullNames

    fullNames: string[]

    shortName

    shortName: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html b/platform-bible-utils/interfaces/CannotHaveOnDidDispose.html index 076aaec5e3..2f5dab8a04 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

    dispose? +
    interface CannotHaveOnDidDispose {
        dispose?: UnsubscriberAsync;
        onDidDispose?: undefined;
    }

    Properties

    dispose? onDidDispose?

    Properties

    Optionaldispose

    dispose?: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionalonDidDispose

    onDidDispose?: undefined

    Event that emits when dispose is called on an object

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/Dispose.html b/platform-bible-utils/interfaces/Dispose.html index c29f5d9a3b..5d3569b4f5 100644 --- a/platform-bible-utils/interfaces/Dispose.html +++ b/platform-bible-utils/interfaces/Dispose.html @@ -1,4 +1,4 @@ Dispose | platform-bible-utils

    InterfaceDispose

    Require a dispose function

    -
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    dispose +
    interface Dispose {
        dispose: UnsubscriberAsync;
    }

    Implemented by

    Properties

    dispose

    Properties

    dispose

    dispose: UnsubscriberAsync

    Release resources and notify dependent services when tearing down an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/IUsjReaderWriter.html b/platform-bible-utils/interfaces/IUsjReaderWriter.html index 671d08eb64..b5556a87ab 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

    extractText +
    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

    extractText extractTextBetweenPoints findNextLocationOfMatchingText findParent @@ -13,12 +13,12 @@

    Methods

    extractText

    extractTextBetweenPoints

    • extractTextBetweenPoints(start, end, maxLength): string

    • Return a copy of text between two points

      +

    Returns string

    extractTextBetweenPoints

    findNextLocationOfMatchingText

    findNextLocationOfMatchingText

    • findNextLocationOfMatchingText(start, text, maxTextLengthToSearch): undefined | UsjContentLocation

    • 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.

        -

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    findParent

    findSingleValue

    jsonPathToVerseRefAndOffset

    • jsonPathToVerseRefAndOffset(jsonPathQuery, bookId?): VerseRefOffset

    • 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

      -

    nodeToJsonPath

    nodeToVerseRefAndOffset

    nodeToJsonPath

    nodeToVerseRefAndOffset

    • nodeToVerseRefAndOffset(bookId, node, nodeParent): undefined | {
          offset: number;
          verseRef: VerseRef;
      }

    • 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

      -

    removeContentNodes

    removeContentNodes

    • removeContentNodes(searchFunction): number

    • 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

      -

    usjChanged

    usjChanged

    verseRefToUsjContentLocation

    verseRefToUsjContentLocation

    • verseRefToUsjContentLocation(verseRef, verseRefOffset): UsjContentLocation

    • 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.

      -

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/platform-bible-utils/interfaces/LanguageStrings.html b/platform-bible-utils/interfaces/LanguageStrings.html index 59e579c180..6f2f276e02 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

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/LocalizedStringDataContribution.html b/platform-bible-utils/interfaces/LocalizedStringDataContribution.html index d62166b07a..4977a7211f 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

    localizedStrings? +
    interface LocalizedStringDataContribution {
        localizedStrings?: {
            [k: string]: LanguageStrings;
        };
        metadata?: StringsMetadata;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    localizedStrings? metadata? -

    Properties

    OptionallocalizedStrings

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }

    Optionalmetadata

    metadata?: StringsMetadata

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionallocalizedStrings

    localizedStrings?: {
        [k: string]: LanguageStrings;
    }

    Optionalmetadata

    metadata?: StringsMetadata

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ModifierExtensionControlled.html b/platform-bible-utils/interfaces/ModifierExtensionControlled.html index 46c25d127e..56bb07244c 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

    platformType? +
    interface ModifierExtensionControlled {
        platformType?: undefined;
        type?: undefined;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    platformType? type? -

    Properties

    OptionalplatformType

    platformType?: undefined

    Optionaltype

    type?: undefined

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalplatformType

    platformType?: undefined

    Optionaltype

    type?: undefined

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ModifierProject.html b/platform-bible-utils/interfaces/ModifierProject.html index 78a3677fd8..d8add603ca 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

    -

    OptionalexcludeProjectInterfaces

    excludeProjectInterfaces?: string | (string | string[])[]

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

    OptionalexcludeProjectInterfaces

    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.
    • -

    OptionalincludePdpFactoryIds

    includePdpFactoryIds?: string | string[]

    String representation of RegExp pattern(s) to match against the Project Data Provider Factory +

    OptionalincludePdpFactoryIds

    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

    -

    OptionalincludeProjectInterfaces

    includeProjectInterfaces?: string | (string | string[])[]

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

    OptionalincludeProjectInterfaces

    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.
    • -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/OnDidDispose.html b/platform-bible-utils/interfaces/OnDidDispose.html index 6429a285cd..a0ed18d606 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

    onDidDispose +
    interface OnDidDispose {
        onDidDispose: PlatformEvent<void>;
    }

    Properties

    onDidDispose

    Properties

    onDidDispose

    onDidDispose: PlatformEvent<void>

    Event that emits when dispose is called on an object

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ProjectSettingProperties.html b/platform-bible-utils/interfaces/ProjectSettingProperties.html index 5f2cb2ffbf..7e2b8712d5 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

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/ProjectSettingsGroup.html b/platform-bible-utils/interfaces/ProjectSettingsGroup.html index 43781ee0de..414e87b34e 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

    description? +
    interface ProjectSettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: ProjectSettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description? label properties

    Properties

    Optionaldescription

    description?: `%${string}%`

    LocalizeKey that displays in the project settings dialog to describe the group

    -

    label

    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    -

    properties

    properties: ProjectSettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    +

    label

    label: `%${string}%`

    LocalizeKey that displays in the project settings dialog as the group name

    +

    properties

    properties: ProjectSettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/ProjectStateContribution.html b/platform-bible-utils/interfaces/ProjectStateContribution.html index 6b72ed6c15..102158d701 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

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/ScriptureReference.html b/platform-bible-utils/interfaces/ScriptureReference.html index 6e0df650ab..b385b0f3fc 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 chapterNum verseNum -

    Properties

    bookNum

    bookNum: number

    chapterNum

    chapterNum: number

    verseNum

    verseNum: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    bookNum

    bookNum: number

    chapterNum

    chapterNum: number

    verseNum

    verseNum: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/SettingProperties.html b/platform-bible-utils/interfaces/SettingProperties.html index d2f6e3f0ad..dbd78899c4 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

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/SettingsGroup.html b/platform-bible-utils/interfaces/SettingsGroup.html index 4eef7b9f57..9acda572d2 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

    description? +
    interface SettingsGroup {
        description?: `%${string}%`;
        label: `%${string}%`;
        properties: SettingProperties;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    description? label properties

    Properties

    Optionaldescription

    description?: `%${string}%`

    LocalizeKey that displays in the settings dialog to describe the group

    -

    label

    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    -

    properties

    properties: SettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    +

    label

    label: `%${string}%`

    LocalizeKey that displays in the settings dialog as the group name

    +

    properties

    properties: SettingProperties

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/StateBase.html b/platform-bible-utils/interfaces/StateBase.html index a9e94ca7bf..da1f8b3786 100644 --- a/platform-bible-utils/interfaces/StateBase.html +++ b/platform-bible-utils/interfaces/StateBase.html @@ -1,7 +1,7 @@ StateBase | platform-bible-utils

    InterfaceStateBase

    Base information needed to describe a state entry

    -
    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    default +
    interface StateBase {
        default: unknown;
        derivesFrom?: `${string}.${string}`;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    default derivesFrom?

    Properties

    default

    default: unknown

    Default value for the state/setting

    -

    OptionalderivesFrom

    derivesFrom?: `${string}.${string}`

    A state/setting ID whose value to set to this state/setting's starting value the first time +

    OptionalderivesFrom

    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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/StringMetadata.html b/platform-bible-utils/interfaces/StringMetadata.html index e2d0aa7362..a8adff013f 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

    fallbackKey? +
    interface StringMetadata {
        fallbackKey?: `%${string}%`;
        notes?: string;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown

    Properties

    fallbackKey? notes?

    Properties

    OptionalfallbackKey

    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 ``.

    -

    Optionalnotes

    notes?: string

    Additional information provided by developers in English to help the translator to know how to +

    Optionalnotes

    notes?: string

    Additional information provided by developers in English to help the translator to know how to translate this localized string accurately

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/platform-bible-utils/interfaces/StringsMetadata.html b/platform-bible-utils/interfaces/StringsMetadata.html index b0e33a07ce..73e0ce1354 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

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/interfaces/UserStateContribution.html b/platform-bible-utils/interfaces/UserStateContribution.html index c185678fb4..635a5b90ed 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

    Settings

    Member Visibility
    +

    Indexable

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/CanHaveOnDidDispose.html b/platform-bible-utils/types/CanHaveOnDidDispose.html index 8bff5e4826..4ae53f9db3 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ColumnsWithHeaders.html b/platform-bible-utils/types/ColumnsWithHeaders.html index 15ab2343bf..65f3d631fb 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/DeepPartial.html b/platform-bible-utils/types/DeepPartial.html index e629e9942e..0644334c12 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/DocumentCombinerOptions.html b/platform-bible-utils/types/DocumentCombinerOptions.html index 651e78e687..812662290a 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. -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ExtensionControlledProjectSetting.html b/platform-bible-utils/types/ExtensionControlledProjectSetting.html index 364d82ee70..f7456fc021 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ExtensionControlledSetting.html b/platform-bible-utils/types/ExtensionControlledSetting.html index 767e6db22b..c7d7e625e2 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ExtensionControlledState.html b/platform-bible-utils/types/ExtensionControlledState.html index 0ebc42cc30..1f0487eb60 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/GroupsInMultiColumnMenu.html b/platform-bible-utils/types/GroupsInMultiColumnMenu.html index f2d3f54936..8e76f75ebc 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/GroupsInSingleColumnMenu.html b/platform-bible-utils/types/GroupsInSingleColumnMenu.html index 710fdad96c..87547c90ec 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/JsonDocumentLike.html b/platform-bible-utils/types/JsonDocumentLike.html index f0d6f49c9a..8512342301 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

    Settings

    Member Visibility
    +JsonDocumentLike | platform-bible-utils

    Type AliasJsonDocumentLike

    JsonDocumentLike: JsonObjectLike | JsonArrayLike

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/LocalizeKey.html b/platform-bible-utils/types/LocalizeKey.html index 1bdb994948..436c62ccf2 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/Localized.html b/platform-bible-utils/types/Localized.html index 155d239658..9ee0095015 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/LocalizedStringValue.html b/platform-bible-utils/types/LocalizedStringValue.html index be7a7df333..c7437350ad 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuColumnWithHeader.html b/platform-bible-utils/types/MenuColumnWithHeader.html index 63283abc58..05cb9c2bbd 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInColumn.html b/platform-bible-utils/types/MenuGroupDetailsInColumn.html index bd348600c8..24ca2578b8 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html b/platform-bible-utils/types/MenuGroupDetailsInSubMenu.html index c2c239d0cd..0bcbe179ce 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuItemBase.html b/platform-bible-utils/types/MenuItemBase.html index 4d7c19a2c4..6510426dba 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuItemContainingCommand.html b/platform-bible-utils/types/MenuItemContainingCommand.html index cb1d7d9ed6..80ba61bf7e 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MenuItemContainingSubmenu.html b/platform-bible-utils/types/MenuItemContainingSubmenu.html index 3d9b310550..a829d70676 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/MultiColumnMenu.html b/platform-bible-utils/types/MultiColumnMenu.html index cd783365d1..3811898094 100644 --- a/platform-bible-utils/types/MultiColumnMenu.html +++ b/platform-bible-utils/types/MultiColumnMenu.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/OrderedExtensibleContainer.html b/platform-bible-utils/types/OrderedExtensibleContainer.html index cedaa7efb0..a577fad2b9 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/OrderedItem.html b/platform-bible-utils/types/OrderedItem.html index 79fcbef576..966ece79e1 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)

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformEvent.html b/platform-bible-utils/types/PlatformEvent.html index baa2bf1512..9d90e0f810 100644 --- a/platform-bible-utils/types/PlatformEvent.html +++ b/platform-bible-utils/types/PlatformEvent.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformEventAsync.html b/platform-bible-utils/types/PlatformEventAsync.html index ec3906bd62..4f63eea5d4 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformEventHandler.html b/platform-bible-utils/types/PlatformEventHandler.html index 30b0b752ed..4db06ee72c 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/PlatformMenus.html b/platform-bible-utils/types/PlatformMenus.html index b59ae57ebf..d426974086 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

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ProjectSetting.html b/platform-bible-utils/types/ProjectSetting.html index fe555dad48..ac88bc3ce5 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

    ProjectSetting: ExtensionControlledProjectSetting

    A description of an extension's setting entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ProjectSettingBase.html b/platform-bible-utils/types/ProjectSettingBase.html index 18c87ad7c3..d7952c06d8 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ProjectSettingsContribution.html b/platform-bible-utils/types/ProjectSettingsContribution.html index 03735e0759..26fc518707 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ReferencedItem.html b/platform-bible-utils/types/ReferencedItem.html index 5bfa5b90de..14ddf6a235 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)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ReplaceType.html b/platform-bible-utils/types/ReplaceType.html index 07339be732..b26d40536a 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScriptureNode.html b/platform-bible-utils/types/ScriptureNode.html index 467a8dde3d..ed5a53e500 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScriptureSelection.html b/platform-bible-utils/types/ScriptureSelection.html index 1b04a23f67..6d96ab4208 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScriptureTextAnchor.html b/platform-bible-utils/types/ScriptureTextAnchor.html index 3a41c8a306..e4e427fa7b 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.)

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/ScrollGroupId.html b/platform-bible-utils/types/ScrollGroupId.html index 4bf29d35df..2679361db7 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).

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/Setting.html b/platform-bible-utils/types/Setting.html index 33f414249e..04bb43f06c 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

    Setting: ExtensionControlledSetting

    A description of an extension's setting entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/SettingBase.html b/platform-bible-utils/types/SettingBase.html index 175e9c1d5d..053cdd1129 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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/SettingsContribution.html b/platform-bible-utils/types/SettingsContribution.html index d07bf2543c..4367884b6b 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/SingleColumnMenu.html b/platform-bible-utils/types/SingleColumnMenu.html index 64d0c8e772..0a697428d5 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UnionToIntersection.html b/platform-bible-utils/types/UnionToIntersection.html index 768fc33188..8dd5593518 100644 --- a/platform-bible-utils/types/UnionToIntersection.html +++ b/platform-bible-utils/types/UnionToIntersection.html @@ -3,4 +3,4 @@

    Type Parameters

    Example

    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>;
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/Unsubscriber.html b/platform-bible-utils/types/Unsubscriber.html index a69510e1d2..3e572e62d9 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UnsubscriberAsync.html b/platform-bible-utils/types/UnsubscriberAsync.html index c582217c25..97c1c57c81 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UserState.html b/platform-bible-utils/types/UserState.html index 6d7041f52f..98fa29a9bf 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

    UserState: ExtensionControlledState

    A description of an extension's user state entry

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/UsjContentLocation.html b/platform-bible-utils/types/UsjContentLocation.html index 03fbde9140..28d01fbf3b 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/VerseRefOffset.html b/platform-bible-utils/types/VerseRefOffset.html index 922b71eb82..5aed48f86b 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/WebViewMenu.html b/platform-bible-utils/types/WebViewMenu.html index bfb9afff4e..b6a7aadd2e 100644 --- a/platform-bible-utils/types/WebViewMenu.html +++ b/platform-bible-utils/types/WebViewMenu.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/types/WebViewMenus.html b/platform-bible-utils/types/WebViewMenus.html index 9e3f757fca..a3b150e5d5 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

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/CHAPTER_TYPE.html b/platform-bible-utils/variables/CHAPTER_TYPE.html index 237fb5523f..6bf1bdb56d 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/FIRST_SCR_BOOK_NUM.html index 8ccbcc013b..57f6c14c8b 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

    Settings

    Member Visibility
    +FIRST_SCR_BOOK_NUM | platform-bible-utils

    VariableFIRST_SCR_BOOK_NUMConst

    FIRST_SCR_BOOK_NUM = 1

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html b/platform-bible-utils/variables/FIRST_SCR_CHAPTER_NUM.html index ece960155e..635d4c7bc6 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

    Settings

    Member Visibility
    +FIRST_SCR_CHAPTER_NUM | platform-bible-utils

    VariableFIRST_SCR_CHAPTER_NUMConst

    FIRST_SCR_CHAPTER_NUM = 1

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html b/platform-bible-utils/variables/FIRST_SCR_VERSE_NUM.html index 7befd91045..b206e545df 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

    Settings

    Member Visibility
    +FIRST_SCR_VERSE_NUM | platform-bible-utils

    VariableFIRST_SCR_VERSE_NUMConst

    FIRST_SCR_VERSE_NUM = 1

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html b/platform-bible-utils/variables/LAST_SCR_BOOK_NUM.html index fd35fd3cb1..4c7fb914ef 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 = ...

    Settings

    Member Visibility
    +LAST_SCR_BOOK_NUM | platform-bible-utils

    VariableLAST_SCR_BOOK_NUMConst

    LAST_SCR_BOOK_NUM: number = ...

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/VERSE_TYPE.html b/platform-bible-utils/variables/VERSE_TYPE.html index 9b8f75bb11..a0ba517dc1 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/defaultScrRef.html b/platform-bible-utils/variables/defaultScrRef.html index 6fc7320736..56ad942f48 100644 --- a/platform-bible-utils/variables/defaultScrRef.html +++ b/platform-bible-utils/variables/defaultScrRef.html @@ -1 +1 @@ -defaultScrRef | platform-bible-utils

    VariabledefaultScrRefConst

    defaultScrRef: ScriptureReference = ...

    Settings

    Member Visibility
    +defaultScrRef | platform-bible-utils

    VariabledefaultScrRefConst

    defaultScrRef: ScriptureReference = ...

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/localizedStringsDocumentSchema.html b/platform-bible-utils/variables/localizedStringsDocumentSchema.html index 1186320149..18e77edebc 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/menuDocumentSchema.html b/platform-bible-utils/variables/menuDocumentSchema.html index 9195511738..8882b185e7 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/projectSettingsDocumentSchema.html b/platform-bible-utils/variables/projectSettingsDocumentSchema.html index d2993d2285..5133b19c7a 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/platform-bible-utils/variables/settingsDocumentSchema.html b/platform-bible-utils/variables/settingsDocumentSchema.html index bd40ae9adc..7cdbce019d 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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility