# @olgachr/s3manager

> s3manager is a file manager component for vuejs.

Latest version **1.0.4** (published 2022-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @olgachr/s3manager
pnpm add @olgachr/s3manager
yarn add @olgachr/s3manager
bun add @olgachr/s3manager
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-12-20 |
| First published | 2022-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 506.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Yusuf Özdemir |
| Maintainers | olgachr |
| Keywords | vue, file manager, file plugin, file explorer, finder |

## Links

- npm: https://www.npmjs.com/package/@olgachr/s3manager
- Repository: https://github.com/n1crack/vuefinder
- Homepage: https://github.com/n1crack/vuefinder#readme
- Issues: https://github.com/n1crack/vuefinder/issues
- npm.io page: https://npm.io/package/@olgachr/s3manager

## Dependencies (5)

- [vue](https://npm.io/package/vue.md) ^3.2.0
- [plupload](https://npm.io/package/plupload.md) ^2.3.9
- [cropperjs](https://npm.io/package/cropperjs.md) ^1.5.12
- [dragselect](https://npm.io/package/dragselect.md) ^2.3.1
- [vanilla-lazyload](https://npm.io/package/vanilla-lazyload.md) ^17.8.3

## Recent versions

- 1.0.4 (latest) — 2022-12-20
- 1.0.3 — 2022-12-20

## README

## Vuefinder File Manager

![GitHub](https://img.shields.io/github/license/n1crack/vuefinder)
![npm](https://img.shields.io/npm/v/vuefinder)

[//]: # (![npm](https://img.shields.io/npm/dw/vuefinder))

![ezgif-1-b902690b76](https://user-images.githubusercontent.com/712404/193141338-8d5f726f-da1a-4825-b652-28e4007493db.gif)

### About
Vuefinder is a file manager component for Vue.js version 3

### Demo
[Live Demo](https://vuefinder.ozdemir.be/) [ [Source](https://github.com/n1crack/vuefinder.ozdemir.be) ]

### Installation


```bash
npm i @olgachr/s3manager
```

JS entry point (it can be index.js or main.js)
```js
import { createApp } from 'vue'
import App from './App.vue'

import '@olgachr/s3manager/dist/style.css'
import VueFinder from '@olgachr/s3manager/dist/vuefinder'

const app = createApp(App)

app.use(VueFinder)

app.mount('#app')
 
```
Html
```html
...
<div>
    <vue-finder id='my_vuefinder' url="http://vuefinder-php.test"></vue-finder>
</div>
...
```

### Props

| Prop          |  Value  | Default | Description                            |
|---------------|:-------:|---------|:---------------------------------------|
| id            | string  | _null_  | required                               |
| url           | string  | _null_  | required - backend url                 |
| locale        | string  | en      | optional - default language code       |
| dark          | boolean | false   | optional - makes theme dark as default |
| max-file-size | string  | 10mb    | optional - client side max file upload |

### Events
@change - return selected file item

### Features 
- Multi adapter/storage (see https://github.com/thephpleague/flysystem)
- File and folder operations
  - Create a new file 
  - Create a new folder 
  - Rename 
  - Delete 
  - Archive (zip)
  - Unarchive (unzip)
  - Text editing
  - Image Crop Tool
  - Upload / Download files
  - Search (deep based on current folder) 
- Nice UI
  - Context Menu
  - Breadcrumb links
  - Toolbar
  - File explorer
  - Status bar
  - Image thumbnails
  - Toast notifications
- Appearance
  - Multi language
  - Full Screen
  - View Modes: list, grid
  - Dark Mode
- Accessibility
  - Drag & drop support
  - Move items (to a folder or up one folder) with drag and drop
  - Mouse selection

### Backend
- PHP: [VueFinder Php Library](https://github.com/n1crack/vuefinder-php)

### Roadmap
- [ ] code refactoring (cleanup the duplications, make reusable components)
- [ ] restyle the modals
- [ ] add more languages (only en/tr/ru at the moment. PRs are welcomed.)
- [ ] copy/move to a folder (modal, treeview)
- [ ] transfer items between adapters

### Dependencies
 - [Vue3](https://vuejs.org/)
 - [Cropperjs](https://github.com/fengyuanchen/cropperjs)  : JavaScript image cropper
 - [DragSelect](https://github.com/ThibaultJanBeyer/DragSelect/) : Selection utility
 - [Plupload](https://github.com/moxiecode/plupload) : Upload library
 - [vanilla-lazyload](https://github.com/verlok/vanilla-lazyload) : lazy loading for thumbnails

### License
Copyright (c) 2018 Yusuf ÖZDEMİR, released under [the MIT license](LICENSE)

---
_Source: https://npm.io/package/@olgachr/s3manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._