Monaco 使用 SignatureHelpProvider

Monaco 中 SignatureHelpProvider 是方法提示说明,当敲入方法名时,系统会提示方法名称和对应的参数信息。效果如下:

在这里插入图片描述
通过 registerSignatureHelpProvider 实现 SignatureHelpProvider 处理函数。

在这里插入图片描述
实现 signatureHelpTriggerCharacters 和 provideSignatureHelp

  • signatureHelpTriggerCharacters: 返回触发方法说明的字符列表
  • provideSignatureHelp:返回方法信息
    在这里插入图片描述
    返回 SignatureHelpResult
    在这里插入图片描述
    SignatureHelpResult 包含 activeParameter、activeSignature、SignatureInformation[] 三个参数。
    在这里插入图片描述
    SignatureInformation 函数接口信息
    在这里插入图片描述
    ParameterInformation 参数信息
    在这里插入图片描述
    代码实现如下

export function signatureHelpProvider(
  editor: monacoEditor.editor.IStandaloneCodeEditor,
  monaco: typeof monacoEditor
) {
  
  return monaco.languages.registerSignatureHelpProvider("mySpecialLanguage", {
    signatureHelpTriggerCharacters: ['(', ','],
    provideSignatureHelp: function (model, positions, token, context) {
      
      const signature = {
        label: 'add(a: number, b: number): number',
        parameters: [
            {
                label: 'a',
                documentation: 'The first number'
            },
            {
                label: 'b',
                documentation: 'The second number'
            }
            ]
        };

        const result = {
            signatures: [signature],
            activeSignature: 0,
            activeParameter: 0
        };

        return {
            value: result,
            dispose: () => { }
        };
    }
  });
}
  • 6
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值