diff --git a/papi-dts/classes/_client_services_rpc_client_.default.html b/papi-dts/classes/_client_services_rpc_client_.default.html index 658020057f..e64970cb71 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 9c2fbb4b0d..791dfce832 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 f82a133d8a..beb26085a4 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 a35e056f70..b81669182c 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 40f08023e0..8590364058 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 dd755d8210..6b5e4f4d5f 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 077dfcad55..d4c93aea2c 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 e2108d1891..2ae6fb5510 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 32b19025df..de0da78c0d 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 d1c82a0ca7..e59dbb4939 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 eb1ccb716a..50aa738b3a 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 77690d9182..e56c106c3a 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 72211d3a5a..f0a39c9cc1 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 b5ba8e1a5c..a8fa235b8a 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 982ca94656..f9feeed271 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 65432da0e4..81f3e3d078 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 d7f461e7ad..fb51f7e861 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 42f2fc119c..59ba350026 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 af4ba827d2..eec0115070 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 c124bb7070..4e36235bc9 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 1a9947b71f..82748be9e5 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 0e4b84a183..ceb0cd0c1e 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 40ec804d15..5d2e36a1f4 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 6d691a8885..34e7ea6f92 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 d59986f6bc..aff762058a 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 f2fe2c74f1..25eac7a2ef 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 fdc31bda5c..71d2f18556 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 62d5c837c4..fa17b87ae2 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 91c137a25e..c75eda78ba 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 b8182a9254..04e44bdf36 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 2a5975fc43..dd95f7c8c5 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 40a208ad7d..349da4bb19 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 deeed8fd4b..5406193b2d 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 e9e28332f4..205b3e00bb 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 646606ff7a..27ccfcc1cb 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 13182130ba..ffe6bbb595 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 b500b59b64..c7fe1bd4c8 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 f82a874195..f2af34e569 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 7539294bb8..adbc649038 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 2588d2fc48..8528c8fb79 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 6781b9d968..e396347761 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 32f7c1132b..657857944c 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 dd16c68863..5bea7beb72 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 a968381e57..9e5272c0e6 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 fa71c1bb96..371a297c98 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 77a60b0857..6466a77dda 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 9c88ad0416..67a2bf29d6 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 dde7bd7e0a..2cc5b517bc 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 c2f14c1930..cc8f785b8d 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 ed857283f9..32c1c78b43 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 9382033593..44984f13e1 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 a7e9c95379..d2329d800a 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 bcc4e03852..b63fb55ba9 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 77fba731a6..800d3cf589 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 c0ed748406..34e2aaa497 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 7d80f4cad3..13867a430a 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 be944ff63a..fade06d6cb 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 2fe38356d2..ad89112247 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 5053e1258d..6bb2d49afd 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 8a4952d469..d74943bee4 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 5f94cbf253..f6b235e86b 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 6c806d8bae..a41e19d106 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 aff1cb457b..6532a930c7 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 7e9b2c7232..fe5bdf8890 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 669ac55276..f7af1015b0 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 73ed117144..fc56297edb 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 d004fa474e..05a85f4a0c 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 61ac43f073..ecc4a13bf8 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 4c291de42e..33c068a974 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 993e08ccc0..dc76a3b896 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 821e39f6b4..ddc957a0b7 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 b0a0acc44e..ec841f1b2e 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 e38a16301d..f410102e18 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 dd0fd34ade..c63146eca9 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 6f19ae3ee5..7eab158f1a 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 05509119d3..da3cc258fd 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 @@ -3,4 +3,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 8d0133c347..c07b2f08d2 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 c39ce873d3..533bf14003 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 75421f8f74..195795a9d1 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 bf93ef6082..7bf80e6b61 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 8f49924051..de8b9252f6 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 509a7cfcd7..181f547076 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 b3592bd0c4..00fdefe68b 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 b36bf64ba0..c47f47aa42 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 7c3af64016..8f8e5e463c 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 c7822fcf09..b814663545 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 50fb29af1e..9428ce516f 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 226c285fc8..96bb64ddd4 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 8aa9fb072f..bb6ad9e4ec 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 350cee42fb..708d193556 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 41e718cd04..4063f72a29 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 26572ddf8c..ed436047e7 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 ac70f37085..7d29fde3c4 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 4312ff042d..3120cf600a 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 0f269deeeb..0fed4701e8 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 6ea3dae576..358ab6b61e 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 efa6382048..4d651ebeb8 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 2d668ac22c..4b67964a7e 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 76963463a6..eb7e2201c3 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 60e50cc2fd..d17880db23 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 4a32497b35..ebef820734 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 5f2fc1f558..a15317bb12 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 f048cf22b1..83a3a99433 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 52c93b6328..288a0dc000 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 420762c7aa..54c3888450 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 f61ebca44f..21e406389a 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 d138116363..9bb147c1ed 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 031b99ed61..11a4eef782 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 6b768181f4..1670510935 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 522e76600b..e2373c32ae 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 ba9bc12d99..46f30b60c3 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 589e81fb03..4672b13aab 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 736b06ffd9..728fcb2ca1 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 174423d98f..8d3a14c4c0 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 3db45497a6..30980d89ca 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 511231b958..e9ede609a7 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 97c6ae8707..7c54839630 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 bb0f25436a..36eb99e1c6 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 71466fe5b3..1d3a7ee779 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 4e2e416f72..cb3b710f43 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 160402574e..089bd9a107 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 9a00edd129..4b8f229e62 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 a0ab5ae482..fc47053797 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.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.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.openUserSettings platform.quit platform.restart @@ -17,6 +17,6 @@ test.echoExtensionHost test.throwError test.throwErrorExtensionHost -

    Properties

    platform.openProjectSettings

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

    platform.openUserSettings

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

    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
    +

    Properties

    platform.openProjectSettings

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

    platform.openUserSettings

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

    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 a77c6ac78b..7486815a16 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 70786ed49a..801dfe6c20 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 3e1277f367..193ff81eb3 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 6a0a270827..bf64418ca4 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 96a488a145..5205d3979e 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 6ca1421330..632f51fe7d 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 e96c5aa4ae..706339b1db 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 00d4852e44..3fd54d77e4 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 b37e3856d4..fccb95fdc9 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 cc3b6d7007..3874f1fd81 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 1acde4871f..66a83d5ef7 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 a328b38e26..3affa0d1f2 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 8cd673bbcc..1667eb1e27 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 5578fbf325..e610ec1c40 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 002596e56f..dccc3afd48 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 50de8c2b20..c084160999 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 1688ee0e31..1bf0fe888c 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 5594b52699..8c7e473dff 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 aaa56e8176..7745890226 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 e01e3500eb..8e4af65e94 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 51c52334c7..0b2fc5e66b 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 86bed15e63..f1f8558272 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 82f25e2728..47ef0a4d0f 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 c619886c63..760544b155 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 2479b385df..cc31529224 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 f5e2059847..466570e1a7 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 bf3a7874f2..2442982dc2 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 b6e4f46ef9..f33614ec62 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 aaa4eeeb0b..c2e82fb970 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 ded29e55ef..cff907e84e 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 1175f317d6..790cfa36a0 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 377bb14525..c1a06c6ec0 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 d2841dd562..ef826a6db9 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 83220ea2fc..59258b5b53 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 5f90d398d1..0d1e4d1a6c 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 0a1df85dbb..fd75729706 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 1ad2852882..4ebd702e6d 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 4727a89fd3..ec8e76e98a 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 d2292d9fcc..b6bdca07a2 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 e21e7e30a5..9c9481a9d1 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 2bd0ed459e..4128bcb8a2 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 cff50f488f..1ebec23588 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 fff808199e..f80db0218e 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 eb52d22b50..447df13fb9 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 63a1be1176..35f84e4f24 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 efb90bbd22..672247abe9 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 6e437eed25..ec5305cb12 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 ece63aff84..cb2e8ad315 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 53947e90db..2002fc8950 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 fd45122350..cadad3200e 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 548e323105..c364a6e704 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 d01098f1f4..ad836850e2 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 ca3deb6cec..d0b8e62864 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 7fafa00d2b..37be961239 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 085853c249..08b1b3b07c 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 76401f0e8e..e00bd9c9ae 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 2a2b27a66c..8c78f1f74f 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 2510cec3d8..b2d554ebab 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 9f49e42ca7..3099afb69c 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 838ff56257..5553476ac3 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 9cfdc6c9d5..e7ca58eefc 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 a563d0baa4..bdb8683141 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 c30e53f0f6..f551ccc0f4 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 f8469c932e..6d364df84c 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 429ab37df1..600722f3a1 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 43528870e1..5e425237d6 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 d8ce41dccb..5c032364de 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 b261670f82..cd0f28a8ff 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 8103fcb569..fc0c3a7866 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 0d70682820..ccf2a6516a 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 7ce2bff29e..79b0897aae 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 627ade07be..09af76bf0e 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 e1eec13c81..9f9613d9dd 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 37ad1acfd0..1bb0b30166 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 6a8dff4593..f9ce878704 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 607ee782b2..3150d3eba5 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 209481f67c..d8834a9424 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 dc7c9e8c79..7f34183f30 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 56f28197a5..1938e9bec0 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 c1074ec399..fa83de1cec 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 2eb11a4e2b..fa634f12c1 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 af0ebbbf65..f1722b77ae 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 bf46065fc6..59b2a8b14d 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 4d76717caf..d2f84263cb 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 a613b5e58c..211c86cd75 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 5ea4c2db65..eda70368f3 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 fa8441c7f0..af3359e880 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 747419eb05..4d8995c495 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 052d02ce39..c984269ed7 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 0c8da1567d..db1bd9f992 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 77310bf79f..72aab16c89 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 d37a5e3cfa..bd1d8908db 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 e938f7da64..0ac9def97d 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 1fce8b41ab..5d3ff0f396 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 2680438e4c..bbbb13646a 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 7f19bb6f78..abbcad22f0 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 abc1a73587..d3f723ad50 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 4d71deec18..b751160442 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 fd26a61bd1..fab7cad67d 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 fcbae0b708..9af464fb3d 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 e4b85af481..d0e12dfc54 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 9ac59e08fc..214483112f 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 ed3b5c827e..55f2929f1b 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 379859c3a6..664ed2b2f4 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 829bda28f5..a7ae2f20c4 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 cdba21e518..b5226f78eb 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 dd02b314ac..b63423ba4a 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 8bf492effe..70e5ba32f9 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 0b46a44e3e..5ce82b6338 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 115b58a0b3..ca90c69d78 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 85342f41db..2ac8628f28 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 4a4fda6499..ef80560051 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 ade5010212..d02de059fe 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 10c6f14295..15f7f58f3c 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 fcbe839227..275bcab8dd 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 c44dd44a15..b8eac007ae 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 eca47799ed..76b47e0f7b 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 7f6cc5aa48..c03f581c2a 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 f4c6203502..01892a0bb0 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 e8227bd5dc..13cffe0d5c 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 5c5266f3a9..6468156c39 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 5c2341bc35..fb93f54235 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 068318f533..e7b9f4a4a5 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 1058dfa4af..839286fb70 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 057136f24d..0bb63aec76 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 add81c460a..a975aee8d0 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 a7048c23c6..5fb43d414e 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 8f6217a22b..5f5ec7f2aa 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 106a4bbbd4..1135bdd8b8 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 b1008aff5f..8da87eb749 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 d18d986763..d7d0af8a5f 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 a79867bb22..33cfce25d9 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 e35d955b89..82b75cdb53 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 0ea85385ba..4f9d93043a 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 e5632b19aa..73ac7dbe18 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 2808691979..502cf90649 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 4662bcfbce..038470f4ea 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 a50bc723b4..557d9c3211 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 b4f8a52eae..9abdfa3fb2 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 30ffab18dd..59958b1248 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 16a2200ea3..fa4a3222da 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 07848d2451..cd62b1b881 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 03db294d6c..764c6f958e 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 d5cecd0616..bc7e16e703 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 d1988b7df4..39ec4dd719 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 4162d37032..d80f5cfbcb 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 9c4faa2668..9a7d0e7277 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 8aa0d4eb88..9d6a49d8d5 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 e39afaa25a..d1a3b0d6ae 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 c24826ae42..1e3f4179e0 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 475410959b..2798821c51 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 ee9154fd24..7b125276bb 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 f241b4ee19..65fa4a5af7 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 1e59127178..b0719401d8 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 66b3a6bb81..ef10e61dbe 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 e8d90b3bad..d7e3b44687 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 495b33d141..7da4257cef 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 b1e3c9bea3..a8c8dbe712 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 fde5d7d1b4..b5d21533c5 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 99613e0478..2cf0cf712d 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 2c5c7398a5..7708e1cfae 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 1d041d2eb3..e0abc4a0f9 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 47a4ae840f..ad3f009d3d 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 fafd3e38c4..072ff952fb 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 6b1d11fe5a..03484e8f05 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 e848475f10..26c1cdd7c3 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 d88a3bcfe5..ea291470a9 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 6e88511fe6..c889c65912 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 1a70674818..a8529f488a 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 a7977ec467..33e044a230 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 56992df07e..853a8ca4eb 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 9284af71bb..7c0b002db8 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 7c7d832c74..88d1c9f255 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 1c53b9e7ad..67f6be2b54 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 ceb6f75319..71e3b722da 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 e017afec43..25f2e5de01 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 37f9a7d6a7..c42b2c3011 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 091860b1dd..078d44a08e 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 8e43f99579..74a0dc7176 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 1eac10d794..48888af75b 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 5fb719acef..65ec61c99c 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 46972818b9..fe1c83376c 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 57b144ca0b..9ef801acf5 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 e4863e0c3d..9bc985e814 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 ca21347a44..7a0011c23e 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 36d43cd2e7..4adaa14a40 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 675eade594..b8e2235770 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 35fb7fa671..bb3f88458a 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 62adffe5b3..beb7e6a497 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 b1e4c2d3d1..159bed9e25 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 fa90df5b1b..c372886d66 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 33352bfa75..d44ce7de83 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 632584c944..7974678070 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 7d39ab6f4a..99922641dc 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 4f6bda7dac..2fb94d03fb 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 71d7805ff2..2e8c7e6cd4 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 7d0f607629..04d9484c1e 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 e2346e8789..34e05e7cba 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 bba1b8b7a8..f3df327cb5 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 b041a27eae..bbd0ed1cce 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 9d4591148e..92b38aeeb8 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 9b47bbee18..752c641a89 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 6b27c4afce..83112305b4 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 dbb093b1db..4053f4d1f8 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 31473cda7b..1c9b2589c0 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 cc7e197fc7..277056ab7b 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 ed6e3d9523..c1d47c1e69 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 476857440e..fbde79cb56 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 c17e8e502f..546f7ff205 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 49a73662c5..23a70e4dea 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 60fc37cde2..42369b0629 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 00f077f2f5..3eb9276cdf 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 6eadebea69..60f1b47668 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 285dc6d025..49268eef17 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 a558c1e401..1235430a9a 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 6159a438f8..45a8650299 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 36f9fec9e0..e0cbf8d847 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 7534d1291e..5276b1f9c5 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 671e761243..1d686c11a9 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 53dcacca08..b9dd16ce11 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 2886e3dd60..e4e07e087c 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 50806e952d..eed475c202 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 627d5af1c7..b10d108841 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 709043a336..149f419ce2 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 ebb3214e91..83d18c60c3 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 66f95a8e2e..9f7093db52 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 b8911225d6..a4caa213d0 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 04ae04d886..9ad5910b1f 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 67a9144a4b..42a31a5313 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 51ee65a0b7..188c0a11ec 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 9d7f9c3237..cb4ac4b462 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 b7dfa460be..5884f088d0 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 c7f09b58ca..c7d2b2e669 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 19e7b1baf8..a64b60f9c5 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 60f4d89bee..9a333d1da7 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 00b3fb8d42..c4fcfeb5f3 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 e1dd757011..5ac8fc694a 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 7db63c32a4..0d66c1ccd9 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 a10b8c4b49..7754ddfb64 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 2139edc09b..82373db29e 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 a8a3d3546c..c9e342251e 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 98a91b02a3..446746c997 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 68f3129522..594edf9327 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 f78bf37e5b..1c0e93a368 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 b54b932643..32f7c9c62d 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 3b82740a79..daac5c712d 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 d95833a8ee..eb2735f86b 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 b95154cec6..55525d301f 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 f011963bdc..a9864a5c4c 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 2c3b5fe1c8..2ce390038b 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 b0392e341c..0da3036162 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 728cfff497..76f5429398 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 67607f8a7f..d0dd986514 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 5881347642..d89dce7d0a 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 986b85e66f..b3e3e2db6c 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 b595c2e06a..1dfd8ec3d7 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 2e6a816950..92f7138442 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 dbc45dca97..e268074ffa 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 16c66ea3f2..d5f9ede583 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 a7687eddca..a9786e4dc6 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 f82fc5db39..08cc00942e 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 3e36f4ba09..5786deac49 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 3cf76ae3b6..b6860a3bac 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 b1755ba146..52a175f763 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 7b93242583..2f7ec8ea1e 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 4e64c08c63..0e17414e02 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 a71e1b46aa..2739cde897 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 da223d7d8b..257cab69a8 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 609124fc74..4fe4140838 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 7ba8fcae94..5e4143b4a3 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 56183d6a9c..e6239366e3 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 f3f0612b92..4b57fc653b 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 35cbb1d27c..71fa175fcc 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 6dcc536f9d..81e50092bf 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 938427d3b5..063f9b9692 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 ddd1e8f761..c69e9d2d35 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 ee75ebeb32..ddc7618a24 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 6af3f275ad..85e6eae680 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 9f0f40d80a..7d43a25f4b 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 1791af6dd9..8656b31646 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 1047660bd5..9b779af203 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 20cc11744b..c431c03299 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 0b782f6bd8..1713c06180 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 965c02c494..6cbca8c113 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 08452283d1..e262a2a8f3 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 4083875bc5..f7fdf7daa3 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 4abb12cc6e..7ce24b4b2c 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 8d91695485..4de6db294f 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 66429b5eac..967f0f4539 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 4c199d35e0..90a7fe0564 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 9952c2708b..ad5f777ab1 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 33216bce62..3991579273 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 b9410119b1..8772816cf6 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 775e29ecf1..496cd6eaf8 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 ea81eaf55b..6d52504d8d 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 d4996e2f15..42ee6952c3 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 5265f247f7..4856e23fae 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 4cfe445885..d504e3aba3 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 f8dd07cff8..8da183c71f 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 a2eb4657ef..594a3fcf1f 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 ef04d410fb..fed4abf795 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 e1943822a0..cb24a00ab4 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 096b0f4587..4897b81277 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 4db183c8b2..6e65f1f38a 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 e6729f9ac4..058d83ab61 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 b624625330..9c405ae2c7 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 a456a0dce7..b3e2baabc7 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 3853d752f5..1df97dd01f 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 5187e7368a..2ffdb029ad 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 562fdb86c9..60546d3d05 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 c2598a24a9..d9fbc8044f 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 8494d57675..364a6c0796 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 bb1d27e4ec..b518fe69ca 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 eeb6e4ba12..bcdfd92e39 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 966e6b00e4..d3f4bdf70a 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 37083f6607..53530161ea 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 ee7d74ccb4..5bd27824ae 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 75b4ebc56e..d3cee93ed0 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 f6fad5ee1a..42bd0e688b 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 f27b1b654b..fedff56955 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 8310c0b3b2..6a64434348 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 8fa3643b8b..b9dd68958a 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 65a3aa1b3f..715cedfe34 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 03d84e1750..f2dc785d2d 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 ae9bbbab27..65cc03e961 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 34ce704543..3ed61183dd 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 248fcd4697..e693b8bd6e 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 17fd43a0ed..5f0794c3db 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 d8952248ce..55e4ffd4a1 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 b6093f3ab9..15e1681b1c 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 1d6054472f..29348e0860 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 5aa694a253..70868319fb 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 8d8b756ca6..b9f7dc9a3e 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 2cbb0cd038..a37b4f45e5 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 a7687e46e7..cbd890b653 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 0ed424985a..325635a545 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 ad6544b15c..04ff40ac43 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 fef4e24aa2..69487b3785 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 9941726cfc..27b1aa299b 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 937214f247..b6fb08307b 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;
        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 ecd8db59b8..6f4bc5042e 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 f9e93a5494..477cb5ee2a 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 3a7acc2aaf..bb209f1731 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 2f1a0e2dfc..5be5cb1a90 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 bf8758a88e..772187e313 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 ff9551fbe8..b962fd9568 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 01ad4fa6bf..c3401b5f39 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 65a448ed4f..82716b376f 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 efe15f8e76..badf9bb8f1 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 16f3d16e26..bd695daf2e 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 2124359f78..5fa2502165 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 a23b24b7ad..c45bd2701c 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 d00216d7c4..4dc3dc2930 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 17e4cc71a6..154aaa07d7 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 4cb94ae427..7280ffbd3d 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 3a055e512f..1a599f08f5 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 7aedc9490e..c0b3432b53 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 61b78a2ee2..e386f24cd2 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 0ce43b096f..b518fdeb1e 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 8b5f752734..d1f8ed4702 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 fbb8cc8c7e..3e7a7f5760 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 1b30d56059..6a3de1081c 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 3a2ac3a8b4..ece3aa9bae 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 b59498e027..c06fa88076 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 cd1d902c23..3ed15075cc 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 05e6bd1548..292caecd0e 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 819f383a8e..9cfe097ee7 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 ca6f706d41..1bc1a0a303 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 176a636632..8f47ec76d8 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 050e02e6c8..0a71e5ac29 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 66aa2bfd57..7d9fb76c4b 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 46932d41b6..af891c4ced 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 0bc062a0ba..0045d144fa 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 500c079508..6b879f1606 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 92cb0e87e4..41961e22c1 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 1cb508d542..9cb25608ca 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 f1e8864274..a756bca2b4 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 5652979e53..bb2005f138 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 c57c5e7070..5c6e81a99f 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 56675dde71..8ead524650 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 98db0f9c64..6f50f0b5e9 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 eec6efaefd..41a63399e3 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 e137fc0f23..1d68d86b27 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 2fe4adbe45..a7836be075 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 860d1d51d1..c86e4f9137 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 37f127360b..a6c7471186 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 035e37d49f..2068c4c567 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 80d20f05a5..bd5ac53836 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 15e71df946..deab444346 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/assets/navigation.js b/platform-bible-react/assets/navigation.js index 18f14648e1..3e5766f5b6 100644 --- a/platform-bible-react/assets/navigation.js +++ b/platform-bible-react/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52aa2/bNhSG/4s+p9vard2Wb41jN0FzKWwnQDEMAS0xDhGaFCgqTjbsvw+SLJuUzoXuV7/veUjxTh7/9W/m5avPTrPPWjqfnWSl8E/ZafZYm9wra6qfW+GnJ7/R2Un2rEyRnX767b+TOPBcVrlTZROBMgIPh1sqryUKalUCcWbt8+RJlF66iTXeWQ2hxi4GuZBa5t46DNbrFKb2Hm6hTiFCV63hXjgljK8gROwgUBPhCgjQ/M6ENS0lDThOApmBMINlYGFgM2u9BPvkoDKICykKHNGpDAIdsHuRAnSjcC7MWlKDDPKRWJk/r+wrjOo0LlyrCu7sXiQAOdi7OdmhdrOyZ0iVdxoRfi68WIoV3BN7kQKoqnHg0zQyUCBny8JuzbU0NcgJ9ERM32WXXm44ZOhNxeMzG7AlQr84W5ccsjUlAlM+/oiPvhIrCW4OI1Mi8Jt1XrDEzpWInItC2aSGPDiPQac06d6YCF7IUjiBLGOgMRX8ZJ3Pa3aY9r5UbL1iifUqHZY4mQ7OdPTSqfUa3q1gZyI6kctDp4ZeQkOdwMyU9tLhmFBnMf0X4KDeQaHQkwZ7ylhL35wQb+rNzNnNJXj6Gnpo3JUysmqMd4vZNYKLPDTupt6spGN4sYkGLrzwdTWzDltehh4C98WpAttIe40IvxCbVe3W0jU+fEABNgJ6mVuDsw4qhTAlvJC1AhlYeaE1UXxoIEEv0njr3mDITiQAqvdMbG38xOp6A1YI8qVgm4GRQD3YUqDdsEvAhkYCjB4iuIPDtXDPzZozl6aQDl5ahh4KR5yPEs5F19bJS/NowfCdRoTfiBe1Fo19t6UtpHD5E0RDrBTcTl+9NFUTPrO1ARfQkYkA0oeqpIPUwYQ1euwgUIv2rls7OZdVrX11r+QWHg6wk0ZbrdtKUFdLwEZB2/46EzCqF0lAUwYc3ShsKHHAigwsCB0DgcxCsAFwUFkEuogEMgvpevHcbomtCXYmou/KNHDv47HURWFgYWHEETYysKB7oWvwDSGQSQj5USmf470y6+oKeX0J9UQM/sY1diUi8VEfeyicVlitWoUIrawxcGinDENPslyLqspOM18V71T1Tr566YzQWVgfFNop795TH1MqNLqTqOCt8vBu2SlEKPrixb12tfqZLcDj317kABOBvuSGOouRGlz/9iIHwK9ngcxBmgmAIhoxBUDUgp1grWtutyhhbrd0OJgbaH5nwogtNZAZCLZi9RoTTqzggUxB5KufKanhTuxFCmDXay3RU0Egp0GwRXJgIWFWr+Cj1k4igu/KQnjiMSbUCUxdyekLMjh6LSH8c/VmcorRGmjQN2c3qgLXu4NKIO6la24IF6rCLr6xg0Z5lQuNTbpQT8QQkxCwJUKxSTn0JOKISQrYkpKqypprWwSdKk29CbOqO0MM+4NIEizfyhEO8uDEblJ8c7YMOlcZL92jyGWfsW31GPLh46c4pbURprgQptBhowWk2ELBrmvtVfcg0eYRnH2JD1ABFfFS+DCLfWVzodU/slh415zmDmX4t1LGGe+hd1DGL3/+/v7jBybhOWjorhDUyJewy08i2FBlWW0bnsvHEaYXeEKXumxvcbeD41LPGllSqTTwOBbcXKHIkfpJNthCO1IkppLiLTQGjfdOnDNMjILfSpqPKqlbovlCAt8x/KQv+KGat0OQRR9cx7D3iUSWHzuPKWN/w2bLiJ1HlbHLL/JFhMajStjnBvkyYuuRpez26ZRSQitXSp+YiZ+UO2yopXLA+kUiRzokZUDWQGZpYfLhNs9r56TJ5YgK25Lp3DaMGpNLaG+VzZ9jUPTewTH7JecK23hHBo64e+ZeSD9EHZRUhq3duH8ikSXZ7W6ijb4skDjKIrflqB7tj3zk7vW/acNz6YXSY87IkkyNcgrd4QaavZz/x8oDxwthTS5l4fKE5opcCexhtgSrPuhj+X0KBaZGKsuyzp8r192hRqhQZEndIyZcp0DjOEux+irf2kf00XW3o40dCUwtsbkZiSypfyQCvzNWWVb3PgOTAo3j3O0fNrrT/Ag2MnDE+I0jvix3yLEjkdksAW4joOE2dnDMs9vbrw+L6dV0srydPyyW88ubLw9fp98XB/RL84fnlW6upJg5LuXXaBu8uZ/eLG/n3zk4aByB//4fYiaD4lEvAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52aa2/bNhSG/4s+p9vard2Wb41jN0FzKSwnQDEMAS0xDhGKFCgqTjbsvw+6WaR0eA7dr37f85AU7zz+69/E8lebnCafJTc2OUlKZp+S0+SxVpkVWlU/t8JPT7aQyUnyLFSenH767b8TP/CcV5kRZRMRZDgeCrcRVvIgqFURxBnLd2B0KyCB20a/Z0YwZSsI4BmwGmj9vHhipeVmoZU1WoLVmbkIZMolz6w2IdigY5jaWriPOgX7Oq0B/TyeA0EtmMkhQPM7EdZ8Ka7AkerIBIQYrhMLAVtpbTnYJ6NKIC44y8OITiUQwSlzEDFANwrXTO04NsggH4rl2fNWv8KoTqPCpajgzh5EBJCBvZuhHaqLrT4LVLnXkPBzZtmGbeGeOIgYQFSNIzxNPQMGMrrM9V5dc1WDHEePxAxddml5QSFdbyw+PLMBWyT0i9F1SSFbUyQwpvFHNPqKbTm4OcxMkcBv2lhGEjtXJHLNcqGjPuToPAYd80kPxkhwyktmWGAZA42x4CdtbFaTw3TwxWLrLUmst/GwyMk0OuPRGyN2O3i3gp2R6EguDV0qfAl1dQSzEtJyE8a4OokZWhAGDQ4MFTxpkKeMHbfNCfGmLlZGF5fg6WvqwXFXQvGqMd6lq+sAzvPguJu62HJD8HwTDkwts3W10ia0vEw9CO6LEXloIx00JPyCFdva7LhpfOEBBdgQ6GWmVZg1qhhClfBC1gpoYGWZlEjxrgEFvXBltXmDIb2IAMTgWeha2YWWdQFWCPLFYJuBEUEdbTHQbthFYF0jAg4eIqiDwzUzz82as+Yq5wZeWqYeDIecjyLORdfa8Ev1qMHwXsPCa2lFdyvBTvGADYHesBexY01kv0+mnJnsCQIHrBhcL18tV1UTvtK1AlflmQkB4ie1qNPZaAr1pO9AUGl7ga4NX/Oqlra6F3wPjzHYiaO1lG0lsPsqYMOgbX+dMRg1iCigKQOObhQyFDm1eQYSFBwDjkxCQgNgVElEcGVyZBLS9eK53iP7HeyMRN+VceDBR2Ox28fEQsKQc7FnIEH3TNbgw4QjoxC0UTHNsVaoXXUVeNJx9UhM+OFs7opEhke978FwUoRq1SpIaKWVgkM7ZRp6kmSSVVVymtgqfyeqd/zVcqOYTNz6BKGd8u491phSBKM7CQveCwvvlp2ChAaf0agntFY/0zl4pjyIFGDBgs/Drk5iuATXv4NIAcJ3PkemIM0ECCIaMQaA1IKcYK1rrfdBwlrv8XAw4dD8ToQhW6ojE5DQijVoRDiygjsyBuGvdiW4hDtxEDGA3u0kD54KHDkOElokJxYUpuUWPmr1EhJ8V+bMIi88ro5g6oovXwKDY9Aiwj9XbyrDGK0BB30zuhAVuN6NKoK456a5IVyIKnSb9h04yoqMydCkc/VIDDIJAVskNDQpp55IHDJJAVtUplZoda1zp1O5qgs3VdsbfNgfSOZh81bOcJAnTGxz4N+MLp2+Fcpy88gy3qfIW9lHfPj4aZZFRiijjmEWuiiYyi+YyqX75R2Sb8Fg7b2+eyppMxxGv/inMIca8KJNdvLrVzpjUvzD89Sa5kg4lmHfSu7n4qfeSRm//Pn7+48fiFTs5EN3hQSNdAl95jSAdVWS1X7Dc/44wwwCTejeYNqr4O3kzDWwZpZYKg48jgV/LlekSMNMnezDHckTY0n+PuyD5htwmDNN2YJtRc1HldSt83Qhju8YflQLfqjm7RAk0aPrGPYhxUnyfecxZRyu6WQZvvOoMvrMJ12EazyqhEPWki7Dtx5ZSr/Zx5TiWqlShpSR/9jdYV0tlgPWzxMp0pguAlkTmaS5aZHbLKuN4SrjMypsi6ZT23DQGF1CezVt/rYTRB8cFHNYcq5CG+/MQBH7t/KU2ylqVGIZujbz/vFEkqT3/USbtcyRKEqa6XJWj/ZHOrJPITTf8JxbJuScM7NEU73ERHe4gWYv5f+x8sDxglijS0lNFvG5PFcEe5pyCVUf9JH8IQ8DUz2VZGljz4XpLmIzlCuSpO4lFK6To1GcDdt+5W/tS/zsztzR5o4IpuShuemJJGl4aQLb6askq3vkgUmORnHuDq8j3Wl+BpsZKKL/UOLfuDvk3BHJbJYAUzBouM0dFPPs9vbrQ7q8Wi42t+uHdLO+vPny8HX5PR3RL81fsbeyuZKGzH4pv3rb4M398mZzu/5OwUHjDPz3/53RSJltMAAA" \ No newline at end of file diff --git a/platform-bible-react/assets/search.js b/platform-bible-react/assets/search.js index 546225dbfc..829785f1b1 100644 --- a/platform-bible-react/assets/search.js +++ b/platform-bible-react/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dXXPbtrb9L+qr62qD33k7zcdp5rRpJ05750ymk6El2uZEFn1Iymna6X+/A5CUNoAFaVP2mXufnAjAwiawsAHsBZB/LdrmS7d48fGvxed6u168SOOLxba8rxYvFt83zeeXd+VDX7Uvm23fNpvFxWLXbhYvFje77aqvm233nZ/p8q6/1zlXm7Lrqm7xYrH4+yIAf1VtqlXftAHgKfkoZKQOkD///K9PV69/fP3yw8/vP119eP/23T8//ev1v6/2+I9lW5fXm6r7Lpj3aGU5ML9utj8162pfR7Xd3XP7x/SjuJTugV/++v7963cfPmkDRZjfOCVYBReLh7Kttj20F9f+w88/X702UFfC2u0S82tXyyKjREFi/Nisyk39Z7W+6tt6e9vtTeq/PlQ2SdysUh6+Kvvyg+YEIOE+7SiY+wAvm83ufvuqunGs3f8+C+1980WPrGrbu0/PUmYhXjVt/6puh85wMK20WaimnQKWWmnSjnm7fay2fdN+BR2zT5O6hrfvfnv97sPP7/99wi3AfLPaYW/aCe4G883ry1XzULl9qH+TtvJt1f9Yb6vuTdvc/3r15ifQ2G6WGdDvdvfXVXsc284zA1yP/ne7e13y7RpjW1lmQF/1Zb/r3jTt2766x9BWlvMYYoaF9jEhauwzHDc9SaKDB//0SYPIEL/ZZ8ZuG1jKZo2lOrRZ3Vf3QYbDSi+nItKqL0djAxasmt22n2fBVOSZLOgMI+aZsC/zTDY0q9WubavtqpppiF3wfGuCZNfD5Od9JSHj7FzPRnsAK+a+Y3ig4dvqppr7ZFPb87KzjDlBhr76IzgijpgzFnuiJcyh1rzMsAoCPhXkknrsfdGXekSfroFlm13F4PdP18HzSSt5Vz7Wt6UGGhdLV1XZru5ANYGcc1ds/6q+/lZudtPazF+2ORmeOiADiKfGIrA0QPnP1ddZVV4OBaTVnhhwjzrrvPqnIs9kwWpORx7mwanQ+VYwFl+t2vqh37XV+6rbbfrut7r6UqE9Ps44b3c0lLyq3Ec+JDyVsw7SKa4yi0LrhGbXevMEruVyn/dUZSd4sfZXmYEax5zz6wt1zbGnNWnP1UEHMGkfDaaFlrRraT2XJqugqlOdVHcPm/LrO/0/adV2mbNs8PeU47DUE/Grqi/rjWMOyDFz14oG/jBXvt3eNKHqAtmfSiAR/ilOnXymkDc4lBtXgUMZwII5dl6ewD3vIU7tgKbiet/9z7bZPTzbU7iI/xX7ddrztL6H9F+xd22GXvc8JiOw57Ja5gB+aZsHd9t6JOd5LueqXZ32a1Ym6er9atU2m40h6RFhA+Sa+yBu+UC7wWzP4CvDuAIfiW0P8Lt8LOuNjjWwgm/Xsx51YncYap6ppz3gAf0cO12AZ7Wu2b68K7e3dhucY2UI6KnWPhMBsX1jdd/SuYYGHjvQ2Jvj8X/RcwCMJzcxc1hV32vUH+uuR56KJYt9ICvzQ1Wu8b7Py3QOfCA072aRQo8q9nvTv2H3jbLNUwcBAHLgwXxP9eDHgU+58LD54ah424+lzrHk0gGYadYJj1ht10+xzSr+vJbdldv1Zixx9dQ2PAL2ZKufi3JBIye/HZ1tbfj5BY3/+mkUCUL9/2z4g4mnp8tZzc6ePRRw6V7VnV6iuUsS2VNYxZ93LK6mE06+xCizzQF4etfzeatafd7gGXyfNnOGGkvhaYknPn0u8tBOT0CWddLgXbimY9E7p9QJlmgIsAs/UjUv8gwWbMY1j6DT9itMVuQZLOgMb6v1j/MtQUWfwSLug7xl40mjAqXPs+tJAwKaIpkagU34sUK0bquyr34srys3XHKM2Fah/4vmYhZIZjLUSvwhsO9t7q+b75s/kOsdk2aeHBwKmSp/fgDn80COJ/vgAORJRwyMDfklRJ7j1V5ujnMHlD4ZdZwKwXmNp53VaUf7S9JVh/b6Z1uvf6q2O8CrKWmWiVMh9OBW2lmoQLHhSU/lp4d1ipiWXQFG3u82fT1ErK2GPl7lpV/stAlHV28/lPfXu/a2anXu73d936BDJSDX8Z5KDm36k23yL23zWPOwTL3tq/amXFXdd4Gs4gO7q2YbfIRD4ryzkvtiiLtOqtRQ0zM4ejQliZv3ZXN/X27XP5gJFbaqnWPW00/W/BhYjHvp8jiaPi30fYmjc2PaPFliKgXFCCvxyRKEj3ZSeLCtC4bHnfNWp+q7ZCUkFZ8X8D5dvSCyjew4mB9okIdNuarums3ai30cMcoudF6zOHGBN7vN5n/qdT+jZ+xCZ3YOGzAP9XaLg9lDyrzBMpSBQ4UlSUfzh+qP/k1dbdAh+H3avKOBUylkop345COBPtrJ44C2ddIQQLimYyEAp9QpqgZCWMfqPh23mmXDXdm9btvGHbFHLGAlnqUNQsP1aCOcHq7zWqHaPFTtB/8E9LF24GWewQa07TlS/fEdz6yaw477SP0Sxz2TCe+r/+zqdt5oYGWewYZQUO6ICaeDcrMsWFc35W7T/4bOBoeNcEo9gx3wcHLYgBMHk+fUPMnm8spZiWep/02z8m7mHK1+KvAstX+/2c0Yhvv859XN1wVNs7mGa/wxZd6aYCgDVwQsSbpo+cemapFmYX6fBfKh7uHt3UPiLLhX1XDosIb7WDeLFDq4MZ65nUebYbbZlO6G7WNW3cu7mq0ej+B9c8iL6cntCzqiti6ZkHasukPeQ3V9t/627r6tt3dVW/dmophTfVf/WYnqHjM+pWJGgGuT4bfheTpABDuD+NhK2aJlv/55DkTwrM4hcQ7cm6bpg3BD4hy40Ajfp80BOz6+nRxzgN1LVDao6AaVI+teY2lhTBLH5bYPO2SV+V0KYus/B5BBYBGCvC/XdWMOqQGkQ+J8uEA0z84gD449lG0ZOL07pYnBNnXgENxmTmz16kvdw4uAQ4I4UlBeI9ejf54DETgwOCXNgQoPGpY6B/BDW9/ewhZnqVLA36q2r1flJtBuPPkcyEA7ulnOgQ63K8h1TgXhdga5xB3Y3N5uqpCHYKlnAAZ8hJND7lS7vtxswnoHT5eCvt7qOFAQkydLIcfYUhDTSpeC/vqwLvswJk8WazJl+3ndfNm+r7brqoW8crNIod/Um75qX7XNgy4NgO0MR2EPL4Cask8azAce2hzemISyHF+Vp/b8L8X7ZsqN1+TQVFirmTDFtU65z6rV3V5O2cH5HJ701HCzh3Uq2GzZNSPQF6roRJjPKnYivOay7kTFLP+T6262Lzc1I+iJqg/Zz6n5Cd061XxaIQMm7M0+zVp7yrJtEkxY8gc8gEmJO5h2BnO9qoTUHcqd5q4bRQrXe/xVQSfq9WaC4LzFk6WTy7vm9R99te00wJtmt0WbcS+PeFJs2so6XcMmwzFpxtJN1/9D3QVeqWZnmBUZHItqc9r7EpyC8jM8dTgEEE+NCWBpKGpf9vPqvBxLSCs+qRr4UQqZGVbB860JdPLIDzDv+BnEC7RQtGhepGjXVa8f8Z5nSpoL9Y/u63Z1BM+kzwD9pW3u6w6Fsg6Js4ber/tiwwlD16d66U8deBjw1LjzzQwJl23VVe1jhdSyo1VfuiWFhhydL1ZolljJ915sBXx117T9CsbhUDZ58B69NESA/Y3kxSHwAU4+6gkzzmm9cLAB5DqnglDIwctzDvgvTduXKHjqZzqLWrvrUz2/uz4H+Gi4Fmec5bwcE8fuQwLjkZxPqXEMfwlq5DnPrlFY3bPUpbcxpyra5zn/iUYpQlKbl/fsWg3dJFXaGc+uz2gcp+o6ZDqfkZO4cJKQVsbz6xtd+snqeL4zPZTMgx8ynllNOOyNM55TjayOJ1QQiFS7Wc6ynQ3CUw/Asp49ewjq2ec7p5KQLOnlOYtPR4RAmE+uMOqLd1Be1AnzYEITNEudB2ivvV1AkzoPMDz2rfR5oOFRaKXPAw3RiaXOAwy+pGRKnAd3XJq2cswENu+P+fUhGBtD2c6p4lXzJXxJCGcUV9OEjuibhG9phowMj5uc/hSECxI8VsNSZwF+36xR8G6fNgssGHdhqbMf99jDzgJ733wJYb1vvsyCellt0Kjep80DK0Nnh3gygvz9YlFv19Ufixd/LR6HaNnixUJdRpfF4mJxow916m/xDLVdLFbN/f3g4dbNamf++fuY7Tfzcgidecj93XJx8XF5kdAlpb//fvFxKmt+Nz9MEIdfTDlaXHwkUI68cmSVU4uLjwqUU145ZZWLFhcfI1Au8spFVrl4cfExBuVir1xslUsWFx8TUC7xyiVWuXRx8TEF5VKvXGqVyxYXHzNQLvPKZVa5fHHxMQflcq9cbpUrFhcfC1Cu8MoVdr9rGhBiDPmUIYczhjSQNYA2Nm9I04EQc8inDtncIU0JQuwhnz5k84c0LQgxiHwKkc0h0tQgxCLyaUQ2j0jTgxCTyKcS2VwiTRFCbCKfTmTziTRNCDGKfEqRzSnSVCHEKvJpRTavlKaKQrxSPq+UzSulqaLoQkWXSuV2YZ9YynFIxiOpizi9XCbKLgycks0spcmiELOUzyxlM0tpsijELOUzS9nMUposCjFL+cxSNrOUJotCzFI+s5TNLJWFW9qnlrKppTRbFKKl8qmlbGopzRaFaKl8aimbWpGhFqJl5FMrsqkVabJEiJaRz6zIZlakuRIhdxf5xIqc6c7Md8jdRWDGs4kVaa5EcLL0iRXZxIqSYAdHPrMim1mRJkuEGB35zIpsZkWaK1GChmHkMyuymRVpskSI0pHPrMhmVqTJEiFWRj6zIptZsSZLhFgZ+8yKbWbFYacV+9SKbWrFhlqI0rFPrdimVqzZEiNKxz61Ymc1ZZZTiNIxWFDZ1IrD1Ip9asU2tWLNllhdxOoyzTO7sM+t2OZWrNkSR4hbsc+t2OZWrOkSwyWkz63Y5las6RIjNx373IptbiXLYHMlPrkSm1yJpkuMBkTicyuxuZVousRoQCQ+txKbW4nhFhoQic+txOZWYriFOJ343Eqc1bpZriNOJ2DBblMr0WRJEKcTn1mJzaxEcyVBbjrxiZXYxEo0VxLkphOfWIlNrKQIk8NnVmIzK9VcSRCjU59YqU2sVHMlQYxOfWKlNrFSzZUEbo58YqU2sdIo+MCpz6zUZlaqyZIgRqc+s1KbWalhFmJ06jMrdfaChlmI0SnYDtrMSjVZUsTo1GdWajMr1WRJEaNTn1mpzaxUcyVFjE59YqU2sbKwy8p8ZmU2szJNlhQNh8xnVmYzK9NkSRGjM59Zmc2sTHMlRYzOfGJlNrGyOPzAPrMym1mZJkuKhkPmMyuzmZWl4Yp9amVOqMFQK0PTYQbCDTa3MsMtNB4yn1uZza3McAuNh8znVmZzK9dsydB4yH1q5Ta18vBSK/e5ldvcylVw5ZH75MptcuWaLxmhps59duU2u3LNlwwNxdwnV26TK9d8ydBoyn1y5Ta5ck2XDI2m3OdWbnMrD28Qc59buRPL0nTJ0FDMQTjL5lYenhFzn1y5Ta7CkAsNxcInV2GTq9B0ydDkUvjcKmxuFSpodOFzq7C5VRhu5RdRfkmpTczC51Zhc6sw3IIBQJ9bhc2tQtMlR0Ox8LlV2NwqNF1yNDUVPrcKm1uFZkuOxkPhU6uwqVWYOCkaD4VPrcIJlYapVYBwqRsv1XTJYQBxiSKmTsh0qRmTwxjiEgRNl07UdKk5k8Mw4hLETZdO4HSpWZPDSOIShE6XTux0qYmTw2DiEkRPl074dGmIBuOJSxBAXToR1KWmT4FD1SCGunSCqEvNoAJGq5cgjLp04qhLTaICBqyXIJK6dEKpSxOghzHrJQimLh3WUXgpRihQ70XqNY8KyFoYq3doR2HHRihe7wbsTRC+gNEgQjF7N2hvAvFFissD5rmBexOMLyDvUejejd2beHwBeY+i92743oTkC8h7FMB3I/hDCH8JiY+C+G4Un8L+jlAg34nkk4nO4xUTgWA+OdF8MgF6vD4lEM8nJ6BPJkZPSzhyQUifnJg+mTh9gDwgrE9OXJ9MrJ6WWKsC5HNi+2Ti9XhiJxDeJye+TyZmHxg8IMRPToyfTNieltD3gCg/OWF+MqF7vOglEOknJ9RPJnxPS+h8QLSfnHA/mRA+DiUTiPiTE/InE8anJZxzQdSfnLA/RQP/4KQLIv/khP7JhPNpCb0PiP6TE/6naOAfdD9AASBHAiAT1acl9D9ABCBHBSAT2SesEQMhgBwlgExwn7BODLQAcsQAMgF+wlox0APIEQTIBPkpoBcD/jmiAJlAPwU0Y8A/RxigeJDJIf+ANECONkAm3k9YOwbyADn6AJmYP2H9GEgE5GgEZOL+hDVkIBOQoxOQCf0T1pGBUkCOVEAm+k9QSyYgFpCjFpARAEhB/gG9gBzBgIwIQAryD2gG5IgGZIQAgqoyAd2AHOGAjBZAUFkmIB2Qox2Q0QMIqssE5ANy9ANKhqMakH9AQiBHQ6AkvLElICOQoyOQ0QYICs0EpARytAQy+gBBsZmAnECOnkDJwD/IXyApkKMpkNEJCIrOBGQFcnQFMloBQeGZgLRAjrZARi4gKD4TUBfIkRfISAYEBWgCCgM5EgMZ2YCgjkxAZSBHZiAjHVAE+QuUBnKkBkqH40L47A3gn6M2kFEQCErKBAQHchQHMioCQVmZgOhAjupARkkgqA4TEB7IUR7IqAkEFWIC4gM56gMZRYGgSkxAgCBHgSCjKlAM+QdECHJUCDLCAsWQf0CHIEeIICMuEJR8CWgR5IgRZAQGgrIvAT2CHEGCjMhAUL0loEmQI0pQNhxZw+e/AP8cXYKM1kBQxSUgTZCjTZCRGwgquQTUCXLkCTKKA0E1l4BAQY5CQUZ1IKjoEhApyFEpKDuy/wVCBTlKBQ1SBZ6/gFhBjlpBRoAgqCoT0CvIESzIaBAElWUCkgU5mgXlYa2VgGpBjmxBRoogKDATUC7IkS4oDx8UIaBekCNf0KBfBNof8M+RMGjQMOCJQAIiBjkqBuUD/+D4B0IGOUoGGXGCoFBOQMsgR8wgI1AQ1LsJ6BnkCBpUDPyD4x9oGuSIGlQM/MPnQAH/HF2DiiP8A8oGOdIGGbmCoHZOQN0gR94gI1kQ1M8JKBzkSBxUDEd34fgFKgc5MgcZ6YKgFE5A6SBH6iAjXxCUwwmoHeTIHWQUDIKSOAHBgxzFQxkJg6CyrYDkoRzJQxkNg1J4UBRoHsrRPNQyHHxWQPRQjuihjIpBUONWQPVQjuqhlgP/EP8VkD2UI3soo2MQ1LoV0D2Uo3soI2Tg424KCB/KET7Ucjg+jvivgPKhHOVDGSmDoHCtgPShHOlDGS2DoHitgPahHO1DDVcUoICtgPahHO1DDdcUoA6tgPihHPFDDVcVoJysgPihHPFDDdcVoKSsgPihHPFDDVcWMshfIH4oR/xQw7UFKA4roH4oR/1Qw9UFKBArIH8oR/5Qw/UFKBIroH8oR/9Q4xUGyD+gfyhH/1DDNQYoFiugfyj3JoPRMwhKvgpdZnBvMxg9g6Dmq9B9Bu9Cg+EfFH0VvNLg8M/oGQRVX4WuNbj3Ggb9A8q+Cl1tcO82GD2DoO6r0PUG936D0TMICr8KXXFw7zgM+gdUfhW65eBeczB6BkHpV6GbDu5Vh0H/gNqvQrcdHP1DGT2DoHirgP6hHP1DDfpHAfkH9A/l6B9q0D8KyD+gfyhH/1CD/gHVVwX0D+XoH2rQP6D8qoD+oRz9Qw36B9RfFdA/lKN/KKNnKKi/KqB/KEf/UEbPUFC/VED/UI7+oYyeoaD+qID+oRz9Qxk9Q0H9TwH9Qzn6h4qHq1z4ZhPgn6N/qOFmBNTfFNA/lKN/KKNnKKi/KaB/KEf/UEbPUFB/U0D/UI7+oYyeoaD+poD+oRz9Qw0XJaD+poD+oRz9Q8XD4VDIP6B/KEf/UPFwhg/yD+gfytE/lNEzFNTfFNA/pt/MJefHqu2r9dvhsvPHj/tXyf21+DTegFY03ar+a6Fo8eKvvy8WKhv+RsnwNx5/j8f/J8vxbzH8TaPhbzb+nsXj33T4m4/l8xE3H8sVavw7/l8fmxn/oaZ/TEnZ9I88mv4xWqM3rIPZS1Pq78ONbfPz1DImTTdVOXzx5tAGWlzdN4LWT8Uo1kseOaDigLkcsB++sMGhiENlMqhuNXwchuMkDGfo0dM4j2W90ZfpO/MqiFv9DpN63XHcJD7ApksR6nXTfP40fGW+aT91fVtvbz99rr5auKwBZb2qUVd35UNftatm27fNhsOxDpYbOdhYN9v7Zm11SnRAi2ai6VeGsF5hfTIbaNOsyk39Z7UemtBqvpT1igx4fBcIZ0zEmVfMgHkYXmTFsWLOPmEXGKzH/Zd6OFzO4WIR3Mp8oYeDFBwkEYOspjfeMCzFny+RPZ/GCjkQxds+lrW9xrsZXyXCoTjJYpkD0VB34ztTOBT3k7GMWBrK92qKO8hY5iD3o3tnN37KyJDNgmr1t+3QuExZm6XnQ3rjIGWPnQp7dfikAGu7mPM2E/bC/jNGvBP4lJDIHJAB2pjvpbDHYhZlMx5L43htlDGS5cKRdNc0XfXJOEdrcjogCYe3fkuMKcINYmTYrz6UkBX2sOYNpQOVIgjzIfh1dcORGOWFhjT3141DgIzNEoWwpUcY8wb6xvNbWcYQhYQaEX2wnBGhEPbfCOaTijV8IW138734u+mL8gewgrvBpXAA+pNGxJpfuEb0fB+fJ5RsLbJqq7Kvxk8IsBZigyUXWrNr9QuKzbjjUGwulDX1uuxLC4A1cCx7Kg3RD+8LY8/E3JIUxZ6nUt7VQuKMn4x9HF7fx8CWfJGgZH4ytEDgMxQJR8e66st60w0OxfVyfFZJhA86fLMILB1j/qSZzBGML8L27GIMj8cNpBIOuvX4csjb4dWMzEC+bdGK+Ry02rxLkIPxvhCuQCawe/OibgbGZxutBc0Fm2Z6z0rutXSQ9inA/gI/t+IIZ5gNFtV5zi2e10kM0zeWzwZab5kL7PMp4354KRzaDNHrrZybqOabGOglzgGazwGN6kaQ9NEmRv/5pnpTkQ72s4efP6AMInh63kk0v5MexvfH836POaRsDcUhW/3SXUCnlMPKAiAerO8B+BhV88foHhU0Le8xmt9j3eGFqtxg3mHSCROhAoN5x6n5HdftvyPBu40Pr+X8kTCBAnMTbq5wQuXI+tsE3FKOR2fhQY+dcTOFKzcIC5w2nw1o/mzQ7a776QXI3GQ+1NT8oXaABSbz5qD5zYHszfhIW8pGWrUNrdN4mCmTjYJqux5jHVYIgI2nTNaKN+YzX8CqhMclhHuRAWxqPPshM/6QMuKAOFrK26qQec/bqtebo+3u/kZ/7caOP/JpU/aQt1W/qbdVp8F23Y3t3RmPhTP7bdVvd/fXVQvxrFaT4nV92e+6m6b1Jx/eejK4tl67y2O+zCyETznC1OYDbgyK9WchbP8RyhvpfPoTUuOuvL/etbdVqwH9QcAdvn4NgQxShyqG4GNglDKSCFdqHFTH69yO5SugXNYjHLLry7ZHlrLnz2Se867sqrZ1lhBLvjcTuve7avOghdM/7MltyWPWwu1IvWq2oHP52FrKnu6A5LOPexJhVNH2RTF7tHhSbScNVrg6qofP2/P4MndJiazt6+F7zWiu4s0vDJ5rBXw7fGiR28X7cR5OSK60tbJ5mCaoNwRlrPAgW0xGMgewh9SD1EdUzAdH0k5liM1qiPit7BMEfAElcwB71GMSpi0ZzsMdpiHQpswbRDO73kQX3Uilslb8MsBujJtZIzDlscpsGnnCbu9udpvNl3rd31lhaj78KJ4whezs2uo/u7q1rdSvMWBjRzbTjV+NZY1mbe9Hu3I5mBeBSPiIzmWN9rmynELE2CY8AeKH0JkfLvZC0XRMJdkfXJlOuQiny2nWtQUN9sjC+OWxwZYw+qUyuPvxM/Dt/kvxfOxy7gnnbxQH42EwEu6oJxyoLvIYCAnDq/dNW7mrR+ItRkL17H636evBK3kLW+7tlmfBPbTNY+1I9nx3S8LzUdvysb41X6Md9+JdVbYry7VEjH2RrHe3TbX/+PLN8IFm3prczlw2uR+mI9u78NCGjDHN9nqzc9aNvHuFj9hsV3da/reB+EJeOI9PQNaxK2u48vM9sl5ttqvh0++81bk3z6U4N81qZ8/US957wnm12fq0KvggEEalHjblqrprNg7xC97stHfGMo87fcPWl/D4WRMlXLmbsKnd7lxVzGROKBApVpynQt3uAOXt0hXfSiSy0dNWN5W/KuShL9nuuq263abvuspWyZlFwoNjE1Cza22jYub8hafG2ubL5AUterGZXoTTrRp30cJbWoihleBdW+mYkuk/TyxlrS7ccO1BNRcGhdhC5GK+rB/3iHtiBBRn5jWEp48YtOnix7r6Yo/7iLWA8MwiBh1sdqf9mPWa8FgehvcWJtwnCAfeHrlrV7j3uDKdyHxfeM5hj56Ku2vCQqfs+LI9kXlBgOi3JJvVEiFlzVR0XdpTCN9VCCPteyB/4cnnWqFC3I3fp+RhVK5bCTfxAwzSawo+nUUyjzjGF9d4W8KeMhey2OD5MxufwZVw4TSe2HZmNX15iEEJx8EQ8fS1aS7MR3MeceCu3jL50S21tA5yzaHHALt7QKB8oy08YjaCIj1W8WCqEt5FGPCQklXwJYJwiT2g+esyHutQwhUo1px5kIykPrPqe72jds/FJmx4pVKqHKD8E9gJMy6db5s7MPjptlTYnfWfzv0UvgAVHtbrNu4+lXi0k6STwfihUc5Q7h6Fy8Wuaft13Q5XPex9DXfZQix3zRmxLouFxHyo3QfjY4Wky8UBxp+J+BpfKBUGZRrmtoTn/IbYrNVrVqfJQL7Uvb13JB7bJeG835fXn6uvxp2gA7r8no/MLu8IquL7fyW8d2VQrs0nZjkS95fCkWaQVqV3flRxEUQJF/YDmPmGK0fik4LwfsmABPZV1m23GY3l6/X6xiiza0b33Zmv53IkPuULLwrtkVyr+EQl9AcGq9Wf4eXNztc0wrs4fXntqFZ8iZvIVh0aBK0leQSdhBsEjeVOmsSHHQnvFGogtMaI+C5bGClzhV8eExEeQtMQ5gPBlt/lKwvhkYo9kH+4iC9qSXiApG9ubzeVv9bmB+5JuBJgWF4YiQdaSHiBqm+ajbMDIz6GSeqCBxzQYLz9hSt3LTUFohfMtETmjHcP+n4BkrY5S4Wnp3ZdVT26Y5CfwiLhoZYJqOy+blc2GjerkDFfn7nUR506J27K3Z5Q3jhADXeD7N7kgqkSHpDx9g3cPUST6ircVY8XU+3ZiwfChd59/AL5Xd15BxX4/oGE96lsOE8q5TcQSXiCaoTUsbD2vvRWyYl1tEv80H29Kjf+jGQdY5ONKw4GZybejMJ9GMf0Zyi+GhfKpRwQzlS8FSV7u98vFg/1Q6UPBC5efPz977//F/+lh2dF5gAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dXXPcNrL9L5NXrXYa/Pbbxh8b1yZ2ynJya8uVclEzlMTyaKglOXKcVP77LYDkTAM4mGmOtHXvk+wBcNAEDhpAH4D8c9E2X7vFi09/Lr7U2/XiRRpfLLblfbV4sfi+ab68vCsf+qp92Wz7ttksLha7drN4sbjZbVd93Wy7v/uZLu/6e51ztSm7ruoWLxaLvy4C8FfVplr1TRsAnpKPQkbqAPn+/b8+X73+8fXLj+8/fL76+OHtu39+/tfrf1/t8R/Lti6vN1X392Deo5XlwPy62f7UrKt9HdV2d8/tH9OP4lK6B375y4cPr999/KwNFGF+55RgFVwsHsq22vbQXlz7D+/fX702UFfC2u0S82tXyyKjREFi/Nisyk39R7W+6tt6e9vtTeq/PVQ2SdysUh6+Kvvyo+YEIOE+7SiY+wAvm83ufvuqunGs3f8+C+1D81WPrGrbu0/PUmYhXjVt/6puh85wMK20WaimnQKWWmnSjnm7fay2fdN+Ax2zT5O6hrfvfn397uP7D/8+4RZgvlntsDftBHeD+eb15ap5qNw+1L9JW/m26n+st1X3pm3uf7l68xNobDfLDOh3u/vrqj2ObeeZAa5H/7vdvS75do2xrSwzoK/6st91b5r2bV/dY2gry3kMMcNC+5gQNfYZjpueJNHBg3/+rEFkiN/tM2O3DSxls8ZSHdqs7qv7IMNhpZdTEWnVl6OxAQtWzW7bz7NgKvJMFnSGEfNM2Jd5Jhua1WrXttV2Vc00xC54vjVBsuth8n5fScg4O9ez0R7AirnvGB5o+La6qeY+2dT2vOwsY06Qoa9+D46II+aMxZ5oCXOoNS8zrIKATwW5pB57X/SlHtGna2DZZlcx+P3TdfB80kp+2m36eljQvmzur5vvm99BFSCXtIJ35WN9W2qYcTV2VZXt6g5UEsg5d0n4r+rbr+VmNy3+/HWhk+GpIz6AeGqwA0sDY+pL9W1WlZdDAWm1J0b0o846r/6pyDNZsJrTkYeJdip0vhWMxVertn7od231oep2m777ta6+ViiIgDPO234NJa8q95EPCU/lrIN0iqvMotBCpNm13kSEa7nc5z1V2QlerP1lbKDGMef8+kJdc+xpTdpzddABTNpHg2mhNfNaWs+lySqo6lQn1d3Dpvz2Tv9PWrVd5iwb/E3rOCz1TP+q6st645gDcszcFqOBP0zGb7c3Tai6QPanEkiEf4pTJ58p5A0O5cZl5lAGsGCOnZcncM97iFNbrKm43tj/s212D8/2FC7if8V+nfY8re8h/VfsXZuh1z2PyQjsuayWOYCf2+bB3RcfyXmey7lqV6f9mpVJunq/WrXNZmNIekQ5AbnmPohbPtBuMNsz+MowrsBHYtsD/C4fy3qjgxms4Nv1rEed2B2GmmfqaQ94QD/HThfgWa1rti/vyu2t3QbnWBkCeqq1z0RAbN9Y3d/oXEMDjx1o7M1xgUH0HADjyU3MHFbV9xr1x7rrkadiyWIfyMr8UJVrvO/zMp0DH4j9u1mk0KNM/sH0b9h9o2zz5EcAgBx4MN9TPfhx4FMuPGx+OOze9mOpcyy5dABmmnXCI1bb9VNss4o/r2V35Xa9GUtcPbUNj4A92ernolzQyMlvR2dbG35+QeO/fhpFglD/Pxv+YOLp6XJWs7NnDwVculd1p5do7pJE9hRW8ecdi6vpCJWvYcpscwCe3vV83qpWXzZ4Bt+nzZyhxlJ4WuKJT5+LPLTTE5BlnTR4F67pWPTOKXWCJRoC7MKPVM2LPIMFm3HNI+i0/QqTFXkGCzrD22r943xLUNFnsIj7IG/ZeNKoQOnz7HrSgICmSKZGYBN+rBCt26rsqx/L68oNlxwjtlXo/6K5mAWSmQy1En8I7HvDKrBI+vWPJg6FTJXvH8ABQJDjyT44AHnSEQNjQ34Jked4tZeb49wBpU9GHadCcF7jaWd12tH+knTVob3+2dbrn6rtDvBqSppl4lQIPbiVdhYqUGx40lP56WGdIqZlV4CR9/qQxhCxthr6eJWXfrHTJhxdvf1Q3l/v2tuq1bm/3/V9g06tgFzHeyo5tOlPtsk/t81jzcMy9bav2ptyVY0nV/ys4hPBq2YbfIRD4rzDmPtiiLtOqvgcj+4ZHD2aksTN+7K5vy+36x/MhApb1c4x6+kna34MLMa9dHkcTZ8W+r7E0bkxbZ4sMZWCYoSV+GQJwkc7KTzY1gXD4855q1P1XbISkorPC3ifrl4Q2UZ2HMwPNMjDplxVd81m7cU+jhhlFzqvWZy4wJvdZvM/9bqf0TN2oWewIrS7O2LD6d3dSXqwIftQb7c4nD6kzBuuQxk4WFmS1J98rH7v39TVBp3z36fNO5w4lUIm2olPPpToo508kGhbJw1ChGs6FoRwSp0aLIEg2rG6T0fOZtlwV3av27ZxfcYRC1iJZ2mDkMM42ginHca8Vqg2D1X70T/kfawdeJlnsAFtvI5Uf3zPNavm8NRxpH7J1DGTCR+q/+zqdt5oYGWewYbQxHHEhNMTxywL1tVNudv0v6LTyWEjnFLPYAc8Hh024MTR6Dk1T8K9vHJW4lnqf9OsvMtHR6ufCjxL7d9vdjOG4T7/eXXzdUHTbK7hLmNMmbcmGMrAFQFLki5a/rGpWqSamN9ngXyse3hB+ZA4C+5VNRx7rOFO2s0ihf6+XN8iI83v4v2uyW33ANvrHlKPAjpeoa1LpquF4b47ZD3A9t36b3X3t3p7V7V1b5z24V77wVjYJNc6/dcBtANNY6WL2zkUApkZuEFhD942wriHfaCue3lXs1X6EbzvDnmxG+D2ndG1bnWz+/Z09V39RyWqe8z4lIo5q0yGY7SyMogPKJUt2l7pn+dABE9lHRLnwL1pmj4INyTOgQt50n3aHLDjftTJMQfYvS5ng4ruyjkC/jUWkcYkcQR2+7BDVpnfpSC20ncAGaQ0IciHcl035jgiQDokzocLxG3tDPIw6EPZloFz2lOaGGxTB447buZE0a++1j288jkkiCMy5TVyPfrnORCBo6FT0hyo8KBhqXMAP7b17S1scZYqBfy1avt6VW4C7caTz4EMtKOb5RzocLuCXOdUEG5nkEvcgc3t7aYKeQiWegZgwEc4OeROtevLzSasbPF0KejrrY63BTF5shRyjOEFMa10KegvD+uyD2PyZLH6VrZf1s3X7Ydqu65ayCs3ixT6Tb3pq/ZV2zzo0gDYznAU9vAusSn7pLZ95CHk4eVbKMvxVXlqz/9SvO+m3HhNDk2FtZoJU1zrlPusWt1t/JQdnMTiSU8N63tYp4L6ll0zAqqhik6EU61iJ8KYLutOVMzyP7nuZvtyUzOCnqj6kP2cmp/QrVPNp7VQYMLe7NOstacs2ybBhCV/wAOYlLiDaWcw16tKSN2h3GnuutG6cL3H3zp1ol5vJgjOWzxZOrm8a17/3lfbTgO8aXZbtBn38ognxaatrHNUbDIck2Ys3XT9P9Rd4O18doZZEdixqDanvS/BeTc/w1OHQwDx1JgAlobUkbKfV+flWEJa8Ul1xo9SyMywCp5vTaCTR36AecfPIF6ghaJF8yJFu656/Yj3PFPSXKh/dN+2qyN4Jn0G6M9tc193KJR1SJw19H7ZFxvOkro+1Ut/6sDDgKfGnW9mSCBuq65qHyukSh6t+tItKTTk6HyxQrPESr73Yivgq7um7VcwDoeyyYP36PUwAuzvJK+IgQ9w8lFPmHFO64WDDSDXORWEQg5ennPAf27avkTBUz/TWdTaXZ/q+d31OcBHw7U44yzn5Zg4dh8Sco/kfEqNY/hLUCPPeXaNwuqepS69jTlV0T7P+U80ShGS2ry8Z9dq6Cap0s54dn1G4zhV1yHT+YycxIWThLQynl/f6NJPVsfznemhZB78kPHMasJhb5zxnGpkdTyhgkCk2s1ylu1sEJ56AJb17NlDUM8+3zmVhGRJL89ZfDoiBMJ8coVRX7GE8qJOmAcTmqBZ6jxAe+3tAprUeYDhsW+lzwMNj0IrfR5oiE4sdR5g8HU0U+I8uOPStJVjJrB5U9AvD8HYGMp2ThWvmq/h62A4o7iaJnQVwiT8jWbIyPC4yemvirggwWM1LHUW4PfNGgXv9mmzwIJxF5Y6+3GPPewssA/N1xDWh+brLKiX1QaN6n3aPLAydHaIJyPI3y4W9XZd/b548eficYiWLV4s1GV0WSwuFjf68Kz+rNNQ28Vi1dzfDx5u3ax25p+/jdl+Na8B0ZmH3H9fLi4+LS8SuoyK7LffLj5NhU2C+WHCOPxiCtLi4hOhguQVJKugWlx8Uqig8goqq2C0uPgUoYKRVzCyCsaLi08xKhh7BWOrYLK4+JSggolXMLEKpouLTykqmHoFU6tgtrj4lKGCmVcwswrmi4tPOSqYewVzq2CxuPhUoIKFV7CwCaD5QJA75JOHHPYY+mD+AALZDCLNC4IcIp9EZLOINDcI8oh8IpHNJNL8IMgl8slENptIc4Qgn8gnFNmMIs0Tgpwin1Rks4o0Vwjyinxikc0s0nwhyC3yyUU2u0hzhiC/yCcY2QxTmjMKMkz5DFM2w5TmjKILFV3GaWIX9hmmHB9lnJS6iNNLlRd2YeCmbIYpzRkFGaZ8himbYUpzRkGGKZ9hymaY0pxRkGHKZ5iyGaY0ZxRkmPIZpmyGqSzc2j7DlM0wpTmjID2VzzBlM0xpzihIT+UzTNkMiwzDID0jn2GRzbBIcyaC9Ix8hkU2wyLNmQg6wMhnWOTMhGYqhA4wApOhzbBIcybCE6nPsMhmWKQ5E0F6Rj7DIpthURokSeQzLLIZFmnORJDbkc+wyGZYpDkTpWg8Rz7DIpthkeZMBOkZ+QyLbIbFmjMRpGfsMyy2GRYbhkF6xj7DYpthsQq2duwzLLYZFmvOxJDbsc+w2FlvmQUX5HYMllw2w2LNmRhyO/YZFtsMi8MMi32GxTbDYs2ZOLqI1WWhYruwz7DYZlisORPHiGGxz7DYZlisORNDbsc+w2KbYYnmTAz9duIzLLEZloRnycRnWGIzLNGcieHASHyGJTbDEsMwODASn2GJzbDEMAwOjMRnWOKs6s2yHnI7AQt7m2GJ5kwCuZ34DEtshiWaMwnkduIzLLEZlmjOJNBvJz7DEpthieZMAv124jMssRmWLoMkSX2GpTbDUs2ZBHI79RmW2gxLNWcSvJPyGZbaDEs1ZxJIz9RnWGozLI3Dz+wzLLUZlhqGQW6nPsNSZ+9oGAa5nYLto82wVHMmhdxOfYalNsNSzZkUcjv1GZbaDEs1Z1LI7dRnWGozLNOcSSG3M59hmc2wLOzDMp9hmc2wTHMmhQMj8xmW2QzLNGdSyO3MZ1hmMyzTnEkhtzOfYZnNsCwJP7PPsMxmWGbCEzjM4DMscyIU4ZV+BoIUNsMyw7AczZKZz7DMZlhmGAYHRuYzLLMZlmvOZHBg5D7DcpthueZMBgdG7jMstxmWh9dhuc+w3GZYHgXXJLnPsNxmWK45kylY2GdYbjMs15zJ4JDMfYblNsNyzZkMjqrcZ1huMyw3QTA4qnKfYbkTB8vDrQ1CYTbDcs2ZDA7J3GdYbjOsCM+Shc+wwmZYYRgGh2ThM6ywGVZozmRwuil8hhU2w4oobLbPsMJmWGEYVlxE+WW8tBlW+AwrbIYVmjM5HJKFz7DCZlihOZPDIVn4DCtshhWaMzmcqwqfYYXNsMKEWuHAKHyGFU60VXMmhwOjAAFXN+IaptiQZhdnv43lNW9yHIFcgrDr0om7LjV1chyEXILI69IJvS41e3Ich1yC4OvSib4uNYFyHIpcgvjr0gnALg3jcDRyCUKwSycGu9Q0KgIhbxCFXTph2KVmUoGj3ksQiF06kdilJlOBA99LEItdOsHYpQn249j3EoRjlw7/TBC/wOFvFPP3gv7hlRrBsL/DPxPKLzB/UeTfDf1T2NcRCv670X8T0C9gGIlQ/N8VAExMv8hwecA/VwMwYX08oRNSAVwZwET2Czx+kBDgKgEmuF/g8YO0AFcMGNSAJR5ASA9wBAFSg+aERxDQBMgRBeiIKkBAFiBHFyAT6sfrMQLKADnSAJloP14AExAHyFEHyAT8aRnQvgAFHYWA1BEKAo2AHJGATNyfltiHAJ2AHKGATOwfLxkISAXkaAVkwv+BMQjUAnLkAlIDB7ETA4oBOZIBGRUgMAiBaECOakBGCKAl9mJAOCBHOaBBOsAtALQDcsQDMnoALfE0DvQDcgQEigYS4nkcaAjkiAhkdAFaYkcEdARyhASKBhZiTwS0BHLEBDL6AAXUa6AnkCMokNEIKKBgA02BHFGBjE5AARUb6ArkCAtktAIKKNlAWyBHXKB40OADajYgoiMwkNEMKKBoA42BHJGBjG5AhKkMdAZyhAYy2gEFlG2gNZAjNpDRDyigbgO9gRzBgYyGQAGFG2gO5IgOZHQEwio3Ad2BHOGB4vxYIwImOuIDGT2BFKYy0B/IESDIaAqkMJWBBkGOCEFGVyAsmRPQIcgRIigZToRgKgMtghwxgoy+QFg6J6BHkCNIkNEYCMvnBDQJckQJMjoDYRWcgC5BjjBBRmsgrIQT0CbIEScoGZiIqQz0CXIECjKaA2FFnIBGQY5IQUZ3CKwNgExBjk5BRnogrKoTkCrI0SrIyA+ElXUCcgU5egUZCYKwuk5AsiBHs6B0OJ6EmQxkC3J0CzJSBGGhnIB0QY52QUaOoChw1AgQ0dEvyEgShAVzAhIGORoGGVmCsGhOQMYgR8egdCAiZjKQMsjRMsjIE4T1bwJyBjl6BhmJgrAGTkDSIEfTICNTENbBCcga5OgaZKQKijETgbRBjrZBRq6gGDMRyBvk6BuUDYflMBOBxEGOxkFGtiAsbROQOcjROchIF4QVagJSBzlaBxn5grBKTUDuIEfvICNhEFaqCUge5GgeZGQMwmo1AdmDHN2DjJRBWLEmIH2Qo32QkTMIq9YE5A9y9A8ykgZh5ZqABEKOBkJG1iCsXhOQQcjRQchIG4RFaAJSCDlaCOVhuY2AGkKOHEKDHoInNiCIkKOIkBE5CAvhBEQRclQRMkIHYTGcgDBCjjJCRuwItQCgoSOOUDHQEI8koI+QI5BQcSRyAyQScjQSGkQS3AVAJSFHJqFBJ4FHQgkIJeQoJVQMHAwchQUcdNQSMgIIYW2fgGBCjmJCxXCEGHsCIJqQo5qQEUIIa/wEhBNylBMyYghhnZ+AeEKOekLFERYC/YQcAUUZQYSw3K+AgqIcBUUZRYSw5K+AhKIcCUUZSYSw7K+AhqIcDUUZTYSweq+AiKIcEUUZUYRSfGIWqCjKUVHUciAiZLICMopyZBRlZBHCYrwCOopydBS1HM6zQyYrIKQoR0hRy7BKrICQohwhRRlhhDJ8jQUoKcpRUtRweQLL6wpIKcqRUtRwgQJL7ApoKcrRUpTRRvCBRQW0FOVoKWq4R4FlegXEFOWIKWq4S4HVdgXUFOWoKWq4T4FFcwXkFOXIKWq4U4GFcwX0FOXoKWq8V4FHAhBUlCOoqPFuBR4JQFFRjqKiBkUF6+AKKCrKvWIxKCpYC1foloV7zcIoJIT1cIVuWnhXLYxHxJq4grctHCYajYSwrK3QjQv3ysUgqmBdW6FbF+61CyOSEBa2Fbp54V69GFQVrGwrdPvCvX5hVBLC0rZCNzDcKxhGJiGsbSt0C8O9hjHoKljcVugmhqOrKKOTEFa3FRBWlCOsqEFYwfK2AsKKcoQVZYQSwvq2AsqKcpQVNSgrWKBWQFlRjrKiBmWlwEwEyopylBU1KCsFZiJQVpSjrKhBWcEasQLKinKUFTUoK1gkVkBZUY6yooxQorBIrICyohxlRRmhRGGRWAFlRTnKioqHe2eYiUBZUY6yooxQorBIqoCyohxlRQ13N7BIqYCyohxlRRmhRGGRUQFlRTnKijJCicIioQLKinKUFWWEEoVFQgWUFeUoK2q4y4FFQgWUFeUoK8oIJQqLhAooK8pRVlQ8rBIxE4GyohxlRcXDdgUzESgrylFWVDIc+MJMBMqKcpQVNd7vwEwEyopylBWVDKdXMROBsqIcZUUlw5mbwKVEwERHWVHJcBIfMxEoK9Nv5tL8Y9X21frtcHn+06f9qwn/XHweb9Qrmm7p/7lQtHjx518XC5UNf6N0+Bur8e/4/2TMly7Hv/HwNxt/z5Lx74iTj+XzfPhbjOWKaPirD+oN/yCa/jElTTbpmNL4j2L8RzElFeMvep/y4s+//jq8AsD8PDWNSdNtVQ6fqjo0ghay962gpWoxivXWUA4YMcB4KQfsh0+2cCjFbStkUN1q+NoQw1FLblImw3ks641+O0Nn3i1yq1+KU687jpskB9iURKjXw7ez+DPG3LYZKA/DK7g4VMKhlBzqcf+JIY6WcbRYhtY0Xz535pUsTfu569t6e/v5S/XNQmadKrSxab6s7sqHvmpXzbZvmw2HY30rI5uGG2ysm+19s7b6g5E3mommX7HD2o+13mygTbMqN/Uf1XpoQqv5UkY6GfD47hzetznv22QGDGBdwbHmmARpp/iYT2Q9ujJftOIg3AclsvbXIKvpDVEci7dVIns+jRXyj4qPq0TW9hrvZnz1DofiAz6R8VVD3Y3vGOJQ3A0lsnGpoXynrVKOJPMb+9G9sxs/ZdzKZP5/hGr1NzfRuEwZv9LzIb1xkDLKZULaDp/gYG2XcN7mwl7Yf/aLdwIflIlsxjNAG/N9oQNSxtxrPuOxNI7XRhlzirlwVN41TVd9Ns7RmnsPSMIhpN+qZIpwgxgZ8nhagI1rPX1+U4Rsj+8s4stKIUSz2d1v19UNR2J+R7YsWzX3143DhIx5m0LY5COM+XRD4zmwjNlVCCk6IvpgOWNEIfStI5jHrpxRtRCSorm/L7fru3K73tgOseDz91I4gPzZI2LNL1zAek6QT2ZK6OTbquyr8dsbrOuYa86F1uxa/WZvMwA5FJsuZC5+XfalBcAaWLi61BD98KI99kzM7UpR7AkrZc+ilrIBO37T+nF47yUDW/IpOZINuNBKIU24YVKsvqw33eBQXHeXsBEiXHmsh499gTVkzNdFmbDthzfIu3bFnE3jTlnLTiLI8a2qt8M7Tflkyg0shP06otXmJZwcjPdrLuTrCHZv3nDPpwjesSQb0hxsmvI9KwtO5WheA7rA/ko/52YLPZGFDlbXBd8NCidcgAmM5V5TCQcPA/b5xKdSrSjORfR7y3Ls800M9BLngJrPAY3qhsrY68A1/eeb6k1FWupgDz9/QBlE8PS8k9T8TnoYP7zA+z3n/S5bpHDIVr+t2qcTX65odfcsWJ9TfIxG88foHhU0Le8xNb/HusObiLnBvMOi+R22RwUG845T8zuu23+AhbOBDy+aPxImUGBuwc0VTqgcWX/Ug1vK8egsPOixedhcyVaRGBY0AZ8N1PzZoNtd99Obw7nJfKip+UPtAAtMtlSE+c2B7OXrdH34RYJZbUPrNB5vymSjoNqux6CHFeJgviWTuZYb8308YFXCAxSF7BEHsKnxbDi+XRPGKUBALeXOaCl7xNuq15uj7e7+Rn8myg5E8iWojHe3Vb+pt1WnwXbdje3deWhN1pO3Vb/d3V9XLcSzqCHF6/qy33U3TetPPrxPZXBtvXaXx9wJFEKrRpjafPmQQTFnXcyzyA8vsNVaIevLu/L+etfeVq0G9AcBn1D1GzNkkDpUMUQhA6OU74hlJOGgOnDndizfr+SyHuGQXV+2PbKUPX8mcwF3ZVe1rbOEWPLFqXBhcldtHrRC/Ls9uS15AFa4ZKhXzRZ0Lh/6S5lRBySffXxsLWXLJNsXxezR4kme3mvNMvbV2wdnORRxaTWRDYt6+NA5mqv4iMiET7nVn1U0XyjlAXDej/NwQrqlJWzL5oY9pgnqDUEZKzzIWk+4AdxD6kHqI/LAv3A7bSE2qyHit7KPSvAFiXBUTKjHtExb/J6HO0xDoE3ZUkAYAtljmuiiG6nkpweEa9K6G+Nm1ghMmUvI8mnkCZnU3ew2m6/1ur+zwtR8BqfpnIhw31t3bfWfXd3aVuo3ZLCxI5s1x88ts0azVvKjXYXwWWEEgrsG4ST0pbKcQsSmsUiG4IfQ2fgqJsVoOjWkryUP/8gnDUmokEyzri2XMYeTy7r02GDj8dBUBndftl/0WruttuuqdRbLPJpMQnUWxcH47ky/OGsODpQZeUyRhAej7pu2cleP+sYUW9AKLdtt+nrwSt7ClseQhfF8B+6hbR5rR7vnIS8SbloM7LA6Q6phxFpQGETalo/1rfkw9Li776qyXVnOKuKHa2TefttU+++g3wzfSuf9w5kjlPwOE5ztr3jcTIi0vd7snJUoX/QJg1nNdnWnTxbYQNzbCXtgArIOrFkOgBElFWNuaveQAudbLhtezfamWe3suX/JcYR8aLY+rXjIk4SLvYdNuarumo0zlHhQmmjv3mXPOH1O2hcF+TEDfSFMgmYCsXa783k5l/VfIPbM10iUytY0Byhv38/dBQlPQrbVTeWvM3n8RdbqbdXtNn3XVbbuzqZp4aHKCajZtbZRMXs64Vm5tvk6eUGLXmztIMLpVo27DOLbLSGG1pZ3baWjVKb/PPmVeS3hKbI9qObCoDlbiMzMWPqoI+KeGFjD5uFM4Tk1Bm26+LGuvtrjPmItIDyyjEEHm92FBN/WCo80YnhvqcPjnsKziXvkrl3h3uNin/DsWHjO4cdVxd01YaEDfPyMnDDgABD9lmTeNRFS1kxF16U9hfAogdDX74H8pSz3+cLDZN34qVgemOVKWCTkybg69BQgxeNtSjpchojlGm902FPmc6zzZ7aCi17CTd54GNyZ1RTfByvhcfoxhuruGhWPKyrhhDQGTw139SbMj5cpvoRSwrmJw+4eECgP9giPZo2gSOFV/EiUvm0mxwPamL7dxzpYOr40mrcu01cNGZbQl0AVm29tSOrnqr7Xe3T3yC2XxlLpaDhA+Ye7+TYplQ6JA6A7MPiuOBU2Wv2Hc0icL0ClK4SNu/PVb0tjzS6k1vjNX84D7h6FVxi6pu3XdTvcIrH3NXwCEGJ5a04GIh0yD7X7YNztk1DgG2H8mYgLEEItMyj8sG7LhIPFRHutXrPcswzka93be0fiMUFKZTB9ef2l+mbcCTryy+wShgC8Q6367ip7OFnPGZRr87VnhsTv9ynhSDNIq9I7kaq4AK2EdzsGMPM5ZY5kxVtkDB+QwL7KusMom1wNln8CQHHhSAnX6gbrznzImiPxKV94B2mP5FrFJ6pYNvgMVqu/iM2B+KARbp/68trRwaxjCGKKd+g0Ed95kXBy0ljupEn8pD0Jp00NhM7f8OgBCac4V0rm18aEIoqGMN/qtqcTPp8Ij1XskfzzSnz9REI5q29ubzeVv9jm57ZJeCKIYXlxJB42IOGJgL5pNs4WjLj3JOF2Z8QB9xt5+wt3FFq9CoQvmGlCB7p70FcWkFrOHzOT0XTXVdWjOwi5MKmEZxUmoLL7tl3ZaHzuEh5V0Mc49empzgmcWtKrrCMPUMN1I7s3+RU0JbzX420cuAOMJiFXqDWPl15tinGHGk9nMoR+/rFqtTxyV3feIQh+15GER6lsOE+G5Wd2lPDM0gipo2Ltfelfc+F7J+HJKv12h3pVbry5iS+cSXi/k4OhOYoHgCmTzeQc05ur+N0nEl4W5YBozuLHe0iyqP7tYvFQP1T6sOHixaff/vrrfwG49SqEJewAAA=="; \ No newline at end of file diff --git a/platform-bible-react/enums/BookSelectionMode.html b/platform-bible-react/enums/BookSelectionMode.html index 61557851cc..8ac54adac4 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 f625ec107c..d2b6855718 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 1d5cc4fdbf..127074075b 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 132459a12e..c7cf7cf20a 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 0741912619..b6c63480f9 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 new file mode 100644 index 0000000000..0b4c82d4b0 --- /dev/null +++ b/platform-bible-react/functions/Badge.html @@ -0,0 +1 @@ +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 55db467162..7e6110f48d 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 781447ce58..052bd36009 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 4491047492..739009773a 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 3f370cc93b..e4efff6e4d 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 02356eda9d..3ca4158633 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 42f645baae..76c0beac50 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 eee786ef7b..6d7f389684 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 b55b20c9bc..9373523947 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 4ab5fb1e04..9f0ef98518 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 096bc9fdf6..63accea487 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 fa82589ee4..c11aaf973b 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 2b08fbdc75..07b509071c 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 d7ddefbd90..5f4b8dfd73 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 dd21a95185..00a7d32aa7 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 c258297831..b77aa5242c 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 b226044765..19d345a072 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 edbfa60625..36d662d234 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 257b0df56b..1a1156038a 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 e07cb2beed..ee2e3294c4 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 88e37c1b00..6831317df8 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 521f687500..7c9715f1a5 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 595329be79..9c257218e8 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 4ce61027f4..7fc320e30b 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 b10ab56645..13abfc1cf3 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 14cb771285..3805ab4dd0 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 c37961872b..7426b1d0db 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 1473049a33..c36df77b6a 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 bb9238095e..6a06b62255 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 0c50caf47f..9aefed80d9 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 c43a48c70e..9c0ba88d77 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 95a8e9443b..a703437990 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 65a9dbfcd9..bc8a37ae68 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 1b28dbc835..239fd334b9 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 a446e55092..9d87068be5 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 65c408100d..8a5854c343 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 ff7cee9aa0..e4ae1eafa3 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 7bb002d0ad..4fac10c4b9 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 151428b338..b3f48c880e 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 f03315f8d4..79ddf9f3c5 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 4fcfd89e87..dafbe6b896 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 e746e19c5b..37c22e4645 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 5466a8a2cb..df65e23dc9 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 5d3db84951..375730d662 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 f2bec90093..a8143be92e 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 new file mode 100644 index 0000000000..075ebb0163 --- /dev/null +++ b/platform-bible-react/functions/MultiSelectComboBox.html @@ -0,0 +1 @@ +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 62abced960..8bbd0278d7 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 c6c4e9d892..482991e97f 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 98a7877eb8..5c56d23656 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 e539e02a3c..481a1e19da 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 a8fa0a0ffd..44070e18b1 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 c605f4ba1d..07953c7093 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 368f972e26..15c46130e5 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 343ed3a6b8..148c02ca43 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 1c1f19cd76..0448ffa87d 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 d5fe6aadb6..09338e638d 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 02c0c070a8..836f26727d 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 4179cec98e..2fb0007a85 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 5ecd8b616c..687017a5cb 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 829496e41b..904c099852 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 aa260abf21..9d27ddccf9 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 4a105526ad..fc8648607f 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 3cc7e60bad..1b4dcbf0c1 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 7dae112eaf..2b874cbec8 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 654bb38ba1..baacb4b2be 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 5c44a2d2e9..b8d73793b5 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 1bb1f63541..d928700041 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/Slider.html b/platform-bible-react/functions/Slider.html index 258988dec5..25e5ee0c20 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 124caec8e2..84997df564 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 79ef503a52..a2bea88a92 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 d1d8669a90..2efa91171f 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 c227bcb8dd..34bc22bd46 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 b9bab0c4c7..adc65b4450 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 34898c5e09..4feaae3e45 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 9dcecb3e89..103bccec57 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 b7e8873b12..40b7006c47 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 c4d24bccc9..cc98af31c9 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 7f6a077a60..e9b1f79569 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 aad65d9333..268ea6c711 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 cd7873f1d9..deac689da2 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 fbf9fec451..83be673175 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 bbe5ae0671..06b0d3b088 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 202f75d128..cb48ad5139 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 41ad764a18..54c5b273a1 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 39c8c1b358..615e331524 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 9988dc2b4f..bde41c8e1e 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 e762267a98..8ecd8cb479 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 62c43ca0b2..31e4de49e2 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 4ba22d1111..478be6c3f7 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 5d013f90bf..5750450fa1 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 b39c78ff2e..f1f80d6d8c 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 2f12e2a43c..89d8d471c2 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 deecacf82f..edcb37ce09 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 new file mode 100644 index 0000000000..796a506f85 --- /dev/null +++ b/platform-bible-react/functions/badgeVariants.html @@ -0,0 +1 @@ +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 79b887f752..2aef6d81ef 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 ba4187fb8e..5ff0aab35e 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 666c569990..7299ff7ea4 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 27ef9e0188..7bb82c344a 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 5293884884..8d4edc1000 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 2966c307fc..ec11486dad 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 3db31a4f19..a9f8e2c444 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 6307319f5c..a1ecadb4eb 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 9d5acfdef1..bd647dfbca 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 4c3eac7050..108c5ee0f5 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 1450aa7301..d0241ccdc4 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 94af10e7e9..0bfcaf3685 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 new file mode 100644 index 0000000000..55acb3ce14 --- /dev/null +++ b/platform-bible-react/interfaces/BadgeProps.html @@ -0,0 +1,386 @@ +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? +aria-autocomplete? +aria-braillelabel? +aria-brailleroledescription? +aria-busy? +aria-checked? +aria-colcount? +aria-colindex? +aria-colindextext? +aria-colspan? +aria-controls? +aria-current? +aria-describedby? +aria-description? +aria-details? +aria-disabled? +aria-dropeffect? +aria-errormessage? +aria-expanded? +aria-flowto? +aria-grabbed? +aria-haspopup? +aria-hidden? +aria-invalid? +aria-keyshortcuts? +aria-label? +aria-labelledby? +aria-level? +aria-live? +aria-modal? +aria-multiline? +aria-multiselectable? +aria-orientation? +aria-owns? +aria-placeholder? +aria-posinset? +aria-pressed? +aria-readonly? +aria-relevant? +aria-required? +aria-roledescription? +aria-rowcount? +aria-rowindex? +aria-rowindextext? +aria-rowspan? +aria-selected? +aria-setsize? +aria-sort? +aria-valuemax? +aria-valuemin? +aria-valuenow? +aria-valuetext? +autoCapitalize? +autoCorrect? +autoFocus? +autoSave? +children? +className? +color? +content? +contentEditable? +contextMenu? +dangerouslySetInnerHTML? +datatype? +defaultChecked? +defaultValue? +dir? +draggable? +enterKeyHint? +hidden? +id? +inlist? +inputMode? +is? +itemID? +itemProp? +itemRef? +itemScope? +itemType? +lang? +nonce? +onAbort? +onAbortCapture? +onAnimationEnd? +onAnimationEndCapture? +onAnimationIteration? +onAnimationIterationCapture? +onAnimationStart? +onAnimationStartCapture? +onAuxClick? +onAuxClickCapture? +onBeforeInput? +onBeforeInputCapture? +onBlur? +onBlurCapture? +onCanPlay? +onCanPlayCapture? +onCanPlayThrough? +onCanPlayThroughCapture? +onChange? +onChangeCapture? +onClick? +onClickCapture? +onCompositionEnd? +onCompositionEndCapture? +onCompositionStart? +onCompositionStartCapture? +onCompositionUpdate? +onCompositionUpdateCapture? +onContextMenu? +onContextMenuCapture? +onCopy? +onCopyCapture? +onCut? +onCutCapture? +onDoubleClick? +onDoubleClickCapture? +onDrag? +onDragCapture? +onDragEnd? +onDragEndCapture? +onDragEnter? +onDragEnterCapture? +onDragExit? +onDragExitCapture? +onDragLeave? +onDragLeaveCapture? +onDragOver? +onDragOverCapture? +onDragStart? +onDragStartCapture? +onDrop? +onDropCapture? +onDurationChange? +onDurationChangeCapture? +onEmptied? +onEmptiedCapture? +onEncrypted? +onEncryptedCapture? +onEnded? +onEndedCapture? +onError? +onErrorCapture? +onFocus? +onFocusCapture? +onGotPointerCapture? +onGotPointerCaptureCapture? +onInput? +onInputCapture? +onInvalid? +onInvalidCapture? +onKeyDown? +onKeyDownCapture? +onKeyPress? +onKeyPressCapture? +onKeyUp? +onKeyUpCapture? +onLoad? +onLoadCapture? +onLoadedData? +onLoadedDataCapture? +onLoadedMetadata? +onLoadedMetadataCapture? +onLoadStart? +onLoadStartCapture? +onLostPointerCapture? +onLostPointerCaptureCapture? +onMouseDown? +onMouseDownCapture? +onMouseEnter? +onMouseLeave? +onMouseMove? +onMouseMoveCapture? +onMouseOut? +onMouseOutCapture? +onMouseOver? +onMouseOverCapture? +onMouseUp? +onMouseUpCapture? +onPaste? +onPasteCapture? +onPause? +onPauseCapture? +onPlay? +onPlayCapture? +onPlaying? +onPlayingCapture? +onPointerCancel? +onPointerCancelCapture? +onPointerDown? +onPointerDownCapture? +onPointerEnter? +onPointerLeave? +onPointerMove? +onPointerMoveCapture? +onPointerOut? +onPointerOutCapture? +onPointerOver? +onPointerOverCapture? +onPointerUp? +onPointerUpCapture? +onProgress? +onProgressCapture? +onRateChange? +onRateChangeCapture? +onReset? +onResetCapture? +onResize? +onResizeCapture? +onScroll? +onScrollCapture? +onSeeked? +onSeekedCapture? +onSeeking? +onSeekingCapture? +onSelect? +onSelectCapture? +onStalled? +onStalledCapture? +onSubmit? +onSubmitCapture? +onSuspend? +onSuspendCapture? +onTimeUpdate? +onTimeUpdateCapture? +onTouchCancel? +onTouchCancelCapture? +onTouchEnd? +onTouchEndCapture? +onTouchMove? +onTouchMoveCapture? +onTouchStart? +onTouchStartCapture? +onTransitionEnd? +onTransitionEndCapture? +onVolumeChange? +onVolumeChangeCapture? +onWaiting? +onWaitingCapture? +onWheel? +onWheelCapture? +prefix? +property? +radioGroup? +rel? +resource? +results? +rev? +role? +security? +slot? +spellCheck? +style? +suppressContentEditableWarning? +suppressHydrationWarning? +tabIndex? +title? +translate? +typeof? +unselectable? +variant? +vocab? +

    Properties

    Optionalabout

    about?: string

    OptionalaccessKey

    accessKey?: string

    Optionalaria-activedescendant

    aria-activedescendant?: string

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +

    Optionalaria-atomic

    aria-atomic?: Booleanish

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +

    Optionalaria-autocomplete

    aria-autocomplete?:
        | "inline"
        | "both"
        | "none"
        | "list"

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +

    Optionalaria-braillelabel

    aria-braillelabel?: string

    Defines a string value that labels the current element, which is intended to be converted into Braille.

    +

    See

    aria-label.

    +

    Optionalaria-brailleroledescription

    aria-brailleroledescription?: string

    Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

    +

    See

    aria-roledescription.

    +

    Optionalaria-busy

    aria-busy?: Booleanish

    Optionalaria-checked

    aria-checked?:
        | boolean
        | "false"
        | "mixed"
        | "true"

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    See

      +
    • aria-pressed
      • +
    • aria-selected.
      • +
    +

    Optionalaria-colcount

    aria-colcount?: number

    Defines the total number of columns in a table, grid, or treegrid.

    +

    See

    aria-colindex.

    +

    Optionalaria-colindex

    aria-colindex?: number

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    See

      +
    • aria-colcount
      • +
    • aria-colspan.
      • +
    +

    Optionalaria-colindextext

    aria-colindextext?: string

    Defines a human readable text alternative of aria-colindex.

    +

    See

    aria-rowindextext.

    +

    Optionalaria-colspan

    aria-colspan?: number

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    See

      +
    • aria-colindex
      • +
    • aria-rowspan.
      • +
    +

    Optionalaria-controls

    aria-controls?: string

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    See

    aria-owns.

    +

    Optionalaria-current

    aria-current?:
        | boolean
        | "false"
        | "time"
        | "location"
        | "page"
        | "true"
        | "step"
        | "date"

    Indicates the element that represents the current item within a container or set of related elements.

    +

    Optionalaria-describedby

    aria-describedby?: string

    Identifies the element (or elements) that describes the object.

    +

    See

    aria-labelledby

    +

    Optionalaria-description

    aria-description?: string

    Defines a string value that describes or annotates the current element.

    +

    See

    related aria-describedby.

    +

    Optionalaria-details

    aria-details?: string

    Identifies the element that provides a detailed, extended description for the object.

    +

    See

    aria-describedby.

    +

    Optionalaria-disabled

    aria-disabled?: Booleanish

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    See

      +
    • aria-hidden
      • +
    • aria-readonly.
      • +
    +

    Optionalaria-dropeffect

    aria-dropeffect?:
        | "link"
        | "none"
        | "copy"
        | "move"
        | "execute"
        | "popup"

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    Deprecated

    in ARIA 1.1

    +

    Optionalaria-errormessage

    aria-errormessage?: string

    Identifies the element that provides an error message for the object.

    +

    See

      +
    • aria-invalid
      • +
    • aria-describedby.
      • +
    +

    Optionalaria-expanded

    aria-expanded?: Booleanish

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +

    Optionalaria-flowto

    aria-flowto?: string

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +

    Optionalaria-grabbed

    aria-grabbed?: Booleanish

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    Deprecated

    in ARIA 1.1

    +

    Optionalaria-haspopup

    aria-haspopup?:
        | boolean
        | "false"
        | "grid"
        | "dialog"
        | "menu"
        | "listbox"
        | "true"
        | "tree"

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +

    Optionalaria-hidden

    aria-hidden?: Booleanish

    Indicates whether the element is exposed to an accessibility API.

    +

    See

    aria-disabled.

    +

    Optionalaria-invalid

    aria-invalid?:
        | boolean
        | "false"
        | "true"
        | "grammar"
        | "spelling"

    Indicates the entered value does not conform to the format expected by the application.

    +

    See

    aria-errormessage.

    +

    Optionalaria-keyshortcuts

    aria-keyshortcuts?: string

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +

    Optionalaria-label

    aria-label?: string

    Defines a string value that labels the current element.

    +

    See

    aria-labelledby.

    +

    Optionalaria-labelledby

    aria-labelledby?: string

    Identifies the element (or elements) that labels the current element.

    +

    See

    aria-describedby.

    +

    Optionalaria-level

    aria-level?: number

    Defines the hierarchical level of an element within a structure.

    +

    Optionalaria-live

    aria-live?: "off" | "assertive" | "polite"

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +

    Optionalaria-modal

    aria-modal?: Booleanish

    Indicates whether an element is modal when displayed.

    +

    Optionalaria-multiline

    aria-multiline?: Booleanish

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +

    Optionalaria-multiselectable

    aria-multiselectable?: Booleanish

    Indicates that the user may select more than one item from the current selectable descendants.

    +

    Optionalaria-orientation

    aria-orientation?: "horizontal" | "vertical"

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +

    Optionalaria-owns

    aria-owns?: string

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    See

    aria-controls.

    +

    Optionalaria-placeholder

    aria-placeholder?: string

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +

    Optionalaria-posinset

    aria-posinset?: number

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    See

    aria-setsize.

    +

    Optionalaria-pressed

    aria-pressed?:
        | boolean
        | "false"
        | "mixed"
        | "true"

    Indicates the current "pressed" state of toggle buttons.

    +

    See

      +
    • aria-checked
      • +
    • aria-selected.
      • +
    +

    Optionalaria-readonly

    aria-readonly?: Booleanish

    Indicates that the element is not editable, but is otherwise operable.

    +

    See

    aria-disabled.

    +

    Optionalaria-relevant

    aria-relevant?:
        | "all"
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals"

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    See

    aria-atomic.

    +

    Optionalaria-required

    aria-required?: Booleanish

    Indicates that user input is required on the element before a form may be submitted.

    +

    Optionalaria-roledescription

    aria-roledescription?: string

    Defines a human-readable, author-localized description for the role of an element.

    +

    Optionalaria-rowcount

    aria-rowcount?: number

    Defines the total number of rows in a table, grid, or treegrid.

    +

    See

    aria-rowindex.

    +

    Optionalaria-rowindex

    aria-rowindex?: number

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    See

      +
    • aria-rowcount
      • +
    • aria-rowspan.
      • +
    +

    Optionalaria-rowindextext

    aria-rowindextext?: string

    Defines a human readable text alternative of aria-rowindex.

    +

    See

    aria-colindextext.

    +

    Optionalaria-rowspan

    aria-rowspan?: number

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    See

      +
    • aria-rowindex
      • +
    • aria-colspan.
      • +
    +

    Optionalaria-selected

    aria-selected?: Booleanish

    Indicates the current "selected" state of various widgets.

    +

    See

      +
    • aria-checked
      • +
    • aria-pressed.
      • +
    +

    Optionalaria-setsize

    aria-setsize?: number

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    See

    aria-posinset.

    +

    Optionalaria-sort

    aria-sort?:
        | "none"
        | "other"
        | "ascending"
        | "descending"

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +

    Optionalaria-valuemax

    aria-valuemax?: number

    Defines the maximum allowed value for a range widget.

    +

    Optionalaria-valuemin

    aria-valuemin?: number

    Defines the minimum allowed value for a range widget.

    +

    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.

    +

    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

    Optionaldraggable

    draggable?: Booleanish

    OptionalenterKeyHint

    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send"

    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

    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
    diff --git a/platform-bible-react/interfaces/ButtonProps.html b/platform-bible-react/interfaces/ButtonProps.html index 3619b61137..c5f17b558c 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 6f85ad0070..4fb5fda0fb 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 e2490cb5d1..c6b0009380 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/modules.html b/platform-bible-react/modules.html index eff7a1dfa6..68530c78f4 100644 --- a/platform-bible-react/modules.html +++ b/platform-bible-react/modules.html @@ -1,6 +1,7 @@ platform-bible-react

    platform-bible-react

    Index

    Enumerations

    BookSelectionMode DropdownMenuItemType -

    Interfaces

    ButtonProps +

    Interfaces

    BadgeProps +ButtonProps CommandHandler MultiColumnMenuProvider

    Type Aliases

    BookSelectorLocalizedStrings @@ -52,6 +53,8 @@

    Functions

    Alert AlertDescription AlertTitle +Badge +badgeVariants BookChapterControl BookSelector Button @@ -105,6 +108,7 @@ MarkdownRenderer MenuItem MoreInfo +MultiSelectComboBox NavigationContentSearch NoExtensionsFound RadioGroup diff --git a/platform-bible-react/types/BookSelectorLocalizedStrings.html b/platform-bible-react/types/BookSelectorLocalizedStrings.html index e233735451..44c761a2e1 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 b22def9ec0..c205cc2415 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 685c626730..6e5049f052 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 4fc85ea718..89ccc2c5a9 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 009cba9f81..b9742de4b7 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 2e9952b629..d8785372ca 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 5ca959d214..e1ffda0e67 100644 --- a/platform-bible-react/types/ComboBoxProps.html +++ b/platform-bible-react/types/ComboBoxProps.html @@ -1,14 +1,16 @@ -ComboBoxProps | platform-bible-react

    Type AliasComboBoxProps<T>

    ComboBoxProps<T>: {
        buttonPlaceholder?: string;
        buttonVariant?: ButtonProps["variant"];
        className?: string;
        commandEmptyMessage?: string;
        dir?: Direction;
        getOptionLabel?: ((option: ComboBoxOption) => string);
        id?: string;
        isDisabled?: boolean;
        onChange?: ((newValue: T) => void);
        options?: readonly T[];
        textPlaceholder?: string;
        value?: T;
    } & PopoverProps

    Type Parameters

    • T

    Type declaration

    • OptionalbuttonPlaceholder?: string

      Text displayed on button if value is undefined

      +ComboBoxProps | platform-bible-react

      Type AliasComboBoxProps<T>

      ComboBoxProps<T>: {
          alignDropDown?: "start" | "center" | "end";
          buttonPlaceholder?: string;
          buttonVariant?: ButtonProps["variant"];
          className?: string;
          commandEmptyMessage?: string;
          dir?: Direction;
          getOptionLabel?: ((option: ComboBoxOption) => string);
          icon?: ReactNode;
          id?: string;
          isDisabled?: boolean;
          onChange?: ((newValue: T) => void);
          options?: readonly T[];
          textPlaceholder?: string;
          value?: T;
      } & PopoverProps

      Type Parameters

      • T

      Type declaration

      • OptionalalignDropDown?: "start" | "center" | "end"

        Control how the popover menu should be aligned. Defaults to start

        +
      • OptionalbuttonPlaceholder?: string

        Text displayed on button if value is undefined

      • OptionalbuttonVariant?: ButtonProps["variant"]

        Variant of button

      • OptionalclassName?: string

        Additional css classes to help with unique styling of the combo box

      • OptionalcommandEmptyMessage?: string

        Text to display when no options match input

      • Optionaldir?: Direction

        Text direction ltr or rtl

      • OptionalgetOptionLabel?: ((option: ComboBoxOption) => string)

        Used to determine the string value for a given option.

        -
      • Optionalid?: string

        Optional unique identifier

        +
      • Optionalicon?: ReactNode

        Icon to be displayed on the trigger

        +
      • Optionalid?: string

        Optional unique identifier

      • OptionalisDisabled?: boolean

        Optional boolean to set if trigger should be disabled

      • OptionalonChange?: ((newValue: T) => void)

        Triggers when content of textfield is changed

          • (newValue): void

          • Parameters

            • newValue: T

            Returns void

      • Optionaloptions?: readonly T[]

        List of available options for the dropdown menu

      • 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 81aad7c13c..7c4a58ee8a 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 bed8cb4479..bfbe17fa52 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 fc8c223ad6..34a8405837 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 8042d38af1..9311d83d2f 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 b9847e1e45..a3825c8980 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 c6a670809d..273d583c0a 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 e1f481ff7b..8049d793ef 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 8f6859f881..964041bf57 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 f871bf01b8..ba31a6a9e6 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 347505f396..8393e8224d 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 e4a88419a8..82cc21b383 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 29497663b7..71cf22c3c9 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 3dd7c6fb73..01eeea7c8b 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 1977dd9a64..309c48190a 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 7de6d513d7..67d478a882 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 a1525e9fd7..99407892fa 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 abfc03b266..80585de530 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 6ff3e7ce3c..9251c7a18c 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/ResultsSet.html b/platform-bible-react/types/ResultsSet.html index 35eb2a7ffd..50195bd385 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 f954c5cf44..5cf0d5779f 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 c4a023e139..4bb22cb897 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 03da0c6189..50a9c06aa6 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 67aaf7a481..9021645277 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 7ec0f5af83..7f91038709 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 d8155201b1..ae7d4b7755 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 7c91459c4d..845f511116 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 bea95785d4..0ccaab58ae 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 5f564a829d..a90d48ed99 100644 --- a/platform-bible-react/types/SearchBarProps.html +++ b/platform-bible-react/types/SearchBarProps.html @@ -1,4 +1,5 @@ -SearchBarProps | platform-bible-react

    Type AliasSearchBarProps

    SearchBarProps: {
        isFullWidth?: boolean;
        onSearch: ((searchQuery: string) => void);
        placeholder?: string;
    }

    Type declaration

    • OptionalisFullWidth?: boolean

      Optional boolean to set the input base to full width

      +SearchBarProps | platform-bible-react

      Type AliasSearchBarProps

      SearchBarProps: {
          className?: string;
          isFullWidth?: boolean;
          onSearch: ((searchQuery: string) => void);
          placeholder?: string;
      }

      Type declaration

      • OptionalclassName?: string

        ClassName for the input

        +
      • 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/SortDirection.html b/platform-bible-react/types/SortDirection.html index 1678bd49be..8d34735ccf 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 859401f386..d00c520252 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 9d27fed6ef..e5e935fae3 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 179394f664..c957adc23e 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 eaa0719a39..f8d663541f 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 4cd8aae074..86392f09ad 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 d90c43604e..a76d881ad8 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 7ac3237ddd..faaed26678 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 41f05a2238..2518374217 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 ac0bb4a651..6249a28d63 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 2b02445727..bede8f3bd4 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 dc4a9e15e7..ce208a830a 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 e278ce8ee7..7adacd0c69 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 b10dd5b56d..a13c34eb46 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 9982644a31..4497362103 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 5871d1bd5b..0868d61dfa 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 664a38ffe7..ad1dc5001c 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 67fa6a3f01..8b3ead3ab5 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 7159663622..0b36217f68 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 61058fe274..b4e45dceb3 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 ff0cd3bfe4..642ae0d62f 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 6397715618..e9228819fe 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 a8db963d84..a00c89d9af 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 94e0f86ae2..34abb2e92a 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 2e9ef5bf94..ebd053337b 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 ca5255230c..23bda0a428 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 61ecaea1a0..c81bc254a7 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 500e6437ff..0e850fc9c2 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 3c8c196372..07038ed95f 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 6a048f53ad..b99314f8ea 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 0dfa19417e..c2607313c9 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 6fa8995730..e6d27bc641 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 0655ac581e..5537f24d45 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 6a78719e30..74cc7ba9b7 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 fda98eaf69..ba7f20f048 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 26b1755d15..eea476b5a3 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 c381dc9b4c..1518efcce3 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 5f63f27747..0d4d47bc67 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 41d4eed39b..82de471ca1 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 538c21276d..ffddd9f1c4 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 13eaadf530..1b5907ac91 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 bcb2494e33..ff1fb41515 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 faa76e208e..93eb8aff7c 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 ca12ce66c1..71b6241fe5 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 64a0c0ee9f..ab3134881f 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 838db690a3..1ad0e330c6 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 7e14980996..eb3cc15d7d 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 aeac18ded8..e78a50795c 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 06282d635f..00239ceb65 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 8743e559ad..51399fc67c 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 375dfd0703..86d0fa73fc 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 aafa2cf1f0..f99e480255 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 b7b4068869..a672e7b31a 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 0cef3de473..a5b76fb57d 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 b9c90aa8b5..14e8535635 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 3114ab00f9..ff580db2a4 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 15e6e531bd..1e8e7df0ac 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 6d2c9bd600..583ce0dc21 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 48b35ef1d1..c10070f6f2 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 b3b2488acc..9f71d7cea2 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 9fda8ba775..f979cf0c76 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 1456778cd1..378991b98b 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 3e8b217511..14bca1c55f 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 d101b6d00d..d7db18480c 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 75bf8b94b4..dd032cab77 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 387ba9feb8..df127f2dd1 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 7043c7373c..5276ef49aa 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 adac7cdd74..e660f765bf 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 a8cb7ac2bb..45bca703cc 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 5726b4665a..3fc0d15ae6 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 97537fac69..766c163f99 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 5d3942646f..97623e04b4 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 87f3f19d10..3dd40bb426 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 fcc6846143..3b43a9ef10 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 3d969bce2a..5daa7a6b78 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 f45ab338c7..9832d83468 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 e50712553b..a880d836a2 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 717b6b90c5..cda5aa7173 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 36041e578b..430d182394 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 99d3a5a31f..5ca4eeb52d 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 3aba7019ae..518d8765e0 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 13838da5ca..8cdc477960 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 bffcf58228..2f586b771b 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 cd9d57c816..1fa28c536b 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 1e38377d09..d70927d3fb 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 567b3ca83e..17e88f8694 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 f515b9d13b..71b234e457 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 557e43ef5a..322db19f64 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 b877dcf3eb..c895658db1 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 3648fdc79e..ca04a72482 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 10f0a2c0bb..20235a8baa 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 293fc374d3..064d823082 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 d8ea0caec7..dc088bf4fa 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 6f6167eadc..da7161acbe 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 3f66ca2418..9b5b8fa760 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 576c01e972..1ab798b16e 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 7b290eb44c..59de022a94 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 028d12601f..173bdab920 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 5dd0a92bf1..a5b8d5f320 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 1b4868f8cc..3e69ebbe9f 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 2266a15e59..28fc9c3b17 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 4c46e47247..d803673dfa 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 5494358632..466352d914 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 e83744724c..6570628693 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 b8104fd976..c851548bc4 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 20c28c34e9..f8a7731c5e 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 f62170a66f..4083772f81 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 f5e48e8070..b69019857b 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 b35cab2beb..743201395e 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 63730d9b66..538e344c76 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 4168e827bc..f0230d9b30 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 e2eb0f94f4..89a6f3c630 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 9094285e2e..11d35550a6 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 6dfdc50f90..ba8f9ac67b 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 2a3407b85d..e165582fe5 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 f9ffd619bd..9ec55f5cc4 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 def7811789..d528768c44 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 557fe0e0c0..b15cc0f709 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 ca99d38bde..0578e5d2a8 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 4471da301d..f284bc4ec8 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 ce8b1aec20..1d3edebb3f 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 aab0eaab12..2c9dd661ea 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 2e94dd2f07..ad2a4a51e3 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 453cead980..58378f7acc 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 6284daa1a5..7d93862a9d 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 956aa5750b..9d2f95264f 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 f2fcd6bc50..b40e034b24 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 0716f107f6..387f0b2e3b 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 5679610f58..d3bc4170c8 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 bcefa3a080..1966c4a7fb 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 18c2075119..edb2aa23ed 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 1233bdc4a8..03c9a4d1b5 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 de9acdc331..28bab7aaf8 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 51da75a767..78a4837361 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 1c11308354..d8ddd81a45 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 ec230abbf5..f898b44f3c 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 ce04297bbf..84cad81fd3 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 5a3285ac2c..a4202d17a6 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 b90c61799c..504b999484 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 1bd32f5367..fe13f48e3f 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 bb0530f821..4b68a8d65f 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 652d0f1cc3..08bc33e750 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 bcb4d8d40b..3cdb85d4e7 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 475a24d1ec..3d6404bb93 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 4cbd642d2d..9803714f18 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 eaaf695968..3b18b3ad03 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 f8bd48f057..547d6f4c9c 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 fa8fa7f2eb..322e1c37b2 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 b8cf6e3970..b9c5b6ab95 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 e0db51070b..082ccadba5 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 7524bfc55a..5d09648175 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 586e55991c..20f0ab7333 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 be4603811a..e8b6830647 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