https://github.com/elp-revive/company-box

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

company-box revive

Last synced: about 1 month ago
JSON representation

A company front-end with icons

• Host: GitHub
• URL: https://github.com/elp-revive/company-box
• Owner: elp-revive
• License: gpl-3.0
• Created: 2021-07-19T06:41:40.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2025-02-24T18:07:07.000Z (3 months ago)
• Last Synced: 2025-02-24T19:23:21.291Z (3 months ago)
• Topics: company-box, revive
• Language: Emacs Lisp
• Homepage:
• Size: 770 KB
• Stars: 2
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

[![JCS-ELPA](https://raw.githubusercontent.com/jcs-emacs/badges/master/elpa/v/company-box.svg)](https://jcs-emacs.github.io/jcs-elpa/#/company-box)

# company-box

[![CI](https://github.com/elp-revive/company-box/actions/workflows/test.yml/badge.svg)](https://github.com/elp-revive/company-box/actions/workflows/test.yml)

A company front-end with icons.

![company-box](etc/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.

**Table of Contents**

- [company-box](#company-box)

    - [💾 Installation](#💾-installation)

    - [🌈 Backends colors](#🌈-backends-colors)

    - [Themes](#themes)

    - [Icons](#icons)

    - [company-box-doc](#company-box-doc)

## 💾 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

## company-box-doc

Customization:

* `company-box-doc-enable` enable company-box-doc

* `company-box-doc-delay` Number of seconds before showing the doc

* `company-box-doc-text-scale-level` Text scale amount for doc buffer