#+author: conao3 #+date: <2020-03-20 Fri>

[[https://github.com/conao3/dired-posframe.el][https://raw.githubusercontent.com/conao3/files/master/blob/headers/png/dired-posframe.el.png]] [[https://github.com/conao3/dired-posframe.el/blob/master/LICENSE][https://img.shields.io/github/license/conao3/dired-posframe.el.svg?style=flat-square]] [[https://github.com/conao3/dired-posframe.el/releases][https://img.shields.io/github/tag/conao3/dired-posframe.el.svg?style=flat-square]] [[https://github.com/conao3/dired-posframe.el/actions][https://github.com/conao3/dired-posframe.el/workflows/Main%20workflow/badge.svg]] [[https://app.codacy.com/project/conao3/dired-posframe.el/dashboard][https://img.shields.io/codacy/grade/62a36f4f04524d5e8c758440e8071c45.svg?logo=codacy&style=flat-square]] [[https://www.patreon.com/conao3][https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon&style=flat-square]] [[https://twitter.com/conao_3][https://img.shields.io/badge/twitter-@conao__3-blue.svg?logo=twitter&style=flat-square]] [[https://conao3-support.slack.com/join/shared_invite/enQtNjUzMDMxODcyMjE1LWUwMjhiNTU3Yjk3ODIwNzAxMTgwOTkxNmJiN2M4OTZkMWY0NjI4ZTg4MTVlNzcwNDY2ZjVjYmRiZmJjZDU4MDE][https://img.shields.io/badge/chat-on_slack-blue.svg?logo=slack&style=flat-square]]

• Table of Contents

• [[#description][Description]]
• [[#install][Install]]
• [[#usage][Usage]]
• [[#customize][Customize]]
• [[#information][Information]]
  • [[#community][Community]]
  • [[#contribution][Contribution]]
  • [[#migration][Migration]]
  • [[#license][License]]
  • [[#author][Author]]
  • [[#contributors][Contributors]]

• Description [[https://github.com/conao3/dired-posframe.el][https://raw.githubusercontent.com/conao3/files/master/blob/dired-posframe.el/dired-posframe.gif]]

• Image support ::

[[https://raw.githubusercontent.com/conao3/files/master/blob/dired-posframe.el/dired-posframe-image.png][https://raw.githubusercontent.com/conao3/files/master/blob/dired-posframe.el/dired-posframe-image.png]]

This package is a [[https://github.com/asok/peep-dired][peep-dired]] inspired, dired glimpse package using [[https://github.com/tumashu/posframe][posframe]].

• Install Sample install code using [[https://github.com/conao3/leaf.el][leaf.el]].

#+begin_src emacs-lisp (leaf dired-posframe :ensure t :hook dired-mode-hook) #+end_src

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

#+begin_src emacs-lisp (leaf dired-posframe :ensure t :bind ((dired-mode-map ("C-*" . dired-posframe-show)))) #+end_src

• 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 [[https://conao3-support.slack.com/join/shared_invite/enQtNjUzMDMxODcyMjE1LWUwMjhiNTU3Yjk3ODIwNzAxMTgwOTkxNmJiN2M4OTZkMWY0NjI4ZTg4MTVlNzcwNDY2ZjVjYmRiZmJjZDU4MDE][Slack]] if you want a more casual conversation.

** Contribution We welcome PR!

*** Require tools for testing

• keg #+begin_src shell cd ~/ hub clone conao3/keg .keg export PATH="$HOME/.keg/bin:$PATH" #+end_src

*** Running test Below operation flow is recommended. #+begin_src shell git branch [feature-branch] # Create branch named [feature-branch] git checkout [feature-branch] # Checkout branch named [feature-branch]

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 #+end_src

** Migration

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

** Author

• Naoya Yamashita ([[https://github.com/conao3][conao3]])

** Contributors