FileExplorerJs
Description
A pure JavaScript component for creating a file explorer interface.
Why Use FileExplorerJs?
- Pure JavaScript - No HTML, CSS or 3rd party library requirements (e.g. jquery). All HTML components and elements are created dynamically.
- Independant - Object is run in its own namespace to avoid conflicts with other libraries.
- All Screen Sizes - Can be used with desktop, tablet and mobile browsers.
- Easy to Install - Simply download the library and import it into your project.
- Easy to Use - Create an file explorer view with a few lines of code.
- Customisable - Multiple options to configure the view and operation. Create your own layout and define api locations for context menu operations.
- Beautiful - Styled by default out of the box.
- Tiny - 37 kb uncompressed source code.
Getting Started
Installation
- Run this command
npm i fileexplorerjs --save
- Add as a resource.
Useage
To generate a fileexplorer view you must first specify a config object then pass this to the init() function. See example below:
Contributors
Develop
If you would like to contribute to the project. To get a development environment up and running on your local system. Simply follow the instructions below.
- Install latest version of Node.js
https://nodejs.org/en/download/
- Clone repository to your system using the following command or git desktop
git clone https://github.com/Joshua-W-Adams/modalator
- Install repository dependencies
npm install
- Serve module with web server
gulp serve
- Sample module can now be accessed on localhost
http://localhost/
Deployment
- Lint application
gulp lint
- Build dist files
gulp build
- Submit pull request to master branch on repository
License
Copyright (C) 2020 Joshua Adams This program is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.