Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lazy load listing columns #2857

Merged
merged 5 commits into from Nov 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion resources/js/components/Listing.vue
Expand Up @@ -16,6 +16,10 @@ export default {
props: {
initialSortColumn: String,
initialSortDirection: String,
initialColumns: {
type: Array,
default: () => [],
},
filters: Array,
},

Expand All @@ -25,7 +29,8 @@ export default {
initializing: true,
loading: true,
items: [],
columns: [],
columns: this.initialColumns,
visibleColumns: this.initialColumns.filter(column => column.visible),
sortColumn: this.initialSortColumn,
sortDirection: this.initialSortDirection,
meta: null,
Expand All @@ -42,6 +47,7 @@ export default {
perPage: this.perPage,
search: this.searchQuery,
filters: this.activeFilterParameters,
columns: this.visibleColumns.map(column => column.field).join(','),
}, this.additionalParameters);
},

Expand Down
2 changes: 2 additions & 0 deletions resources/js/components/collections/View.vue
Expand Up @@ -89,6 +89,7 @@
:collection="handle"
:initial-sort-column="sortColumn"
:initial-sort-direction="sortDirection"
:initial-columns="columns"
:filters="filters"
:run-action-url="runActionUrl"
:bulk-actions-url="bulkActionsUrl"
Expand Down Expand Up @@ -183,6 +184,7 @@ export default {
structured: { type: Boolean, default: false },
sortColumn: { type: String, required: true },
sortDirection: { type: String, required: true },
columns: { type: Array, required: true },
filters: { type: Array, required: true },
runActionUrl: { type: String, required: true },
bulkActionsUrl: { type: String, required: true },
Expand Down
6 changes: 5 additions & 1 deletion resources/js/components/data-list/DataList.vue
Expand Up @@ -95,7 +95,11 @@ export default {

sortColumn(column) {
this.sharedState.sortColumn = column;
}
},

visibleColumns(columns) {
this.$emit('visible-columns-updated', columns);
},

},

Expand Down
1 change: 1 addition & 0 deletions resources/js/components/entries/Listing.vue
Expand Up @@ -12,6 +12,7 @@
:sort="false"
:sort-column="sortColumn"
:sort-direction="sortDirection"
@visible-columns-updated="visibleColumns = $event"
>
<div slot-scope="{ hasSelections }">
<div class="card p-0 relative">
Expand Down
1 change: 1 addition & 0 deletions resources/js/components/forms/SubmissionListing.vue
Expand Up @@ -14,6 +14,7 @@
:sort="false"
:sort-column="sortColumn"
:sort-direction="sortDirection"
@visible-columns-updated="visibleColumns = $event"
>
<div slot-scope="{ hasSelections }">
<div class="card p-0 relative">
Expand Down
1 change: 1 addition & 0 deletions resources/js/components/terms/Listing.vue
Expand Up @@ -12,6 +12,7 @@
:sort="false"
:sort-column="sortColumn"
:sort-direction="sortDirection"
@visible-columns-updated="visibleColumns = $event"
>
<div slot-scope="{ hasSelections }">
<div class="card p-0 relative">
Expand Down
1 change: 1 addition & 0 deletions resources/views/collections/show.blade.php
Expand Up @@ -13,6 +13,7 @@
:blueprints='@json($blueprints)'
sort-column="{{ $collection->sortField() }}"
sort-direction="{{ $collection->sortDirection() }}"
:columns="{{ $columns->toJson() }}"
:filters="{{ $filters->toJson() }}"
run-action-url="{{ cp_route('collections.entries.actions.run', $collection->handle()) }}"
bulk-actions-url="{{ cp_route('collections.entries.actions.bulk', $collection->handle()) }}"
Expand Down
1 change: 1 addition & 0 deletions resources/views/forms/show.blade.php
Expand Up @@ -54,6 +54,7 @@
bulk-actions-url="{{ cp_route('forms.submissions.actions.bulk', $form->handle()) }}"
initial-sort-column="datestamp"
initial-sort-direction="desc"
:initial-columns="{{ $columns->toJson() }}"
v-cloak
>
<div slot="no-results" class="text-center border-2 border-dashed rounded-lg">
Expand Down
1 change: 1 addition & 0 deletions resources/views/taxonomies/show.blade.php
Expand Up @@ -46,6 +46,7 @@
taxonomy="{{ $taxonomy->handle() }}"
initial-sort-column="{{ $taxonomy->sortField() }}"
initial-sort-direction="{{ $taxonomy->sortDirection() }}"
:initial-columns="{{ $columns->toJson() }}"
:filters="{{ $filters->toJson() }}"
run-action-url="{{ cp_route('taxonomies.terms.actions.run', $taxonomy->handle()) }}"
bulk-actions-url="{{ cp_route('taxonomies.terms.actions.bulk', $taxonomy->handle()) }}"
Expand Down
8 changes: 8 additions & 0 deletions src/Http/Controllers/CP/Collections/CollectionsController.php
Expand Up @@ -60,10 +60,18 @@ public function show(Request $request, $collection)

$site = $request->site ? Site::get($request->site) : Site::selected();

$columns = $collection
->entryBlueprint()
->columns()
->setPreferred("collections.{$collection->handle()}.columns")
->rejectUnlisted()
->values();

