Skip to content

airblade/vim-tailwind

Repository files navigation

vim-tailwind

A Vim plugin to autocomplete Tailwind class names without LSP.

It also lets you look up a Tailwind class's CSS properties.

Screenshots

Showing completions for text-zinc-:

Screenshot of completions for text-zinc-

Showing class information for text-zinc-600 in the command-line area:

Screenshot of completions for text-zinc-

Tailwind version

v3.3.5

Installation

Install like every other Vim plugin :)

Configuration

These options customise the completion items (see :help complete-items).

  • g:tailwind_complete_item_info - whether to set the info text (default v:true).
  • g:tailwind_complete_item_menu - whether to set the menu text (default v:true).
  • g:tailwind_complete_item_menu_length - maximum length of the menu text (default 40).
  • g:tailwind_complete_items_max - maximum number of items to show (default: 50).

Usage

Autocompletion

For user-defined autocompletion (via <C-X><C-U>):

setlocal completefunc=tailwind#Complete

Or for omnicompletion (via <C-X><C-O>):

setlocal omnifunc=tailwind#Complete

I have the following snippet in my vimrc to set this up:

function! s:is_tailwind()
  return !empty(findfile('tailwind.config.js', '.;')) ||
       \ !empty(findfile('config/tailwind.config.js', '.;'))
endfunction

autocmd BufEnter *.html,*.slim if s:is_tailwind() |
      \   setlocal omnifunc=tailwind#Complete |
      \ endif

Lookup

Unless you have K mapped already, press K in normal mode with your cursor on a Tailwind class.

To map some other key, e.g. gk:

nmap <silent> <buffer> gk <Plug>(tailwind-lookup)

Caveats

The plugin ignores modifiers, e.g. sm: or hover:. They affect when the CSS is applied, not what the CSS actually is, so they are irrelevant here.

The plugin ignores @media at-rules. This only affects the .container class.

Intellectual property

Copyright Andrew Stewart. Released under the MIT licence.

About

A Vim plugin to autocomplete Tailwind classes without LSP. Also looks up Tailwind classes' CSS properties.

Topics

Resources

License

Stars

Watchers

Forks