Skip to content
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
2 changes: 1 addition & 1 deletion documentation/docs/guides-concepts/forms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ useForm({
});
```

To learn more about the routing, check out the [Routing](/Users/ozgurakca/refine/documentation/docs/guides-concepts/routing/) guide and the [General Concepts](/Users/ozgurakca/refine/documentation/docs/guides-concepts/general-concepts/) guide to learn more about how it benefits the development experience.
To learn more about the routing, check out the [Routing](/core/docs/guides-concepts/routing/) guide and the [General Concepts](/core/docs/guides-concepts/general-concepts/) guide to learn more about how it benefits the development experience.

### Redirection

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ We will use `handleSubmit` function to manage to submit event when clicking the
:::info
`onFinish` function resolves to respect the `mutationMode` property. In `pessimistic` mode, it will resolve after the response is returned from the request, in `optimistic` and `undoable` modes it will resolve immediately. Only real await will happen in pessimistic mode and this will resolve with the response data, others will resolve immediately with undefined data.

[Refer to the `mutationMode` documentation for more details. &#8594](/advanced-tutorials/mutation-mode)
[Refer to the `mutationMode` documentation for more details. &#8594](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode)
:::

```tsx title="src/pages/create.tsx"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Mutation mode can be set application-wide in [`<Refine>`](/core/docs/3.xx.xx/api

<br />

It can also be set in supported [data hooks](core/docs/3.xx.xx/api-reference/core/hooks/data/useUpdate/) and [form hooks](/core/docs/3.xx.xx/api-reference/core/hooks/useForm#properties) for fine-grained configuration.
It can also be set in supported [data hooks](/core/docs/3.xx.xx/api-reference/core/hooks/data/useUpdate/) and [form hooks](/core/docs/3.xx.xx/api-reference/core/hooks/useForm#properties) for fine-grained configuration.

```tsx
import { useUpdate } from "@pankod/refine-core";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export default App;

Now let's get our [`<AutoComplete>`](https://ant.design/components/auto-complete) input ready to search. So, let's fetch our posts according to the value entered in our input.

To fetch more than one record, we will use the [`useList`](/core/docs/3.xx.xx/api-reference/core/data/hooks/useList) data hook, and we will filter and fetch this data according to the search value.
To fetch more than one record, we will use the [`useList`](/core/docs/3.xx.xx/api-reference/core/hooks/data/useList) data hook, and we will filter and fetch this data according to the search value.

Before we start, let's create the interfaces of our [`<AutoComplete>`](https://ant.design/components/auto-complete)'s `options` property and the post source.

Expand Down Expand Up @@ -207,7 +207,7 @@ export const Header: React.FC = () => {
};
```

We created states to dynamically manage the `value` and `options` properties of the [`<AutoComplete>`](https://ant.design/components/auto-complete) component. The [`useList`](/core/docs/3.xx.xx/api-reference/core/data/hooks/useList) hook is triggered whenever the value changes. Likewise, the filter used to fetch the data is updated each time the value changes.
We created states to dynamically manage the `value` and `options` properties of the [`<AutoComplete>`](https://ant.design/components/auto-complete) component. The [`useList`](/core/docs/3.xx.xx/api-reference/core/hooks/data/useList) hook is triggered whenever the value changes. Likewise, the filter used to fetch the data is updated each time the value changes.

<br />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ render(

The `<Create>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Create>` component in a custom page, you can use the `resource` prop.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live disableScroll previewHeight=280px url=http://localhost:3000/custom
// handle initial routes in new way
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ render(

`<Edit>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Edit>` component in a custom page, you can use the `resource` property.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live disableScroll previewHeight=280px url=http://localhost:3000/custom/2
setInitialRoutes(["/custom/2"]);
Expand Down Expand Up @@ -401,7 +401,7 @@ The `<Edit>` component needs the `id` information for the `<RefreshButton>` to w

Determines which mode mutation will have while executing `<DeleteButton>` .

[Refer to the mutation mode docs for further information. &#8594](/advanced-tutorials/mutation-mode)
[Refer to the mutation mode docs for further information. &#8594](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode)

```tsx live hideCode url=http://localhost:3000/posts/edit/2
const { EditButton } = RefineAntd;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ render(

The `<Show>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Show>` component in a custom page, you can use the `resource` property.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live disableScroll previewHeight=280px url=http://localhost:3000/custom/2
setInitialRoutes(["/custom/2"]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ render(<App />);

Determines which mode mutation will have while executing `<DeleteButton>`.

[Refer to the mutation mode docs for further information. &#8594](/advanced-tutorials/mutation-mode)
[Refer to the mutation mode docs for further information. &#8594](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode)

```tsx
import { List, Table, DeleteButton, useTable } from "@pankod/refine-antd";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ interface ITag {
<br/>

All we have to do is pass the `checkboxGroupProps` it returns to the `<Checkbox.Group>` component.
`useCheckboxGroup` uses the `useList` hook for fetching data. [Refer to `useList` hook for details. &#8594](/core/docs/3.xx.xx/api-reference/core/data/hooks/useList)
`useCheckboxGroup` uses the `useList` hook for fetching data. [Refer to `useList` hook for details. &#8594](/core/docs/3.xx.xx/api-reference/core/hooks/data/useList)

<img src="https://refine.ams3.cdn.digitaloceanspaces.com/website/static/img/hooks/useCheckboxGroup/basic.png" alt="Tags" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ When the `useTable` hook is mounted, it will call the `subscribe` method from th
<PropResource
hook={{
name:"useList",
URL:"/docs/api-reference/core/data/hooks/useList/"
URL:"/docs/api-reference/core/hooks/data/useList/"
}}
method={{
name:"getList",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ render(

The `<Create>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Create>` component in a custom page, you can use the `resource` prop.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live url=http://localhost:3000/custom previewHeight=280px
setInitialRoutes(["/custom"]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ render(

`<Edit>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Edit>` component in a custom page, you can use the `resource` property.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live url=http://localhost:3000/custom/23 previewHeight=280px
setInitialRoutes(["/custom/23"]);
Expand Down Expand Up @@ -482,7 +482,7 @@ The `<Edit>` component needs the `id` information for the `<RefreshButton>` to w

Determines which mode mutation will have while executing `<DeleteButton>`.

[Refer to the mutation mode docs for further information. &#8594](/advanced-tutorials/mutation-mode)
[Refer to the mutation mode docs for further information. &#8594](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode)

```tsx live url=http://localhost:3000/posts/edit/123 previewHeight=280px
setInitialRoutes(["/posts/edit/123"]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ render(

`<List>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<List>` component in a custom page, you can use the `resource` prop.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live url=http://localhost:3000/custom previewHeight=280px
setInitialRoutes(["/custom"]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ render(

The `<Show>` component reads the `resource` information from the route by default. This default behavior will not work on custom pages. If you want to use the `<Show>` component in a custom page, you can use the `resource` property.

[Refer to the custom pages documentation for detailed usage. &#8594](/advanced-tutorials/custom-pages)
[Refer to the custom pages documentation for detailed usage. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-pages)

```tsx live url=http://localhost:3000/custom/123 previewHeight=280px
setInitialRoutes(["/custom/123"]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ const App: React.FC = () => {

`undoable`: The mutation is applied locally, and redirection and UI updates are executed immediately as if the mutation is successful. Waits for a customizable amount of timeout before mutation is applied. During the timeout, mutation can be canceled from the notification with the ?undo? button. UI will revert accordingly.

[Refer to the Mutation Mode docs for further information. &#8594](/advanced-tutorials/mutation-mode)
[Refer to the Mutation Mode docs for further information. &#8594](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode)

### `undoableTimeout`

Expand Down Expand Up @@ -783,7 +783,7 @@ const App: React.FC = () => (
);
```

[Refer to the Custom Layout documentation for detailed information. &#8594](core/docs/3.xx.xx/advanced-tutorials/custom-layout/)
[Refer to the Custom Layout documentation for detailed information. &#8594](/core/docs/3.xx.xx/advanced-tutorials/custom-layout/)

> `children` will be what is passed as a component for the route in a resource(list, edit..) or a custom route.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Data that is resolved from the `useAuthenticated` will be returned as the `data`

## Usage

`useAuthenticated` can be useful when you want to ask for authentication to grant access to [custom pages](/advanced-tutorials/custom-pages) manually.
`useAuthenticated` can be useful when you want to ask for authentication to grant access to [custom pages](/core/docs/3.xx.xx/advanced-tutorials/custom-pages) manually.

We have used this hook in refine's [`<Authenticated>`](/core/docs/3.xx.xx/api-reference/core/components/auth/authenticated) component which allows only authenticated users to access the page or any part of the code.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Returns an object with TanStack Query's `useMutation` return values.
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| <div className="required-block"><div>resource</div> <div className=" required">Required</div></div> | Resource name for API data interactions | `string` | |
| id <div className=" required">Required</div> | id for mutation function | [`BaseKey`](/core/docs/3.xx.xx/api-reference/core/interfaces#basekey) | |
| mutationMode | [Determines when mutations are executed](/advanced-tutorials/mutation-mode) | ` "pessimistic` \| `"optimistic` \| `"undoable"` | `"pessimistic"`\* |
| mutationMode | [Determines when mutations are executed](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode) | ` "pessimistic` \| `"optimistic` \| `"undoable"` | `"pessimistic"`\* |
| undoableTimeout | Duration to wait before executing the mutation when `mutationMode = "undoable"` | `number` | `5000ms`\* |
| onCancel | Callback that runs when undo button is clicked on `mutationMode = "undoable"` | `(cancelMutation: () => void) => void` | |
| successNotification | Successful Mutation notification | [`SuccessErrorNotification`](/core/docs/3.xx.xx/api-reference/core/interfaces#successerrornotification) | "Successfully deleted a `resource`" |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ Returns an object with TanStack Query's `useMutation` return values.
| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| <div className="required-block"><div>resource</div> <div className=" required">Required</div></div> | Resource name for API data interactions | `string` | |
| ids <div className=" required">Required</div> | ids for mutation function | [`BaseKey[]`](/core/docs/3.xx.xx/api-reference/core/interfaces#basekey) | |
| mutationMode | [Determines when mutations are executed](/advanced-tutorials/mutation-mode) | ` "pessimistic` \| `"optimistic` \| `"undoable"` | `"pessimistic"`\* |
| mutationMode | [Determines when mutations are executed](/core/docs/3.xx.xx/advanced-tutorials/mutation-mode) | ` "pessimistic` \| `"optimistic` \| `"undoable"` | `"pessimistic"`\* |
| undoableTimeout | Duration to wait before executing the mutation when `mutationMode = "undoable"` | `number` | `5000ms`\* |
| onCancel | Callback that runs when undo button is clicked on `mutationMode = "undoable"` | `(cancelMutation: () => void) => void` | |
| successNotification | Successful Mutation notification | [`SuccessErrorNotification`](/core/docs/3.xx.xx/api-reference/core/interfaces#successerrornotification) | "Successfully deleted `resource`" |
Expand Down
Loading