1.1.0 • Published 6 years ago
@gurupras/file-icons-js v1.1.0
╭───────╮ ╭────╮
│ ╭──╯╭───╮╭───╮╭──────╮ ├────┤╭──────╮╭──────╮╭────┬─╮╭──────╮
│ ╰──╮├───┤│ ││ ── │ │ ││ ╭──╯│ ╭╮ ││ ││ ────┤
│ ╭──╯│ ││ ││ │ │ ││ ╰──╮│ ││ ││ ╭╮ ││ │
│ │ │ ││ ││ ────┤ │ ││ ││ ╰╯ ││ ││ │├──── │
╰────╯ ╰───╯╰───╯╰──────╯ ╰────╯╰──────╯╰──────╯╰───╯╰─╯╰──────╯
╭─╮ ╭─╮ ┬─╮ ┬ ╭─╮ ┬ ┬ ╭─╮ ╭─╮ ╭─╮ ┬─╮ ┬ ╭─╮ ╭┬╮
├┤ │ │ ├┬╯ │ ├─┤ ╰╮╭╯ ├─┤ ╰─╮ │ ├┬╯ │ ├─╯ │
┴ ╰─╯ ┴╰─ ╰─╯ ┴ ┴ ╰╯ ┴ ┴ ╰─╯ ╰─╯ ┴╰─ ┴ ┴ ┴
File specific icons for the browser from Atom File-icons, https://github.com/file-icons/atom
Install
Use npm
to install as follows,
npm i @gurupras/file-icons-js
Getting Started
Include css
styles from css/style.css
in the header of an html document.
Get an instance of FileIcons
class,
var icons = window.FileIcons;
Get the class name of the icon that represent a filename (for example text-icon
),
var filename = 'src/app.js';
var class_name = icons.getClass(filename);
You can also get a class name of the associated icon color,
var filename = 'README.md';
var class_name = icons.getClassWithColor(filename);
Use the class name to generate html, for example,
document.body.innerHTML = "<a><i class=" + class_name + "></i>$filename</a>";
Resources
- websemantics/file-icons-js, Original repository from which this was forked.
- Atom File Icons, file specific icons for improved visual grepping.
Contribution
Contributions to this project are accepted in the form of feedback, bugs reports and even better - pull requests.