https://github.com/websemantics/file-icons-js
File specific icons for Javascript. A port of Atom File-icons (see https://github.com/file-icons/atom)
https://github.com/websemantics/file-icons-js
devicons icons javascript mfizz nodejs octicons
Last synced: 3 months ago
JSON representation
File specific icons for Javascript. A port of Atom File-icons (see https://github.com/file-icons/atom)
- Host: GitHub
- URL: https://github.com/websemantics/file-icons-js
- Owner: websemantics
- License: mit
- Created: 2017-03-27T02:24:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-31T03:03:48.000Z (almost 4 years ago)
- Last Synced: 2024-09-20T13:07:25.097Z (9 months ago)
- Topics: devicons, icons, javascript, mfizz, nodejs, octicons
- Language: JavaScript
- Homepage: https://websemantics.github.io/file-icons-js/
- Size: 519 KB
- Stars: 85
- Watchers: 3
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
```
╭───────╮ ╭────╮
│ ╭──╯╭───╮╭───╮╭──────╮ ├────┤╭──────╮╭──────╮╭────┬─╮╭──────╮
│ ╰──╮├───┤│ ││ ── │ │ ││ ╭──╯│ ╭╮ ││ ││ ────┤
│ ╭──╯│ ││ ││ │ │ ││ ╰──╮│ ││ ││ ╭╮ ││ │
│ │ │ ││ ││ ────┤ │ ││ ││ ╰╯ ││ ││ │├──── │
╰────╯ ╰───╯╰───╯╰──────╯ ╰────╯╰──────╯╰──────╯╰───╯╰─╯╰──────╯
╭─╮ ╭─╮ ┬─╮ ┬ ╭─╮ ┬ ┬ ╭─╮ ╭─╮ ╭─╮ ┬─╮ ┬ ╭─╮ ╭┬╮
├┤ │ │ ├┬╯ │ ├─┤ ╰╮╭╯ ├─┤ ╰─╮ │ ├┬╯ │ ├─╯ │
┴ ╰─╯ ┴╰─ ╰─╯ ┴ ┴ ╰╯ ┴ ┴ ╰─╯ ╰─╯ ┴╰─ ┴ ┴ ┴
```
> File specific icons for the browser from Atom File-icons, https://github.com/file-icons/atom
[](https://websemantics.github.io/file-icons-js)
## Install
Use `npm` to install as follows,
```bash
npm i websemantics/file-icons-js
```
Or, `Bower`,
```bash
bower i websemantics/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,
```js
var icons = window.FileIcons;
```
Get the class name of the icon that represent a filename (for example `text-icon`),
```js
var filename = 'src/app.js';
var class_name = icons.getClass(filename);
```
You can also get a class name of the associated icon color,
```js
var filename = 'README.md';
var class_name = icons.getClassWithColor(filename);
```
Use the class name to generate html, for example,
```js
document.body.innerHTML = "$filename";
```
## Resources
- [Atom File Icons](https://github.com/file-icons/atom), file specific icons for improved visual grepping.
- [Markdown Browser Plus](https://github.com/websemantics/markdown-browser-plus), Github flavoured, local file browser for markdown docs.
## Support
Need help or have a question? post at [StackOverflow](https://stackoverflow.com/questions/tagged/file-icons-js+websemantics).
*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.
## License
[MIT license](http://opensource.org/licenses/mit-license.php) Copyright (c) Web Semantics, Inc.