Skip to main content

Type Alias: TFrameConfig

TFrameConfig = object

Defined in: types/index.ts:225

The frame configuration.

Properties​

noLoader?​

optional noLoader: boolean

Defined in: types/index.ts:227

Specifies whether to initialize the frame without showing a loading spinner.

roomType?​

optional roomType: string

Defined in: types/index.ts:229

The selector room type.

acceptButtonLabel?​

optional acceptButtonLabel: string

Defined in: types/index.ts:231

The label for the selector accept button.

cancelButtonLabel?​

optional cancelButtonLabel: string

Defined in: types/index.ts:233

The label for the selector cancel button.

buttonColor?​

optional buttonColor: string

Defined in: types/index.ts:235

The HEX code to customize the selector button color.

checkCSP?​

optional checkCSP: boolean

Defined in: types/index.ts:237

Specifies whether to check for the presence of CSP headers before initialization.

destroyText?​

optional destroyText: string

Defined in: types/index.ts:239

The text to display when destroying the frame. It will be inserted into the div tag when the "destroyFrame" method is called.

disableActionButton?​

optional disableActionButton: boolean

Defined in: types/index.ts:241

Specifies whether to disable the "Actions" button in the manager interface.

downloadToEvent?​

optional downloadToEvent: boolean

Defined in: types/index.ts:243

Specifies whether to handle download links using the onDownload event instead of downloading directly.

editorCustomization?​

optional editorCustomization: TEditorCustomization | object

Defined in: types/index.ts:245

The parameters to customize editors.

editorGoBack?​

optional editorGoBack: boolean | string

Defined in: types/index.ts:247

Specifies whether the "Open file location" button is displayed in the editor.

editorType?​

optional editorType: TEditorType

Defined in: types/index.ts:249

The editor mode display type.

events?​

optional events: TFrameEvents

Defined in: types/index.ts:251

The callback functions for SDK events.

filter?​

optional filter: TFrameFilter

Defined in: types/index.ts:253

The filter parameters that facilitate searching files and folders in the DocSpace manager.

filterParam?​

optional filterParam: string

Defined in: types/index.ts:255

The filter parameters that facilitate searching files in the selector mode.

frameId​

frameId: string

Defined in: types/index.ts:257

The unique frame identifier used to refer to the SDK instance.

height?​

optional height: string

Defined in: types/index.ts:259

The iframe height measured in percentages or pixels.

id?​

optional id: string | number | null

Defined in: types/index.ts:261

The unique instance identifier used in the SDK initialization modes.

infoPanelVisible?​

optional infoPanelVisible: boolean

Defined in: types/index.ts:263

Specifies whether to display a button to show the info panel in the DocSpace manager.

init?​

optional init: boolean | null

Defined in: types/index.ts:265

Specifies whether to initialize the frame.

locale?​

optional locale: string | null

Defined in: types/index.ts:267

The language of the DocSpace user interface specified with the four letter language code.

mode​

mode: TFrameMode | string

Defined in: types/index.ts:269

The SDK initialization mode.

name?​

optional name: string

Defined in: types/index.ts:271

The iframe name used for messaging at the SDK level.

requestToken?​

optional requestToken: string | null

Defined in: types/index.ts:273

The authorization token for API requests. Used to open public rooms and files in public rooms.

rootPath?​

optional rootPath: string

Defined in: types/index.ts:275

The base path used for DocSpace navigation. By default, opens a list of rooms.

selectorType?​

optional selectorType: TSelectorType

Defined in: types/index.ts:277

The filter type used in the selector views.

showFilter?​

optional showFilter: boolean

Defined in: types/index.ts:279

Specifies whether the filter options are displayed in the DocSpace manager.

showHeader?​

optional showHeader: boolean

Defined in: types/index.ts:281

Specifies whether the interface header is displayed in the mobile view manager.

showHeaderBanner?​

optional showHeaderBanner: TBannerDisplaying

Defined in: types/index.ts:283

The display settings of the header banner.

showMenu?​

optional showMenu: boolean

Defined in: types/index.ts:285

Specifies whether the left menu is displayed in the DocSpace manager.

showSelectorCancel?​

optional showSelectorCancel: boolean

Defined in: types/index.ts:287

Specifies whether the "Cancel" button is displayed in the selector mode.

showSelectorHeader?​

optional showSelectorHeader: boolean

Defined in: types/index.ts:289

Specifies whether the interface header is displayed in the selector mode.

showSettings?​

optional showSettings: boolean

Defined in: types/index.ts:291

Specifies whether to display the "Manage displayed columns" button for configuring the table columns in the list view.

showSignOut?​

optional showSignOut: boolean

Defined in: types/index.ts:293

Specifies whether the "Sign out" button is displayed.

showTitle?​

optional showTitle: boolean

Defined in: types/index.ts:295

Specifies whether the title of the current section/room/folder is displayed in the DocSpace manager.

src​

src: string

Defined in: types/index.ts:297

The source URL to the iframe used to generate links.

theme?​

optional theme: TTheme | string

Defined in: types/index.ts:299

The UI theme settings.

type?​

optional type: TEditorType

Defined in: types/index.ts:301

The platform type used by the browser and affects the parameters of the inserted object.

viewAs?​

optional viewAs: TManagerViewMode

Defined in: types/index.ts:303

The default view mode - the way items are arranged in the DocSpace manager.

viewTableColumns?​

optional viewTableColumns: string

Defined in: types/index.ts:305

The comma-separated string of table column names that are displayed in the table view mode.

waiting?​

optional waiting: boolean

Defined in: types/index.ts:307

Specifies whether the frame is in the loading state.

width?​

optional width: string

Defined in: types/index.ts:309

The iframe width measured in percentages or pixels.

withBreadCrumbs?​

optional withBreadCrumbs: boolean

Defined in: types/index.ts:311

Specifies whether to show breadcrumb navigation in the selector mode.

withSearch?​

optional withSearch: boolean

Defined in: types/index.ts:313

Specifies whether to display "Search" in the selector mode.

withSubtitle?​

optional withSubtitle: boolean

Defined in: types/index.ts:315

Specifies whether to display a subtitle with additional comments or descriptions for the current directory.