Skip to content

@sqlrooms/artifacts / UseArtifactTabsResult

Type Alias: UseArtifactTabsResult ​

UseArtifactTabsResult = object

Properties ​

tabsId? ​

optional tabsId?: string


tabs ​

tabs: ArtifactTabDescriptor[]


openTabs ​

openTabs: string[]


selectedTabId? ​

optional selectedTabId?: string


artifactTypes ​

artifactTypes: ArtifactTypeDefinitions<any>


createArtifact ​

createArtifact: (type?, options?) => string | undefined

Parameters ​

ParameterType
type?string
options?{ title?: string; }
options.title?string

Returns ​

string | undefined


openArtifact ​

openArtifact: (artifactId) => void

Parameters ​

ParameterType
artifactIdstring

Returns ​

void


closeArtifact ​

closeArtifact: (artifactId) => void

Parameters ​

ParameterType
artifactIdstring

Returns ​

void


deleteArtifact ​

deleteArtifact: (artifactId) => void

Parameters ​

ParameterType
artifactIdstring

Returns ​

void


renameArtifact ​

renameArtifact: (artifactId, title) => void

Parameters ​

ParameterType
artifactIdstring
titlestring

Returns ​

void


reorderArtifacts ​

reorderArtifacts: (openArtifactIds) => void

Parameters ​

ParameterType
openArtifactIdsstring[]

Returns ​

void


selectArtifact ​

selectArtifact: (artifactId) => void

Parameters ​

ParameterType
artifactIdstring

Returns ​

void


handleOpenTabsChange ​

handleOpenTabsChange: (openArtifactIds) => void

Parameters ​

ParameterType
openArtifactIdsstring[]

Returns ​

void