Skip to content

Commit 3d7392f

Browse files
committed
Add emoji for README
1 parent 0d7679c commit 3d7392f

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ React Hook for syncing [TanStack Table](https://github.com/TanStack/table) state
1313

1414
https://github.com/user-attachments/assets/1f1b4a65-fdec-4a80-a5d5-783642befaa3
1515

16-
# Quick Start
16+
# 🚀 Quick Start
1717

1818
First, install the package.
1919

@@ -61,21 +61,21 @@ Please refer to the examples below:
6161
- [Next.js(App Router)](https://github.com/taro-28/tanstack-table-search-params/tree/main/examples/next-app-router/src/app/table.tsx)
6262
- [TanStack Router](https://github.com/taro-28/tanstack-table-search-params/tree/main/examples/tanstack-router/src/routes/index.tsx)
6363

64-
# How it works
64+
# 🔍 How it works
6565

6666
The `useTableSearchParams` hook primarily does the following two things:
6767

6868
- Decode `query` (query parameter state) and return it as the `state` for Tanstack Table.
6969
- Return a function like `onChangeGlobalFilter` that encodes `state` as a query parameter and performs `push` (or `replace`).
7070

71-
# Options
71+
# ⚙️ Options
7272

73-
- [Custom query param name](#custom-query-param-name)
74-
- [Custom encoder/decoder](#custom-encoderdecoder)
75-
- [Custom default value](#custom-default-value)
76-
- [Debounce](#debounce)
73+
- [🏷️ Custom query param name](#custom-query-param-name)
74+
- [🔢 Custom encoder/decoder](#custom-encoderdecoder)
75+
- [🪄 Custom default value](#custom-default-value)
76+
- [⏱️ Debounce](#debounce)
7777

78-
## Custom query param name
78+
## 🏷️ Custom query param name \{#custom-query-param-name\}
7979

8080
You can customize a query parameter name.
8181

@@ -93,7 +93,7 @@ const stateAndOnChanges = useTableSearchParams(router, {
9393
});
9494
```
9595

96-
## Custom default value
96+
## 🔢 Custom default value
9797

9898
You can customize the default value of a query parameter.
9999

@@ -125,7 +125,7 @@ useEffect(() => {
125125
}, [router.replace]);
126126
```
127127

128-
## Custom encoder/decoder
128+
## 🪄 Custom encoder/decoder
129129

130130
You can customize the encoder/decoder for the query parameter.
131131

@@ -196,7 +196,7 @@ const stateAndOnChanges = useTableSearchParams(router, {
196196
});
197197
```
198198

199-
## Debounce
199+
## ⏱️ Debounce
200200

201201
You can debounce the reflection of state changes in the query parameters.
202202

0 commit comments

Comments
 (0)