# filemanager

[![npm](https://img.shields.io/npm/v/filemanager.svg) ![npm](https://img.shields.io/npm/dm/filemanager.svg)](https://www.npmjs.com/package/filemanager)
[![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)

A Vue.js Plugin for arranging and labeling images. Originally developed for Figgy at Princeton University Library.

## Table of contents

- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)

# Installation

```
npm install --save filemanager
```

## Default import

Install all the components:

```javascript
import Vue from 'vue'
import Filemanager from 'filemanager'

Vue.use(Filemanager)
```

Use specific components:

```javascript
import Vue from 'vue'
import { Test } from 'filemanager'

Vue.component('test', Test)
```

**⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.**

## Distribution import

Install all the components:

```javascript
import 'filemanager/dist/filemanager.css'
import Filemanager from 'filemanager/dist/filemanager.common'

Vue.use(Filemanager)
```

Use specific components:

```javascript
import 'filemanager/dist/filemanager.css'
import { Test } from 'filemanager/dist/filemanager.common'

Vue.component('test', Test)
```

**⚠️ You may have to setup your bundler to embed the css file in your page.**

## Browser

```html
<link rel="stylesheet" href="filemanager/dist/filemanager.css"/>

<script src="vue.js"></script>
<script src="filemanager/dist/filemanager.browser.js"></script>
```

The plugin should be auto-installed. If not, you can install it manually with the instructions below.

Install all the components:

```javascript
Vue.use(Filemanager)
```

Use specific components:

```javascript
Vue.component('test', Filemanager.Test)
```

## Source import

Install all the components:

```javascript
import Vue from 'vue'
import Filemanager from 'filemanager/src'

Vue.use(Filemanager)
```

Use specific components:

```javascript
import Vue from 'vue'
import { Test } from 'filemanager/src'

Vue.component('test', Test)
```

**⚠️ You need to configure your bundler to compile `.vue` files.** More info [in the official documentation](https://vuejs.org/v2/guide/single-file-components.html).

# Usage

> TODO

# Example

> TODO

---

# Plugin Development

## Installation

The first time you create or clone your plugin, you need to install the default dependencies:

```
npm install
```

## Watch and compile

This will run webpack in watching mode and output the compiled files in the `dist` folder.

```
npm run dev
```

## Use it in another project

While developping, you can follow the install instructions of your plugin and link it into the project that uses it.

In the plugin folder:

```
npm link
```

In the other project folder:

```
npm link filemanager
```

This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.

## Publish to npm

You may have to login to npm before, with `npm adduser`. The plugin will be built in production mode before getting published on npm.

```
npm publish
```

## Manual build

This will build the plugin into the `dist` folder in production mode.

```
npm run build
```

---

## License

[MIT](http://opensource.org/licenses/MIT)