tuil
ReferencePackages@mwillbanks/tuil-devtoolsAPI

DevtoolsPanelContribution

interface exported by @mwillbanks/tuil-devtools.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-devtools.

export interface DevtoolsPanelContribution extends DevtoolsContribution {
  readonly kind: "panel";
  inspect(): unknown;
  readonly searchText?: () => string;
}

Members

MemberTypeRequiredDescriptionRelated types
kind"panel"YesThe kind member uses the "panel" contract.
inspect() => unknownYesThe inspect member uses the () => unknown contract.
searchText(() => string) | undefinedNoThe searchText member uses the (() => string) | undefined contract.
idstringYesThe id member uses the string contract.
titlestringYesThe title member uses the string contract.
iconstring | undefinedNoThe icon member uses the string | undefined contract.
requiredCapabilitiesreadonly DevtoolsCapability[] | undefinedNoThe requiredCapabilities member uses the readonly DevtoolsCapability[] | undefined contract.DevtoolsCapability
activation(() => boolean) | undefinedNoThe activation member uses the (() => boolean) | undefined contract.
permissionsReadonlySet<DevtoolsPermission>YesThe permissions member uses the ReadonlySet<DevtoolsPermission> contract.DevtoolsPermission
serialization"json"YesThe serialization member uses the "json" contract.
dispose(() => void) | undefinedNoThe dispose member uses the (() => void) | undefined contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-devtools

On this page