Skip to content

Commit

Permalink
#53911 - render setting descriptions as markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
roblourens committed Jul 11, 2018
1 parent 0f699f3 commit 72918ea
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,18 @@
opacity: 0.7;
margin-top: 3px;
overflow: hidden;
white-space: pre;
text-overflow: ellipsis;
height: 18px;
}

.settings-editor > .settings-body > .settings-tree-container .setting-item .setting-item-description * {
margin: 0px;
}

.settings-editor > .settings-body > .settings-tree-container .setting-item .setting-item-description code {
line-height: 15px; /** For some reason, this is needed, otherwise <code> will take up 20px height */
}

.settings-editor > .settings-body > .settings-tree-container .setting-measure-container.monaco-tree-row {
position: absolute;
visibility: hidden;
Expand All @@ -209,7 +216,6 @@
.settings-editor > .settings-body > .settings-tree-container .setting-item.is-expanded .setting-item-description,
.settings-editor > .settings-body > .settings-tree-container .setting-item.setting-measure-helper .setting-item-description {
height: initial;
white-space: pre-wrap;
}

.settings-editor > .settings-body > .settings-tree-container .setting-item-bool .setting-item-value-description {
Expand Down
6 changes: 5 additions & 1 deletion src/vs/workbench/parts/preferences/browser/settingsTree.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import { ICssStyleCollector, ITheme, IThemeService, registerThemingParticipant }
import { SettingsTarget } from 'vs/workbench/parts/preferences/browser/preferencesWidgets';
import { ITOCEntry } from 'vs/workbench/parts/preferences/browser/settingsLayout';
import { ISearchResult, ISetting, ISettingsGroup } from 'vs/workbench/services/preferences/common/preferences';
import { renderMarkdown } from 'vs/base/browser/htmlContentRenderer';

const $ = DOM.$;

Expand Down Expand Up @@ -677,7 +678,10 @@ export class SettingsRenderer implements IRenderer {

template.labelElement.textContent = element.displayLabel;
template.labelElement.title = titleTooltip;
template.descriptionElement.textContent = element.description;

const renderedDescription = renderMarkdown({ value: element.description });
template.descriptionElement.innerHTML = '';
template.descriptionElement.appendChild(renderedDescription);

this.renderValue(element, isSelected, <ISettingItemTemplate>template);

Expand Down

0 comments on commit 72918ea

Please sign in to comment.