https://github.com/angrycoding/maciconforfile
Node module to get the icon for any file in the filesystem (macOS only)
https://github.com/angrycoding/maciconforfile
Last synced: 10 months ago
JSON representation
Node module to get the icon for any file in the filesystem (macOS only)
- Host: GitHub
- URL: https://github.com/angrycoding/maciconforfile
- Owner: angrycoding
- Created: 2016-12-21T15:32:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T07:24:29.000Z (over 1 year ago)
- Last Synced: 2025-04-09T18:14:43.808Z (10 months ago)
- Language: Objective-C++
- Size: 288 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💜If you like my projects, you can support me.
| Coin/Symbol | Network | Adress |
|------|---------|--------|
| Bitcoin (BTC) | BTC | 1LU7DtLiKkWe3aAXbhRhNAMUFdrapWuAHW |
| Tether (USDT) | TRC20 | TK7f7TXozWVbkHxdArAJd2rELu725q1Ac5 |
| Tether (USDT) | TON | UQDI4e7xm_B7O_REaYd5CoyEz1Ki08t0EPlUim022_K9B2xa |
# macIconForFile [](https://npmjs.org/package/mac-file-icon)
Get the native macOS icon for a specific file extension as a PNG image buffer.
Inspired and based on:
* https://github.com/kevinsawicki/mac-extension-icon
* https://github.com/incbee/NSImage-QuickLook
Retrieves icon, exactly the same way as Finder does it, including QuickLook preview generation in case if it's possible, just check out the example at the end of this page. My motivation to write this module was impossiblity to obtain file system's entry icon in Electron, there is simply no method to do that.
### Installation
```bash
npm install mac-file-icon
```
### Usage
```javascript
var getIconForFile = require('mac-file-icon');
getIconForFile('/Users/', function(buffer) {
console.info(buffer);
});
```
You can always convert Buffer into it's base64 representation:
```javascript
var getIconForFile = require('mac-file-icon');
getIconForFile('/Users/', function(buffer) {
console.info(buffer.toString('base64'));
});
```
In case if callback is ommited, Buffer will be returned in synchronous way:
```javascript
var getIconForFile = require('mac-file-icon');
console.info(getIconForFile('/Users/'));
```
By default, icon size is set to 32x32, you can adjust it by passing additional argument:
```javascript
var getIconForFile = require('mac-file-icon');
// icon size 64x64
getIconForFile('/Users/', function(buffer) {
console.info(buffer);
}, 64);
```
Works same way in synchronous calls:
```javascript
var getIconForFile = require('mac-file-icon');
// icon size 64x64
console.info(getIconForFile('/Users/', 64));
```
### Build it yourself
```bash
cd macIconForFile
npm install
node-gyp configure
node-gyp build
```
However I'm not sure if last two statements are required...
### Example
You can try out an example included into the package, that uses [Express](https://github.com/expressjs/express), [Histone](https://github.com/MegafonWebLab/histone-javascript) and **macIconForFile** to generate file listing in the browser.
```bash
npm install mac-file-icon
cd node_modules/mac-file-icon/example
npm install
node index.js
```
Then open your web browser and navigate to http://localhost:8080/ (in case if this port number is taken, edit index.js and set another one), you will see something like this:
