1.0.1 • Published 3 years ago

element-ui-file-manager v1.0.1

Weekly downloads
13
License
MIT
Repository
github
Last release
3 years ago

laravel-file-manager (Vuejs with Element design)

this repo is foked from https://github.com/alexusmai/vue-laravel-file-manager the purpose is replace bootstrap design with element design

Laravel File Manager

v 1.0

Now you can overwrite default settings using props and show or hide actions

Installation

NPM

$ npm install laravel-file-manager-element --save

Usage

** To Show Admin Buttons (copy, paste, file upload, delete) Pass object settings with property settings for instance

<file-manager :settings="fileManagerSettings"></file-manager>

fileManagerSettings: {
            showAdminButtons: true
},

IF your App using Vuex store

import FileManager from 'laravel-file-manager'
import store from './path-to-your-store/store'   // your Vuex store

Vue.use(FileManager, {store})

ELSE you need to create a new vuex instance

import Vue from 'vue';
import Vuex from 'vuex';
import FileManager from 'laravel-file-manager'

Vue.use(Vuex);

// create Vuex store, if you don't have it
const store = new Vuex.Store();

Vue.use(FileManager, {store});

The application store module will be registered under the name 'fm'

You can overwrite some default settings

// In the new version 2.4.0 and higher
<file-manager v-bind:settings="settings"></file-manager>

...
// settings object structure
settings: {
    // axios headers
    headers: {
      'X-Requested-With': 'XMLHttpRequest',
      Authorization: `Bearer ${window.localStorage.getItem('user-token')}`,
    },
    baseUrl: 'http://test.loc/file-manager/',   // overwrite base url Axios
    windowsConfig: 2,                           // overwrite config
    lang: 'de',                                 // set language
    translation: {                              // add new translation
        name: de,
        content: {
            about: 'Über',
            back: 'Zurück',
            ... see lang file structure
        },
    },
},
...

// Old versions
Vue.use(FileManager, {
    store, // required
    
    // not required params
    
    headers: {
        'X-Requested-With': 'XMLHttpRequest',
        'Authorization': 'Bearer ...'
    },
    // default headers example
    headers: {
        'X-Requested-With': 'XMLHttpRequest',
        'X-CSRF-TOKEN': 'set laravel csrf token here...'
    },
    
    baseUrl: 'http://my_url:80/file-manager/',  // overwrite base url Axios
    windowsConfig: 2,
    lang: 'de',                                 // set language
    translation: {                              // add new translation
        name: de,
        content: {
            about: 'Über',
            back: 'Zurück',
            ... see lang file structure
        },
    },
}

Now vue component is registered and you can use it in your app

<file-manager></file-manager>

Available Props

settings - Object

AttributeTypeExampleRequiredDescription
headersObject{'X-Requested-With': 'XMLHttpRequest'}NoAxios Headers
baseUrlString'http://my_url:80/file-manager/'NoAxios base URL
windowsConfigInt2No1 - only one manager, 2 - manager with folder tree, 3 - two managers
langString'de'NoSet language
translationObject{ ... see lang file structure },NoAdd new translation

CSRF, Bootstrap, FontAwesome

Don't forget add a csrf token to head block in your Laravel view and add bootstrap 4 and fontawesome 5 styles

<!-- CSRF Token -->
<meta name="csrf-token" content="{{ csrf_token() }}">
<!-- Example -->
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.0/css/all.css">
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css">

You can use environment variables

// set baseUrl
MIX_LFM_BASE_URL=http://my-url.loc/file-manager/

// if you don't want to use csrf-token - you can off it
MIX_LFM_CSRF_TOKEN=OFF

Warning! Package use axios (Promise) - use babel-polyfill for ie11