- Notifications
You must be signed in to change notification settings - Fork7
This Package created on top of Laravel livewire for easily handling CSV imports with a simple API.
License
coderflexx/laravel-csv
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
- Introduction
- Installation
- Configuration
- Usage
- Testing
- Changelog
- Contributing
- Security Vulnerabilities
- Inspiration
- Credits
- License
Laravel CSV Package is a package created on top of Laravellivewire for easily handling imports with a simple API.
You can install the package via composer:
composer require coderflex/laravel-csv
Publish and run the migrations with:
php artisan vendor:publish --tag="csv-migrations"php artisan migrateAdd traitHasCsvImports to your User model.
Publish the config file with:
php artisan vendor:publish --tag="csv-config"The following is the contents of the published config file:
return [/* |-------------------------------------------------------------------------- | Default Layout |-------------------------------------------------------------------------- | | This package plans on supporting multiple CSS frameworks. | Currently, 'tailwindcss' is the default and only supported framework. | */'layout' =>'tailwindcss',/* |-------------------------------------------------------------------------- | Max Upload File Size |-------------------------------------------------------------------------- | | The default maximumum file size that can be imported by this | package is 20MB. If you wish to increase/decrease this value, | change the value in KB below. | */'file_upload_size' =>20000,];
Thelayout option is for choosing which CSS framework you are using and currently supports onlytailwindcss. We are working on other CSS frameworks to implement in the future.
Thefile_upload_size is for validation rules, and it defines the maximum file size of uploaded files. You may also define this value from thelivewire config file.
Optionally, you can publish the views using
php artisan vendor:publish --tag="laravel-csv-views"Before Using this command, please take a look at thissection below.
Using this package is a breeze. To implement the importer in your project, simply include the following component inside a Blade view.
<livewire:csv-importer:model="App\Models\YourModel::class":columns-to-map="['id', 'name', 'email', 'password']":required-columns="['id', 'name', 'email']":columns-label="[ 'id' => 'ID', 'name' => 'Name', 'email' => 'Email Address', 'password' => 'Password', ]"/>
| Props | Type | Description |
|---|---|---|
| model | string | Fully qualified name of the model you wish to import to |
| columns-to-map | array | Column names in the target database table |
| required-columns | array | Columns that are required by validation for import |
| columns-label | array | Display labels for the required columns |
The Component usesalpinejs under the hood. To display an import button, include thex-csv-button component.
<x-csv-button>Import</x-csv-button>
To style the button, use theclass attribute with Tailwind utility classes.
<x-csv-buttonclass="rounded py-2 px-3 bg-indigo-500 ..."type="button"....>{{__('Import')}}</x-csv-button>
If you are using this package in aTALL Stack project, (Tailwindcss, Alpinejs, Laravel, Livewire) publish the vendor views to include Laravel-CSV in your project.
php artisan vendor:publish --tag="csv-views"Then compile your assets.
npm run dev
If you are not using the TALL Stack, use thecsv directives to add the necessary styles/scripts.
<html> ... <head> ...@csvStyles </head> ... <footer> ...@csvScripts </footer></html>
This package usesqueues under the hood withPHP Generators to make it fast and efficient.
Create thebatches table by running
php artisan queue:batches-table
Then, run the migration.
php artisan migrateAfter that, set up the queues' configuration.Head toLaravel Queues Documentation to learn more.
composertestPlease seeCHANGELOG for more information on what has changed recently.
Please seeCONTRIBUTING for details.
Please reviewour security policy on how to report security vulnerabilities.
This Package Was Inspired bycodecourse video series. If you want to learn how this package was created, make sure to take a look at thisvideo series
The MIT License (MIT). Please seeLicense File for more information.
About
This Package created on top of Laravel livewire for easily handling CSV imports with a simple API.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.
Contributors6
Uh oh!
There was an error while loading.Please reload this page.