https://github.com/sebastiencs/company-box

A company front-end with icons
https://github.com/sebastiencs/company-box

company completion emacs front-end

Last synced: 1 day ago
JSON representation

A company front-end with icons

• Host: GitHub
• URL: https://github.com/sebastiencs/company-box
• Owner: sebastiencs
• Created: 2018-03-15T03:09:42.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T09:21:54.000Z (11 months ago)
• Last Synced: 2025-01-29T07:22:23.820Z (5 days ago)
• Topics: company, completion, emacs, front-end
• Language: Emacs Lisp
• Homepage:
• Size: 597 KB
• Stars: 569
• Watchers: 7
• Forks: 64
• Open Issues: 63
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# company-box

[![MELPA](http://melpa.org/packages/company-box-badge.svg)](http://melpa.org/#/company-box)

A company front-end with icons.  

![company-box](company-box.png)

Differences with the built-in front-end:  

- Differents colors for differents backends.

- Icons associated to functions/variables/.. and their backends

- Display candidate's documentation (support `quickhelp-string`)

- Not limited by the current window size, buffer's text properties, .. (it's better than you might think)

This package requires emacs 26.  

Also, not compatible with emacs in a tty.  

### Installation

``` el

;; With use-package:

(use-package company-box

  :hook (company-mode . company-box-mode))

;; Or:

(require 'company-box)

(add-hook 'company-mode-hook 'company-box-mode)

```

To customize:  

`M-x customize-group [RET] company-box [RET]`   

### Backends colors

See the docstring of the variable `company-box-backends-colors`:  

`C-h v company-box-backends-colors`

### Themes

You can select different themes with `company-box-icons-alist`

### Icons

See the variable `company-box-icons-functions`  

For now, there are customs icons for 4 backends only: `company-lsp`, `company-elisp`, `company-yasnippet` and `company-php`.  

You can customize their icons with the variables:  

`company-box-icons-lsp`, `company-box-icons-elisp`, `company-box-icons-yasnippet` and `company-box-icons-acphp`.

Notes:  

By default, images are used to display icons.  

You can also use [font icons](https://github.com/sebastiencs/company-box/wiki/icons)  

With images, you can't change icons colors

### Top margin

You can position the frame downwards by setting the variable `company-box-frame-top-margin` to a positive number. This is useful if your base code/text has an enlarged line height, and company box is intruding into the line above. It's also useful, if you're using copilot and want to see a few lines of suggested code unobscured by the company box. See [PR #205](https://github.com/sebastiencs/company-box/pull/205) for details.

You can set the top margin mode-dependent via mode hooks, if you want. E.g. in Doom Emacs:

``` el

(use-package! company-box

  :defer t

  :config

  (setq-hook! 'prog-mode-hook

    company-box-frame-top-margin 20)

  (setq-hook! 'text-mode-hook

    company-box-frame-top-margin 75)

)

```