Skip to content

README.md

Latest commit

 

History

History
53 lines (39 loc) · 1.21 KB

README.md

File metadata and controls

53 lines (39 loc) · 1.21 KB

fs-explorer Build Status

A WIP file system explorer element.

example

Installing/Running

git clone git://github.com/shama/fs-explorer && cd fs-explorer
npm i
npm start

Visit http://localhost:9966

Example

The example currently loads example/example-fs-tree.json as a mock file system but will hopefully be connected to dat soon.

https://shama.github.io/fs-explorer

Usage

Has not yet been published to npm. Please git clone and run npm link then in your project run npm link fs-explorer. This project is still experimental but should be published soon.

var explorer = require('fs-explorer')

// Build a file tree
var files = [
  {
    path: 'bears',
    type: 'folder',
    mtime: new Date(),
    children: [
      {
        path: 'bears/grizzly.js',
        type: 'file',
        mtime: new Date(),
      }
    ]
  }
]

// Render the element and append to page
var element = explorer(files)
document.body.appendChild(element)
⚡