1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 06:40:05 +08:00
SpaceVim/docs/api/notify.md

30 lines
794 B
Markdown
Raw Normal View History

2021-08-06 19:19:00 +08:00
---
title: "notify API"
description: "notify API provides some basic functions for generating notifications"
---
# [Available APIs](../) >> notify
<!-- vim-markdown-toc GFM -->
- [Intro](#intro)
- [Functions](#functions)
<!-- vim-markdown-toc -->
## Intro
This api provides some basic Functions for generating notifications.
```vim
let s:NOTIFY = SpaceVim#api#import('notify')
call s:NOTIFY.notify('This is a simple notification!')
```
## Functions
| function name | description |
| --------------------------- | ------------------------------------------------- |
| `notify(string)` | generate notification with default color |
| `notify(string, highlight)` | generate notification with custom highlight group |