README

╭──────┬─╮                       ╭─────╮
│        │                       │     │
│      ╭─╯╭───╮╭───╮ ╭──────╮    ├─────┤╭──────╮╭──────╮╭────┬─╮╭──────╮
│      ╰─╮├───┤│   │ │  ──  │    │     ││   ╭──╯│   ╭╮ ││      ││  ────┤
│      ╭─╯│   ││   │ │      │    │     ││   ╰──╮│   ││ ││   ╭╮ ││      │
│      │  │   ││   │ │  ────┤    │     ││      ││   ╰╯ ││   ││ │├────  │
╰──────╯  ╰───╯╰───╯ ╰──────╯    ╰─────╯╰──────╯╰──────╯╰───╯╰─╯╰──────╯
╭─╮ ╭─╮ ┬─╮    ╭─╮ ┬ ┬ ╭─╮   ╭─╮ ╭─╮ ╭─╮ ┬   ┬ ╭─╮ ╭─╮ ╭┬╮ ┬ ╭─╮ ╭╮╭ ╭─╮
├┤  │ │ ├┬╯    ├─╯ ├─┤ ├─╯   ├─┤ ├─╯ ├─╯ │   │ │   ├─┤  │  │ │ │ │││ ╰─╮
┴   ╰─╯ ┴╰─    ┴   ┴ ┴ ┴     ┴ ┴ ┴   ┴   ┴─╯ ┴ ╰─╯ ┴ ┴  ┴  ┴ ╰─╯ ╯╰╯ ╰─╯

File specific icons for PHP. A port of Atom File-icons, https://github.com/file-icons/atom

Install

1- Use Composer to install as follows,

composer require websemantics/file-icons

Getting Started

Create an instance of FileIcons class.

use Websemantics\FileIcons\FileIcons;

$icons = new FileIcons();

Include css styles in the header of an html document. This will generate a link tag that points to the package stylesheet.

FileIcons::includeCss();

Get the class name of the icon that represent a filename, for example text-icon.

$filename = 'src/index.php';
$class_name = $icons->getClass($filename);

You can also get a class name of the associated icon color.

$filename = 'README.md';
$class_name = $icons->getClassWithColor($filename);

Use the class name to generate html, for example

echo "<a><i class='$class_name'></i>$filename</a>";

Check out - Markdown Browser Plus to see implementation details.

Resources

Atom File Icons, file specific icons for improved visual grepping.
Markdown Browser Plus, Github flavoured, local file browser for viewing markdown documentation files.

Support

Need help or have a question? post at StackOverflow.

Please don't use the issue trackers for support/questions.

Star if you find this project useful, to show support or simply for being awesome :)

Contribution

Contributions to this project are accepted in the form of feedback, bugs reports and even better - pull requests.

websemantics / file-icons

Maintainers

Details