1c/bsl_console
1
0
Fork 0
mirror of https://github.com/salexdv/bsl_console.git synced 2024-11-28 08:48:48 +02:00
Code Issues Releases Activity
20323694bf
bsl_console/docs/custom_suggestions.md

2.5 KiB
Raw Blame History

Функция showCustomSuggestions

Назначение функции

Функция показывает пользовательские подсказки в текущей позиции курсора

Параметры функции

  • suggestions - string, подсказки в виде JSON-объекта, содержащего следующие поля:
    • name - заголовок подсказки
    • text - текст, вставляемый в редактор при выборе подсказки
    • kind - одно из значений перечисления CompletionItemKind
    • detail - дополнительное описание элемента, показываемое в окне подсказок
    • description - документация к элементу
    • filter - текст, используемый для фильтрации. Необязательно поле.
    • sort - строка, используемая для сортировки элемента в списке. Необязательно поле.

Пример вызова

showCustomSuggestions(`{
	"Подсказка1": {
		"name": "Подсказка №1",
		"text": "Подсказка №1 вставляемый текст",
		"kind": "Class",
		"detail": "Расширенная подсказка #1",
		"documentation": "Документация #1"
	},
	"Подсказка2": {
		"name": "Подсказка №2",
		"text": "Подсказка №2 ()",
		"kind": "Method",
		"detail": "Расширенная подсказка #2",
		"documentation": "Документация #2"
	}
}`);