dots.vscode.comment — io.github.dots-cljs/dots-vscode 1.89.0-5

A comment is displayed within the editor or the Comments Panel, depending on how it is provided.

author cljs

(author comment)

The {@link CommentAuthorInformation author information} of the comment

body cljs

(body comment)

The human-readable comment body

context-value cljs

(context-value comment)

Context value of the comment. This can be used to contribute comment specific actions. For example, a comment is given a context value as editable. When contributing actions to comments/comment/title using menus extension point, you can specify context value for key comment in when expression like comment == editable.

"contributes": {
	"menus": {
		"comments/comment/title": [
			{
				"command": "extension.deleteComment",
				"when": "comment == editable"
			}
		]
	}
}

This will show action extension.deleteComment only for comments with contextValue is editable.

label cljs

(label comment)

Optional label describing the {@link Comment } Label will be rendered next to authorName if exists.

mode cljs

(mode comment)

{@link CommentMode Comment mode} of the comment

reactions cljs

(reactions comment)

Optional reactions of the {@link Comment }

set-author! cljs

(set-author! comment value)

The {@link CommentAuthorInformation author information} of the comment

set-body! cljs

(set-body! comment value)

The human-readable comment body

set-context-value! cljs

(set-context-value! comment value)

Context value of the comment. This can be used to contribute comment specific actions. For example, a comment is given a context value as editable. When contributing actions to comments/comment/title using menus extension point, you can specify context value for key comment in when expression like comment == editable.

"contributes": {
	"menus": {
		"comments/comment/title": [
			{
				"command": "extension.deleteComment",
				"when": "comment == editable"
			}
		]
	}
}

This will show action extension.deleteComment only for comments with contextValue is editable.

set-label! cljs

(set-label! comment value)

Optional label describing the {@link Comment } Label will be rendered next to authorName if exists.

set-mode! cljs

(set-mode! comment value)

{@link CommentMode Comment mode} of the comment

set-reactions! cljs

(set-reactions! comment value)

Optional reactions of the {@link Comment }

set-timestamp! cljs

(set-timestamp! comment value)

Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings.

timestamp cljs

(timestamp comment)

Optional timestamp that will be displayed in comments. The date will be formatted according to the user's locale and settings.