Skip to content

Composable fixes #117

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

Merged
merged 1 commit into from
Jan 12, 2025
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions resources/js/Composables/useLazyDataTable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ import { usePaginatedData } from './usePaginatedData';
import * as PrimeVue from '@/types/primevue';

export function useLazyDataTable(
defaultFilters: PrimeVue.PaginatedDataFilters = {},
initialFilters: PrimeVue.PaginatedDataFilters = {},
only: string[] = ['request'],
initialsRows: number = 20
) {
const defaultFilters = initialFilters;
const defaultRows = initialsRows;

const {
processing,
filters,
Expand All @@ -17,8 +20,7 @@ export function useLazyDataTable(
scrollToTop,
fetchData,
paginate,
reset,
} = usePaginatedData(defaultFilters, only, initialsRows);
} = usePaginatedData(initialFilters, only, initialsRows);

function parseEventFilterValues() {
Object.keys(filters.value).forEach((key) => {
Expand All @@ -30,6 +32,10 @@ export function useLazyDataTable(
});
}

/**
* "Override" parent composable function
* Event driven filtering rather than reactive state
*/
function filter(event: { filters: PrimeVue.PaginatedDataFilters }) {
pagination.value.page = 1;
filters.value = { ...event.filters };
Expand All @@ -48,6 +54,25 @@ export function useLazyDataTable(
});
}

/**
* "Override" parent composable function
* usePaginatedData() resets sorting.value state as a new object, this will not work for DataTable's
*/
function reset() {
Object.keys(defaultFilters).forEach((key) => {
filters.value[key].value = defaultFilters[key].value;
});
sorting.value.field = '';
sorting.value.order = 1;
pagination.value = {
page: 1,
rows: defaultRows,
};
fetchData().then(() => {
window.history.replaceState(null, '', window.location.pathname);
});
}

return {
processing,
filters,
Expand Down
30 changes: 22 additions & 8 deletions resources/js/Composables/usePaginatedData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,27 @@ interface SortState {
}

export function usePaginatedData(
defaultFilters: PrimeVue.PaginatedDataFilters = {},
initialFilters: PrimeVue.PaginatedDataFilters = {},
only: string[] = ['request'],
initialsRows: number = 20
) {
const defaultFilters = initialFilters;
const defaultRows = initialsRows;

const page = usePage<{
request: {
urlParams: PrimeVue.PaginatedDataUrlParams;
};
}>();

const processing = ref<boolean>(false);
const filters = ref<PrimeVue.PaginatedDataFilters>(defaultFilters);
const filters = ref<PrimeVue.PaginatedDataFilters>(initialFilters);
const sorting = ref<SortState>({
field: '',
order: 1,
});
const pagination = ref<PaginationState>({
page: parseInt(page.props.request.urlParams?.page ?? '1'),
page: 1,
rows: initialsRows,
});

Expand Down Expand Up @@ -108,16 +111,23 @@ export function usePaginatedData(
}

function reset() {
filters.value = defaultFilters;
// Alternatively just use: router.get(window.location.pathname);
// Caveat to the above approach, we would lose state from our page not related to pagination/filtering/sorting

Object.keys(defaultFilters).forEach((key) => {
filters.value[key].value = defaultFilters[key].value;
});
sorting.value = {
field: '',
order: 1,
};
pagination.value = {
page: 1,
rows: initialsRows,
rows: defaultRows,
};
fetchData();
fetchData().then(() => {
window.history.replaceState(null, '', window.location.pathname);
});
}

function parseUrlFilterValues() {
Expand Down Expand Up @@ -164,10 +174,14 @@ export function usePaginatedData(
};
parseUrlFilterValues();
if (urlParams?.sortField) {
sorting.value.field = urlParams?.sortField;
sorting.value.field = urlParams.sortField;
}
if (urlParams?.sortOrder) {
sorting.value.order = parseInt(urlParams?.sortOrder) ? 1 : 0;
sorting.value.order =
(parseInt(urlParams.sortOrder) as 0 | 1 | -1) || null;
}
if (urlParams?.page) {
pagination.value.page = parseInt(urlParams.page);
}
}

Expand Down
Loading