$viewData = [
'collection' => $collection,
'blueprints' => $blueprints,
'site' => $site->handle(),
'columns' => $columns,
'filters' => Scope::filters('entries', [
'collection' => $collection->handle(),
'blueprints' => $blueprints->pluck('handle')->all(),
Expand Down
9 changes: 8 additions & 1 deletion src/Http/Controllers/CP/Forms/FormsController.php
Expand Up @@ -41,7 +41,14 @@ public function show($form)
{
$this->authorize('view', $form);

return view('statamic::forms.show', compact('form'));
$columns = $form
->blueprint()
->columns()
->setPreferred("forms.{$form->handle()}.columns")
->rejectUnlisted()
->values();

return view('statamic::forms.show', compact('form', 'columns'));
}

/**
Expand Down
8 changes: 8 additions & 0 deletions src/Http/Controllers/CP/Taxonomies/TaxonomiesController.php
Expand Up @@ -54,11 +54,19 @@ public function show($taxonomy)
];
});

$columns = $taxonomy
->termBlueprint()
->columns()
->setPreferred("taxonomies.{$taxonomy->handle()}.columns")
->rejectUnlisted()
->values();

$viewData = [
'taxonomy' => $taxonomy,
'hasTerms' => true, // todo $taxonomy->queryTerms()->count(),
'blueprints' => $blueprints,
'site' => Site::selected()->handle(),
'columns' => $columns,
'filters' => Scope::filters('terms', [
'taxonomy' => $taxonomy->handle(),
'blueprints' => $blueprints->pluck('handle')->all(),
Expand Down
42 changes: 42 additions & 0 deletions src/Http/Resources/CP/Concerns/HasRequestedColumns.php
@@ -0,0 +1,42 @@
<?php

namespace Statamic\Http\Resources\CP\Concerns;

trait HasRequestedColumns
{
protected function requestedColumns()
{
if (! $requested = $this->requestedColumnKeys()) {
return $this->columns;
}

return $this->columns->keyBy('field')->only($requested)->values();
}

protected function visibleColumns()
{
if (! $requested = $this->requestedColumnKeys()) {
return $this->columns;
}

$columns = $this->columns->keyBy('field')->map->visible(false);

return collect($requested)
->map(function ($field) use ($columns) {
return $columns->get($field)->visible(true);
})
->merge($columns->except($requested))
->values();
}

protected function requestedColumnKeys()
{
$columns = request('columns');

if (! $columns) {
return [];
}

return explode(',', $columns);
}
}
7 changes: 5 additions & 2 deletions src/Http/Resources/CP/Entries/Entries.php
Expand Up @@ -3,9 +3,12 @@
namespace Statamic\Http\Resources\CP\Entries;

use Illuminate\Http\Resources\Json\ResourceCollection;
use Statamic\Http\Resources\CP\Concerns\HasRequestedColumns;

class Entries extends ResourceCollection
{
use HasRequestedColumns;

public $collects = ListedEntry::class;
protected $blueprint;
protected $columnPreferenceKey;
Expand Down Expand Up @@ -43,11 +46,11 @@ public function toArray($request)
'data' => $this->collection->each(function ($entry) {
$entry
->blueprint($this->blueprint)
->columns($this->columns);
->columns($this->requestedColumns());
}),

'meta' => [
'columns' => $this->columns,
'columns' => $this->visibleColumns(),
],
];
}
Expand Down
7 changes: 5 additions & 2 deletions src/Http/Resources/CP/Submissions/Submissions.php
Expand Up @@ -4,9 +4,12 @@

use Illuminate\Http\Resources\Json\ResourceCollection;
use Statamic\CP\Column;
use Statamic\Http\Resources\CP\Concerns\HasRequestedColumns;

class Submissions extends ResourceCollection
{
use HasRequestedColumns;

public $collects = ListedSubmission::class;
protected $blueprint;
protected $columns;
Expand Down Expand Up @@ -46,11 +49,11 @@ public function toArray($request)
'data' => $this->collection->each(function ($collection) {
$collection
->blueprint($this->blueprint)
->columns($this->columns);
->columns($this->requestedColumns());
}),

'meta' => [
'columns' => $this->columns,
'columns' => $this->visibleColumns(),
],
];
}
Expand Down
7 changes: 5 additions & 2 deletions src/Http/Resources/CP/Taxonomies/Terms.php
Expand Up @@ -3,9 +3,12 @@
namespace Statamic\Http\Resources\CP\Taxonomies;

use Illuminate\Http\Resources\Json\ResourceCollection;
use Statamic\Http\Resources\CP\Concerns\HasRequestedColumns;

class Terms extends ResourceCollection
{
use HasRequestedColumns;

public $collects = ListedTerm::class;
protected $blueprint;
protected $columnPreferenceKey;
Expand Down Expand Up @@ -43,11 +46,11 @@ public function toArray($request)
'data' => $this->collection->each(function ($term) {
$term
->blueprint($this->blueprint)
->columns($this->columns);
->columns($this->requestedColumns());
}),

'meta' => [
'columns' => $this->columns,
'columns' => $this->visibleColumns(),
],
];
}
Expand Down