Merge pull request #12 from bryanmylee/rename-plugins

rename: useX -> addX

README.md

@@ -33,15 +33,16 @@ Svelte Headless Table is designed with extensibility in mind. Its complex featur
 
 ### Plugin roadmap
 
-- [x] [useSortBy](https://svelte-headless-table.bryanmylee.com/docs/plugins/use-sort-by)
-- [x] [useColumnFilters](https://svelte-headless-table.bryanmylee.com/docs/plugins/use-column-filters)
-- [x] [useTableFilter](https://svelte-headless-table.bryanmylee.com/docs/plugins/use-table-filter)
-- [x] [useColumnOrder](https://svelte-headless-table.bryanmylee.com/docs/plugins/use-column-order)
-- [x] [useHiddenColumns](https://svelte-headless-table.bryanmylee.com/docs/plugins/use-hidden-columns)
-- [x] [usePagination](https://svelte-headless-table.bryanmylee.com/docs/plugins/use-pagination)
-- [ ] useGroupBy
-- [ ] useExpanded
-- [ ] useRowSelect
-- [ ] useResizeColumns
-- [ ] useEditable
-- [ ] useRowLabel
+- [x] [addSortBy](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-sort-by)
+- [x] [addColumnFilters](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-column-filters)
+- [x] [addTableFilter](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-table-filter)
+- [x] [addColumnOrder](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-column-order)
+- [x] [addHiddenColumns](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-hidden-columns)
+- [x] [addPagination](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-pagination)
+- [x] [addSubRows](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-sub-rows)
+- [x] [addExpandedRows](https://svelte-headless-table.bryanmylee.com/docs/plugins/add-expanded-rows)
+- [ ] addGroupBy
+- [ ] addRowSelect
+- [ ] addResizeColumns
+- [ ] addEditable
+- [ ] addRowLabel

src/lib/plugins/useColumnFilters.ts → src/lib/plugins/addColumnFilters.ts

@@ -90,7 +90,7 @@ const getFilteredRows = <Item, Row extends BodyRow<Item>>(
 	return _filteredRows;
 };
 
-export const useColumnFilters =
+export const addColumnFilters =
 	<Item>(): TablePlugin<
 		Item,
 		ColumnFiltersState<Item>,

src/lib/plugins/useColumnOrder.ts → src/lib/plugins/addColumnOrder.ts

@@ -10,7 +10,7 @@ export interface ColumnOrderState {
 	columnIdOrder: Writable<string[]>;
 }
 
-export const useColumnOrder =
+export const addColumnOrder =
 	<Item>({
 		initialColumnIdOrder = [],
 		hideUnspecifiedColumns = false,

src/lib/plugins/useExpandedRows.ts → src/lib/plugins/addExpandedRows.ts

@@ -35,7 +35,7 @@ const withExpandedRows = <Item, Row extends BodyRow<Item>>(
 	return [row, ...expandedSubRows];
 };
 
-export const useExpandedRows =
+export const addExpandedRows =
 	<Item>({
 		initialExpandedIds = {},
 	}: ExpandedRowsConfig<Item>): TablePlugin<

src/lib/plugins/useHiddenColumns.ts → src/lib/plugins/addHiddenColumns.ts

@@ -9,7 +9,7 @@ export interface HiddenColumnsState {
 	hiddenColumnIds: Writable<string[]>;
 }
 
-export const useHiddenColumns =
+export const addHiddenColumns =
 	<Item>({ initialHiddenColumnIds = [] }: HiddenColumnsConfig = {}): TablePlugin<
 		Item,
 		HiddenColumnsState,

src/lib/plugins/usePagination.ts → src/lib/plugins/addPagination.ts

@@ -17,7 +17,7 @@ export interface PaginationState {
 
 const MIN_PAGE_SIZE = 1;
 
-export const usePageStore = ({ items, initialPageSize, initialPageIndex }: PageStoreConfig) => {
+export const createPageStore = ({ items, initialPageSize, initialPageIndex }: PageStoreConfig) => {
 	const pageSize = writable(initialPageSize);
 	const updatePageSize = (fn: Updater<number>) => {
 		pageSize.update(($pageSize) => {
@@ -66,7 +66,7 @@ export interface PageStoreConfig {
 	initialPageIndex?: number;
 }
 
-export const usePagination =
+export const addPagination =
 	<Item>({ initialPageIndex = 0, initialPageSize = 10 }: PaginationConfig = {}): TablePlugin<
 		Item,
 		PaginationState,
@@ -76,7 +76,7 @@ export const usePagination =
 	() => {
 		const prePaginatedRows = writable<BodyRow<Item>[]>([]);
 		const paginatedRows = writable<BodyRow<Item>[]>([]);
-		const { pageSize, pageCount, pageIndex, hasPreviousPage, hasNextPage } = usePageStore({
+		const { pageSize, pageCount, pageIndex, hasPreviousPage, hasNextPage } = createPageStore({
 			items: prePaginatedRows,
 			initialPageIndex,
 			initialPageSize,

src/lib/plugins/useSortBy.ts → src/lib/plugins/addSortBy.ts

@@ -157,7 +157,7 @@ const getSortedRows = <Item, Row extends BodyRow<Item>>(
 	return _sortedRows;
 };
 
-export const useSortBy =
+export const addSortBy =
 	<Item>({
 		initialSortKeys = [],
 		disableMultiSort = false,

src/lib/plugins/useSubRows.ts → src/lib/plugins/addSubRows.ts

@@ -25,7 +25,7 @@ const withSubRows = <Item, Row extends BodyRow<Item>>(
 	return row;
 };
 
-export const useSubRows =
+export const addSubRows =
 	<Item>({
 		children,
 	}: SubRowsConfig<Item>): TablePlugin<

src/lib/plugins/useTableFilter.ts → src/lib/plugins/addTableFilter.ts

@@ -100,7 +100,7 @@ const getFilteredRows = <Item, Row extends BodyRow<Item>>(
 	return _filteredRows;
 };
 
-export const useTableFilter =
+export const addTableFilter =
 	<Item>({
 		fn = textPrefixFilter,
 		initialFilterValue = '',

src/lib/plugins/index.ts

@@ -1,15 +1,15 @@
 export {
-	useColumnFilters,
+	addColumnFilters,
 	matchFilter,
 	numberRangeFilter,
 	textPrefixFilter,
 	type ColumnFilterFn,
 	type ColumnFilterFnProps,
-} from './useColumnFilters';
-export { useColumnOrder } from './useColumnOrder';
-export { useHiddenColumns } from './useHiddenColumns';
-export { usePagination } from './usePagination';
-export { useSortBy } from './useSortBy';
-export { useTableFilter } from './useTableFilter';
-export { useExpandedRows } from './useExpandedRows';
-export { useSubRows } from './useSubRows';
+} from './addColumnFilters';
+export { addColumnOrder } from './addColumnOrder';
+export { addHiddenColumns } from './addHiddenColumns';
+export { addPagination } from './addPagination';
+export { addSortBy } from './addSortBy';
+export { addTableFilter } from './addTableFilter';
+export { addExpandedRows } from './addExpandedRows';
+export { addSubRows } from './addSubRows';

src/routes/index.svelte

@@ -2,17 +2,17 @@
 	import { derived, readable } from 'svelte/store';
 	import { Render, Subscribe, createTable, createRender } from '$lib';
 	import {
-		useColumnFilters,
-		useColumnOrder,
-		useHiddenColumns,
-		useSortBy,
-		useTableFilter,
-		usePagination,
-		useExpandedRows,
+		addColumnFilters,
+		addColumnOrder,
+		addHiddenColumns,
+		addSortBy,
+		addTableFilter,
+		addPagination,
+		addExpandedRows,
 		matchFilter,
 		numberRangeFilter,
 		textPrefixFilter,
-		useSubRows,
+		addSubRows,
 	} from '$lib/plugins';
 	import { getShuffled } from './_getShuffled';
 	import { createSamples } from './_createSamples';
@@ -27,20 +27,20 @@
 	const data = readable(createSamples(10, 5, 5));
 
 	const table = createTable(data, {
-		subRows: useSubRows({
+		subRows: addSubRows({
 			children: 'children',
 		}),
-		sort: useSortBy(),
-		filter: useColumnFilters(),
-		tableFilter: useTableFilter({
+		sort: addSortBy(),
+		filter: addColumnFilters(),
+		tableFilter: addTableFilter({
 			includeHiddenColumns: true,
 		}),
-		expand: useExpandedRows({
+		expand: addExpandedRows({
 			initialExpandedIds: { 1: true },
 		}),
-		orderColumns: useColumnOrder(),
-		hideColumns: useHiddenColumns(),
-		page: usePagination({
+		orderColumns: addColumnOrder(),
+		hideColumns: addHiddenColumns(),
+		page: addPagination({
 			initialPageSize: 20,
 		}),
 	});