papi-dts
    Preparing search index...

    Interface ProjectSettingTypes

    Types corresponding to each project setting available in Platform.Bible. Keys are project setting names, and values are project setting data types. Extensions can add more project setting types with corresponding project setting IDs by adding details to their .d.ts file.

    Note: Project setting names must consist of two strings separated by at least one period. We recommend one period and lower camel case in case we expand the api in the future to allow dot notation.

    An extension can extend this interface to add types for the project settings it registers by adding the following to its .d.ts file (in this example, we are adding the myExtension.highlightColor project setting):

    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;
        "platform.textDirection": undefined | "" | "ltr" | "rtl";
    }
    Index

    Properties

    platform.fullName platform.isEditable platform.language platform.name platform.textDirection

    Properties

    "platform.fullName": string

    Localized full name of the project. This will be displayed directly in the UI.

    'World English Bible'
    "platform.isEditable": boolean

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

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

    "platform.language": string

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

    'English'
    "platform.name": string

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

    'WEB'
    "platform.textDirection": undefined | "" | "ltr" | "rtl"

    Which way the project's text flows. 'ltr' = left-to-right; 'rtl' = right-to-left. '' or undefined = left-to-right (may be changed in the future to detect). Defaults to ''. This is generally derived from the language definition for the project's language code. Note that additional string options may be added in the future, so handle accordingly. Adding additional options will not be considered a breaking change.

    Settings

    Member Visibility

    On This Page

    Properties