You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
435 lines
25 KiB
435 lines
25 KiB
3 years ago
|
<!doctype html>
|
||
|
|
<html class="default no-js">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
3 years ago
|
<title>TreeItem | VS Code API</title>
|
||
|
|
<meta name="description" content="Documentation for VS Code API">
|
||
|
3 years ago
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
||
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<header>
|
||
|
|
<div class="tsd-page-toolbar">
|
||
|
|
<div class="container">
|
||
|
|
<div class="table-wrap">
|
||
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||
|
|
<div class="field">
|
||
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||
|
|
<input id="tsd-search-field" type="text" />
|
||
|
|
</div>
|
||
|
|
<ul class="results">
|
||
|
|
<li class="state loading">Preparing search index...</li>
|
||
|
|
<li class="state failure">The search index is not available</li>
|
||
|
|
</ul>
|
||
|
3 years ago
|
<a href="../index.html" class="title">VS Code API</a>
|
||
|
3 years ago
|
</div>
|
||
|
|
<div class="table-cell" id="tsd-widgets">
|
||
|
|
<div id="tsd-filter">
|
||
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||
|
|
<div class="tsd-filter-group">
|
||
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
||
|
|
<span class="tsd-select-label">All</span>
|
||
|
|
<ul class="tsd-select-list">
|
||
|
|
<li data-value="public">Public</li>
|
||
|
|
<li data-value="protected">Public/Protected</li>
|
||
|
|
<li data-value="private" class="selected">All</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
||
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="tsd-page-title">
|
||
|
|
<div class="container">
|
||
|
|
<ul class="tsd-breadcrumb">
|
||
|
|
<li>
|
||
|
3 years ago
|
<a href="../modules.html">VS Code API</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li>
|
||
|
3 years ago
|
<a href="TreeItem.html">TreeItem</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h1>Class TreeItem</h1>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<div class="container container-main">
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-8 col-content">
|
||
|
|
<section class="tsd-panel tsd-hierarchy">
|
||
|
|
<h3>Hierarchy</h3>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li>
|
||
|
|
<span class="target">TreeItem</span>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-index-group">
|
||
|
|
<h2>Index</h2>
|
||
|
|
<section class="tsd-panel tsd-index-panel">
|
||
|
|
<div class="tsd-index-content">
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Constructors</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
3 years ago
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TreeItem.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Properties</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
3 years ago
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#label" class="tsd-kind-icon">label</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#id" class="tsd-kind-icon">id</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#iconPath" class="tsd-kind-icon">icon<wbr>Path</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#description" class="tsd-kind-icon">description</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#resourceUri" class="tsd-kind-icon">resource<wbr>Uri</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#tooltip" class="tsd-kind-icon">tooltip</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#command" class="tsd-kind-icon">command</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#collapsibleState" class="tsd-kind-icon">collapsible<wbr>State</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#contextValue" class="tsd-kind-icon">context<wbr>Value</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TreeItem.html#accessibilityInformation" class="tsd-kind-icon">accessibility<wbr>Information</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Constructors</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||
|
|
<a name="constructor" class="tsd-anchor"></a>
|
||
|
|
<h3>constructor</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||
|
3 years ago
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Tree<wbr>Item<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TreeItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeItemLabel</a>, collapsibleState<span class="tsd-signature-symbol">?: </span><a href="../enums/TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></li>
|
||
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Tree<wbr>Item<span class="tsd-signature-symbol">(</span>resourceUri<span class="tsd-signature-symbol">: </span><a href="Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, collapsibleState<span class="tsd-signature-symbol">?: </span><a href="../enums/TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9382">vscode.d.ts:9382</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
3 years ago
|
<h5>label: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TreeItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeItemLabel</a></h5>
|
||
|
3 years ago
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>A human-readable string describing this item</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
3 years ago
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> collapsibleState: <a href="../enums/TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a></h5>
|
||
|
3 years ago
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p><a href="../enums/TreeItemCollapsibleState.html">TreeItemCollapsibleState</a> of the tree item. Default is <a href="../enums/TreeItemCollapsibleState.html#None">TreeItemCollapsibleState.None</a></p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
3 years ago
|
<h4 class="tsd-returns-title">Returns <a href="TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></h4>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9388">vscode.d.ts:9388</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
3 years ago
|
<h5>resourceUri: <a href="Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
|
||
|
3 years ago
|
<div class="tsd-comment tsd-typography">
|
||
|
3 years ago
|
<p>The <a href="Uri.html">Uri</a> of the resource representing this item.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
3 years ago
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> collapsibleState: <a href="../enums/TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a></h5>
|
||
|
3 years ago
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p><a href="../enums/TreeItemCollapsibleState.html">TreeItemCollapsibleState</a> of the tree item. Default is <a href="../enums/TreeItemCollapsibleState.html#None">TreeItemCollapsibleState.None</a></p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
3 years ago
|
<h4 class="tsd-returns-title">Returns <a href="TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></h4>
|
||
|
3 years ago
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel-group tsd-member-group ">
|
||
|
|
<h2>Properties</h2>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="label" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TreeItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeItemLabel</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9302">vscode.d.ts:9302</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p>A human-readable string describing this item. When <code>falsy</code>, it is derived from <a href="TreeItem.html#resourceUri">resourceUri</a>.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="id" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9309">vscode.d.ts:9309</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.</p>
|
||
|
|
</div>
|
||
|
|
<p>If not provided, an id is generated using the tree item's label. <strong>Note</strong> that when labels change, ids will change and that selection and expansion state cannot be kept stable anymore.</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="iconPath" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> icon<wbr>Path</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">icon<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> | </span><a href="ThemeIcon.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeIcon</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>light<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">; </span>dark<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> }</span></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9316">vscode.d.ts:9316</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p>The icon path or <a href="ThemeIcon.html">ThemeIcon</a> for the tree item.
|
||
|
|
When <code>falsy</code>, <a href="ThemeIcon.html#Folder">Folder Theme Icon</a> is assigned, if item is collapsible otherwise <a href="ThemeIcon.html#File">File Theme Icon</a>.
|
||
|
|
When a file or folder <a href="ThemeIcon.html">ThemeIcon</a> is specified, icon is derived from the current file icon theme for the specified theme icon using <a href="TreeItem.html#resourceUri">resourceUri</a> (if provided).</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="description" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9322">vscode.d.ts:9322</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>A human-readable string which is rendered less prominent.
|
||
|
3 years ago
|
When <code>true</code>, it is derived from <a href="TreeItem.html#resourceUri">resourceUri</a> and when <code>falsy</code>, it is not shown.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="resourceUri" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resource<wbr>Uri</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">resource<wbr>Uri<span class="tsd-signature-symbol">:</span> <a href="Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9330">vscode.d.ts:9330</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p>The <a href="Uri.html">Uri</a> of the resource representing this item.</p>
|
||
|
3 years ago
|
</div>
|
||
|
3 years ago
|
<p>Will be used to derive the <a href="TreeItem.html#label">label</a>, when it is not provided.
|
||
|
|
Will be used to derive the icon from current file icon theme, when <a href="TreeItem.html#iconPath">iconPath</a> has <a href="ThemeIcon.html">ThemeIcon</a> value.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="tooltip" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tooltip</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">tooltip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9335">vscode.d.ts:9335</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>The tooltip text when you hover over this item.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="command" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Command.html" class="tsd-signature-type" data-tsd-kind="Interface">Command</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9344">vscode.d.ts:9344</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p>The <a href="../interfaces/Command.html">Command</a> that should be executed when the tree item is selected.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
<p>Please use <code>vscode.open</code> or <code>vscode.diff</code> as command IDs when the tree item is opening
|
||
|
|
something in the editor. Using these commands ensures that the resulting editor will
|
||
|
|
appear consistent with how other built-in trees open editors.</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="collapsibleState" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> collapsible<wbr>State</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">collapsible<wbr>State<span class="tsd-signature-symbol">:</span> <a href="../enums/TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9349">vscode.d.ts:9349</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p><a href="../enums/TreeItemCollapsibleState.html">TreeItemCollapsibleState</a> of the tree item.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="contextValue" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> context<wbr>Value</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">context<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9369">vscode.d.ts:9369</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Context value of the tree item. This can be used to contribute item specific actions in the tree.
|
||
|
|
For example, a tree item is given a context value as <code>folder</code>. When contributing actions to <code>view/item/context</code>
|
||
|
|
using <code>menus</code> extension point, you can specify context value for key <code>viewItem</code> in <code>when</code> expression like <code>viewItem == folder</code>.</p>
|
||
|
|
<pre><code><span style="color: #000000"> </span><span style="color: #A31515">"contributes"</span><span style="color: #000000">: {</span>
|
||
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"menus"</span><span style="color: #001080">:</span><span style="color: #000000"> {</span>
|
||
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"view/item/context"</span><span style="color: #001080">:</span><span style="color: #000000"> [</span>
|
||
|
|
<span style="color: #000000"> {</span>
|
||
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"command"</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">"extension.deleteFolder"</span><span style="color: #000000">,</span>
|
||
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"when"</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">"viewItem == folder"</span>
|
||
|
|
<span style="color: #000000"> }</span>
|
||
|
|
<span style="color: #000000"> ]</span>
|
||
|
|
<span style="color: #000000"> }</span>
|
||
|
|
<span style="color: #000000"> }</span>
|
||
|
|
</code></pre>
|
||
|
|
<p>This will show action <code>extension.deleteFolder</code> only for items with <code>contextValue</code> is <code>folder</code>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||
|
|
<a name="accessibilityInformation" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Information</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">accessibility<wbr>Information<span class="tsd-signature-symbol">:</span> <a href="../interfaces/AccessibilityInformation.html" class="tsd-signature-type" data-tsd-kind="Interface">AccessibilityInformation</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L9376">vscode.d.ts:9376</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Accessibility information used when screen reader interacts with this tree item.
|
||
|
|
Generally, a TreeItem has no need to set the <code>role</code> of the accessibilityInformation;
|
||
|
|
however, there are cases where a TreeItem is not displayed in a tree-like way where setting the <code>role</code> may make sense.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||
|
|
<nav class="tsd-navigation primary">
|
||
|
|
<ul>
|
||
|
|
<li class=" ">
|
||
|
|
<a href="../modules.html">Exports</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
||
|
|
<ul class="before-current">
|
||
|
|
</ul>
|
||
|
|
<ul class="current">
|
||
|
3 years ago
|
<li class="current tsd-kind-class">
|
||
|
|
<a href="TreeItem.html" class="tsd-kind-icon">Tree<wbr>Item</a>
|
||
|
3 years ago
|
<ul>
|
||
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#constructor" class="tsd-kind-icon">constructor</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#label" class="tsd-kind-icon">label</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#id" class="tsd-kind-icon">id</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#iconPath" class="tsd-kind-icon">icon<wbr>Path</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#description" class="tsd-kind-icon">description</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#resourceUri" class="tsd-kind-icon">resource<wbr>Uri</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#tooltip" class="tsd-kind-icon">tooltip</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#command" class="tsd-kind-icon">command</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#collapsibleState" class="tsd-kind-icon">collapsible<wbr>State</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#contextValue" class="tsd-kind-icon">context<wbr>Value</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||
|
3 years ago
|
<a href="TreeItem.html#accessibilityInformation" class="tsd-kind-icon">accessibility<wbr>Information</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<ul class="after-current">
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer class="with-border-bottom">
|
||
|
|
<div class="container">
|
||
|
|
<h2>Legend</h2>
|
||
|
|
<div class="tsd-legend-group">
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||
|
3 years ago
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-legend">
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
<div class="container tsd-generator">
|
||
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||
|
|
</div>
|
||
|
|
<div class="overlay"></div>
|
||
|
|
<script src="../assets/js/main.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|