Ghibranalj / better-dired-posframe.el

Glimpse dired items using posframe

Table of Contents

• Description
• Install
• Usage
• Customize
• Information
  • Community
  • Contribution
  • Migration
  • License
  • Author
  • Contributors

Description

Image support

This package is a peep-dired inspired, dired glimpse package using posframe.

Install

Sample install code using leaf.el.

(leaf dired-posframe
  :ensure t
  :hook dired-mode-hook)

OR, You can use manual dired-posframe. Hide posframe to type C-g.

(leaf dired-posframe
  :ensure t
  :bind ((dired-mode-map
          ("C-*" . dired-posframe-show))))

Usage

Enable dired-posframe-mode in dired buffer.

Customize

dired-posframe-file-size-limit

File size limit in Bytes. (default: (* 1 1024 1024))

dired-posframe-enable-modes

Major mode automatically enabled. (default: ~’(image-mode)~)

dired-posframe-style

The style of dired-posframe. (default: ~’point~)

dired-posframe-font

The font used by dired-posframe. (default: nil)

dired-posframe-width

The width of dired-posframe. (default: 80)

dired-posframe-height

The height of dired-posframe. (default: 40)

dired-posframe-min-width

The width of dired-min-posframe. (default: 80)

dired-posframe-min-height

The height of dired-min-posframe. (default: nil)

dired-posframe-border-width

The border width used by dired-posframe. (default: 1)

dired-posframe-parameters

The frame parameters used by dired-posframe. (defaullt: nil)

dired-posframe-use-post-command-hook

If non-nil, enable additional useful features using `post-command-hook’. (default: t)

dired-posframe

Face used by the dired-posframe. (default: ~’((t (:inherit default)))~)

dired-posframe-border

Face used by the dired-posframe’s border. (default: ~’((t (:inherit default :background “gray50”)))~)

Information

Community

Any feedback or suggestions are welcome!

You can use github issues, but you can also use Slack if you want a more casual conversation.

Contribution

We welcome PR!

Require tools for testing

• keg

  cd ~/
  hub clone conao3/keg .keg
  export PATH="$HOME/.keg/bin:$PATH"
      

Running test

Below operation flow is recommended.

git branch [feature-branch]       # Create branch named [feature-branch]
git checkout [feature-branch]     # Checkout branch named [feature-branch]

# <edit loop>
emacs dired-posframe.el           # Edit something you want

make test                         # Test dired-posframe
git commit -am "brabra"           # Commit (auto-run test before commit)
# </edit loop>

hub fork                          # Create fork at GitHub
git push [user] [feature-branch]  # Push feature-branch to your fork
hub pull-request                  # Create pull-request

Migration

License

General Public License Version 3 (GPLv3)
Copyright (c) Naoya Yamashita - https://conao3.com
https://github.com/conao3/dired-posframe.el/blob/master/LICENSE

Author

• Naoya Yamashita (conao3)

Contributors