Skip to content

Commit 7050c8a

Browse files
authored
chore(docs): use latest refine package versions in documentation (#7102)
1 parent a08c364 commit 7050c8a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+145
-154
lines changed

documentation/docs/data/hooks/use-infinite-list/_basic-usage-live-preview.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,8 @@ import { useInfiniteList } from "@refinedev/core";
99

1010
const PostList = () => {
1111
const {
12-
data,
13-
isError,
14-
isLoading,
15-
hasNextPage,
16-
fetchNextPage,
17-
isFetchingNextPage,
12+
result: { data, hasNextPage, hasPreviousPage },
13+
query: { isError, isLoading, fetchNextPage, isFetchingNextPage },
1814
} = useInfiniteList({
1915
resource: "categories",
2016
pagination: {

documentation/docs/data/hooks/use-infinite-list/_filtering-live-preview.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,11 @@ interface IProduct {
2020

2121
const ProductList: React.FC = () => {
2222
//highlight-next-line
23-
const [value, setValue] = useState("Cotton");
23+
const [value, setValue] = useState("Plastic");
2424

2525
const {
26-
data,
27-
isLoading,
28-
isError,
29-
hasNextPage,
30-
fetchNextPage,
31-
isFetchingNextPage,
26+
result: { data, hasNextPage, hasPreviousPage },
27+
query: { isError, isLoading, fetchNextPage, isFetchingNextPage },
3228
} = useInfiniteList<IProduct, HttpError>({
3329
resource: "products",
3430
//highlight-start
@@ -57,7 +53,7 @@ const ProductList: React.FC = () => {
5753
{/* highlight-start */}
5854
<span> material: </span>
5955
<select value={value} onChange={(e) => setValue(e.target.value)}>
60-
{["Cotton", "Bronze", "Plastic"].map((material) => (
56+
{["Plastic", "Cotton", "Bronze"].map((material) => (
6157
<option key={material} value={material}>
6258
{material}
6359
</option>

documentation/docs/data/hooks/use-infinite-list/_sorting-live-preview.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,8 @@ const ProductList: React.FC = () => {
2323
const [order, setOrder] = useState<"asc" | "desc">("asc");
2424

2525
const {
26-
data,
27-
isLoading,
28-
isError,
29-
hasNextPage,
30-
fetchNextPage,
31-
isFetchingNextPage,
26+
result: { data, hasNextPage, hasPreviousPage },
27+
query: { isError, isLoading, fetchNextPage, isFetchingNextPage },
3228
} = useInfiniteList<IProduct, HttpError>({
3329
resource: "products",
3430
//highlight-start

documentation/docs/data/hooks/use-infinite-list/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,14 +137,14 @@ useInfiniteList({
137137

138138
`pagination` will be passed to the `getList` method from the `dataProvider` as a parameter. It is used to send pagination query parameters to the API.
139139

140-
#### current
140+
#### currentPage
141141

142-
You can pass the `current` page number to the `pagination` property.
142+
You can pass the `currentPage` page number to the `pagination` property.
143143

144144
```tsx
145145
useInfiniteList({
146146
pagination: {
147-
current: 2,
147+
currentPage: 2,
148148
},
149149
});
150150
```

documentation/docs/data/hooks/use-list/_pagination-live-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const ProductList: React.FC = () => {
4848
<div>
4949
{/* highlight-start */}
5050
<button onClick={() => setCurrentPage((prev) => prev - 1)}>{"<"}</button>
51-
<span> page: {current} </span>
51+
<span> page: {currentPage} </span>
5252
<button onClick={() => setCurrentPage((prev) => prev + 1)}>{">"}</button>
5353
<span> per page: </span>
5454
<select

documentation/docs/data/hooks/use-table/_partial-relational-data-live-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ setRefineProps({
105105
resources: [
106106
{
107107
name: "posts",
108-
list: PostList,
108+
list: "/posts",
109109
},
110110
],
111111
});

documentation/docs/data/hooks/use-table/_partial-sorting-live-preview.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ interface IPost {
2121
}
2222

2323
const PostList: React.FC = () => {
24-
const { result, tableQuery, sorter, setSorter } = useTable<IPost, HttpError>({
24+
const { result, tableQuery, sorters, setSorters } = useTable<
25+
IPost,
26+
HttpError
27+
>({
2528
// highlight-start
2629
sorters: {
2730
initial: [
@@ -42,9 +45,9 @@ const PostList: React.FC = () => {
4245
const currentSorterOrders = useMemo(() => {
4346
return {
4447
createdAt:
45-
sorter.find((item) => item.field === "createdAt")?.order || "desc",
46-
id: sorter.find((item) => item.field === "id")?.order || "desc",
47-
title: sorter.find((item) => item.field === "title")?.order || "asc",
48+
sorters.find((item) => item.field === "createdAt")?.order || "desc",
49+
id: sorters.find((item) => item.field === "id")?.order || "desc",
50+
title: sorters.find((item) => item.field === "title")?.order || "asc",
4851
};
4952
}, [sorter]);
5053
// highlight-end

documentation/docs/data/packages/appwrite/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ const PostList: React.FC = () => {
9797

9898
const categoryIds = result?.data?.map((item) => item.categoryId) ?? [];
9999
const {
100-
result,
100+
result: categoriesData,
101101
query: { isLoading },
102102
} = CoreUseMany<ICategory>({
103103
resource: "61c43adc284ac",
@@ -127,7 +127,9 @@ const PostList: React.FC = () => {
127127

128128
return (
129129
<RefineAntdTextField
130-
value={result?.data.find((item) => item.id === value)?.title}
130+
value={
131+
categoriesData?.data.find((item) => item.id === value)?.title
132+
}
131133
/>
132134
);
133135
}}
@@ -557,7 +559,7 @@ import { Table, Space } from "antd";
557559
import { IPost, ICategory } from "interfaces";
558560

559561
export const PostsList: React.FC = () => {
560-
const { result, sorter } = useTable<IPost>({
562+
const { result, sorters, tableProps } = useTable<IPost>({
561563
sorters: {
562564
initial: [
563565
{

documentation/docs/getting-started/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Offering the best from both worlds, Refine mitigates all risks of “from scratc
4040

4141
## Overview of the Refine structure
4242

43-
import { MUIExample } from './example/mui';
43+
<!-- import { MUIExample } from './example/mui'; -->
4444

45-
<MUIExample />
45+
<!-- <MUIExample /> -->
4646

4747
<br/>
4848

documentation/docs/guides-concepts/forms/server-side-validation-chakra-ui.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ export default function ServerSideValidationChakraUi() {
77
height={460}
88
showOpenInCodeSandbox={false}
99
dependencies={{
10-
"@refinedev/chakra-ui": "^2.26.17",
10+
"@refinedev/chakra-ui": "latest",
1111
"@tabler/icons-react": "^3.1.0",
12-
"@refinedev/core": "^4.45.1",
12+
"@refinedev/core": "latest",
1313
"@refinedev/react-router": "latest",
14-
"@refinedev/simple-rest": "^4.5.4",
15-
"@refinedev/react-table": "^5.6.4",
14+
"@refinedev/simple-rest": "latest",
15+
"@refinedev/react-table": "latest",
1616
"@tanstack/react-table": "^8.2.6",
17-
"@refinedev/react-hook-form": "^4.8.12",
17+
"@refinedev/react-hook-form": "latest",
1818
"@chakra-ui/react": "^2.5.1",
1919
"react-dom": "^18.0.0",
2020
"react-router": "^7.0.2",

0 commit comments

Comments
 (0)