Class TerminalApp
Source: terminalApp.ts
Extends
App<TerminalProps>
Constructors
Constructor
new TerminalApp():
TerminalApp
Returns
TerminalApp
Overrides
App<TerminalProps>.constructor
Properties
name
name:
string
The display name of this application.
Inherited from
App.name
id
id:
string
The unique ID of this application.
Inherited from
App.id
windowContent
windowContent:
FC<TerminalProps>
Main component that renders this app inside a window.
Inherited from
App.windowContent
windowOptions?
optionalwindowOptions:Partial<TerminalProps> &DefaultWindowOptions
Default options that get passed to the App.windowContent component.
Inherited from
App.windowOptions
description
description:
string|null
Description of this application.
Inherited from
App.description
iconUrl
iconUrl:
string|null
URL of the icon of this application.
Inherited from
App.iconUrl
role
role:
string|null
Defines what the app can handle and how it can be used elsewhere in the system.
Inherited from
App.role
associatedExtensions
associatedExtensions:
string[]
An array of file extensions that this application can interpret.
Inherited from
App.associatedExtensions
pinnedByDefault
pinnedByDefault:
boolean
Determines whether the app is pinned by default.
Default
trueInherited from
App.pinnedByDefault
launchAtStartup
launchAtStartup:
boolean
Determines whether the app is launched at startup.
Default
falseInherited from
App.launchAtStartup
category
category:
"Business"|"Developer tools"|"Education"|"Entertainment"|"Food & dining"|"Health & fitness"|"Kids & family"|"Lifestyle"|"Media"|"Medical"|"Multimedia design"|"Music"|"Navigation & maps"|"News & weather"|"Personal finance"|"Personalization"|"Photo & video"|"Productivity"|"Security"|"Shopping"|"Social"|"Sports"|"Travel"|"Utilities & tools"|null
The category the app belongs to.
Inherited from
App.category
metadata
metadata:
AppMetadata|null
Metadata of the app's package.
Inherited from
App.metadata
showDesktopIcon
showDesktopIcon:
boolean
Determines whether a desktop icon is added to the default data.
Default
falseInherited from
App.showDesktopIcon
isActive
isActive:
boolean
Inherited from
App.isActive
isPinned?
optionalisPinned:boolean
Inherited from
App.isPinned
isInstalled
isInstalled:
boolean
Inherited from
App.isInstalled
WindowContent()
WindowContent: (
props:TerminalProps) =>Element|null
Returns the component that renders the content of a window for this app.
Parameters
props
TerminalProps
Returns
Element | null
Inherited from
App.WindowContent
Methods
setName()
setName(
name:string):this
Sets the display name of this application.
Parameters
name
string
Returns
this
Inherited from
App.setName
setDescription()
setDescription(
description:string|null):this
Sets the description of this application.
Parameters
description
string | null
Returns
this
Inherited from
App.setDescription
setIconUrl()
setIconUrl(
iconUrl:string|null):this
Sets the URL of the icon of this application.
Parameters
iconUrl
string | null
Returns
this
Inherited from
App.setIconUrl
setRole()
setRole(
role:string|null):this
Sets the role of this application.
Parameters
role
string | null
Returns
this
Inherited from
App.setRole
setAssociatedExtensions()
setAssociatedExtensions(
extensions:string[] |null):this
Sets the associated extensions of this application.
Parameters
extensions
string[] | null
Returns
this
Inherited from
App.setAssociatedExtensions
setPinnedByDefault()
setPinnedByDefault(
pinnedByDefault:boolean):this
Changes whether this application is pinned by default or not.
Parameters
pinnedByDefault
boolean
Returns
this
Inherited from
App.setPinnedByDefault
setLaunchAtStartup()
setLaunchAtStartup(
launchAtStartup:boolean):this
Changes whether this application is launched at startup or not.
Parameters
launchAtStartup
boolean
Returns
this
Inherited from
App.setLaunchAtStartup
setInstalled()
setInstalled(
installed:boolean):this
Changes whether this application is installed by default or not.
Parameters
installed
boolean
Returns
this
Inherited from
App.setInstalled
setCategory()
setCategory(
category:"Business"|"Developer tools"|"Education"|"Entertainment"|"Food & dining"|"Health & fitness"|"Kids & family"|"Lifestyle"|"Media"|"Medical"|"Multimedia design"|"Music"|"Navigation & maps"|"News & weather"|"Personal finance"|"Personalization"|"Photo & video"|"Productivity"|"Security"|"Shopping"|"Social"|"Sports"|"Travel"|"Utilities & tools"|null):this
Sets the category this application belongs to.
Parameters
category
"Business" | "Developer tools" | "Education" | "Entertainment" | "Food & dining" | "Health & fitness" | "Kids & family" | "Lifestyle" | "Media" | "Medical" | "Multimedia design" | "Music" | "Navigation & maps" | "News & weather" | "Personal finance" | "Personalization" | "Photo & video" | "Productivity" | "Security" | "Shopping" | "Social" | "Sports" | "Travel" | "Utilities & tools" | null
Returns
this
Inherited from
App.setCategory
setMetadata()
setMetadata(
metadata:AppMetadata|null):this
Sets the metadata for this application.
Parameters
metadata
AppMetadata | null
Returns
this
Inherited from
App.setMetadata
setShowDesktopIcon()
setShowDesktopIcon(
showDesktopIcon:boolean):this
Changes whether this application has a desktop icon in the default data.
Parameters
showDesktopIcon
boolean
Returns
this
Inherited from
App.setShowDesktopIcon
setWindowOptions()
setWindowOptions(
windowOptions:Partial<TerminalProps> &DefaultWindowOptions):this
Sets the default options for the App.windowContent component.
Parameters
windowOptions
Partial<TerminalProps> & DefaultWindowOptions
Returns
this
Inherited from
App.setWindowOptions
addCommands()
addCommands(
commands:Command[]):TerminalApp
Parameters
commands
Command[]
Returns
TerminalApp
addCommand()
addCommand(
command:Command):TerminalApp
Parameters
command
Returns
TerminalApp