https://github.com/yajra/laravel-datatables-ui
Laravel DataTables UI Preset
https://github.com/yajra/laravel-datatables-ui
datatables laravel preset
Last synced: 3 months ago
JSON representation
Laravel DataTables UI Preset
- Host: GitHub
- URL: https://github.com/yajra/laravel-datatables-ui
- Owner: yajra
- License: mit
- Created: 2020-06-18T04:48:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-25T03:28:25.000Z (almost 5 years ago)
- Last Synced: 2025-03-17T11:11:20.957Z (3 months ago)
- Topics: datatables, laravel, preset
- Language: PHP
- Size: 27.3 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel DataTables UI Preset
[](https://packagist.org/packages/yajra/laravel-datatables-ui)
[](https://packagist.org/packages/yajra/laravel-datatables-ui)
Laravel DataTables UI Preset to setup most of the scripts and css required for a DataTables powered projects.
## Installation
You can install the package via composer:
```bash
composer require yajra/laravel-datatables-ui
```
## Usage
Once the package has been installed, you may install the frontend scaffolding using the ui Artisan command:
```bash
// Generate basic scaffolding...
php artisan ui dt
// Generate login / registration scaffolding...
php artisan ui dt --auth
```
## Usage with DataTables Editor
If you have license and want to use Editor, you need to setup the following:
1. Enable editor library on `bootstrap.js`
```js
require('datatables.net-editor-bs4');
```
2. Use `laravel-datatables-assets` package instead of `buttons.server-side.js` script on `app.js`.
```js
//require('./vendor/buttons.server-side');
require('laravel-datatables-assets/js/dataTables.buttons');
```
3. Add `postinstall` script on package,json
```js
"scripts": {
"dev": "npm run development",
...,
"postinstall": "node ./node_modules/datatables.net-editor/install.js ./Editor.zip"
},
```
4. Download your copy of Editor Library JS + CSS file and save as `Editor.zip`.
5. Move `Editor.zip` to your project base directory.
6. Run `npm install && npm run dev` to compile changes.
## Blade Directive @dataTable
To use `@dataTable` blade directive, you need to firt setup the following on your layout file.
1. Include `app.css` on your layout.
2. Include `app.js` on your layout.
3. Add `@stack('scripts')` after `app.js` script include.
### Example layout & page
**resources/views/layouts/app.php**
```php
Laravel
@yield('content')
@stack('scripts')
```
Create your dataTables class. See https://yajrabox.com/docs/laravel-datatables/master/buttons-starter for details.
On your view:
```php
@extends('layouts.app')
@section('content')
@dataTable
@endsection
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Arjay Q. Angeles](https://github.com/yajra)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.