refactor: rename useResource to useResourceParams (#6953)

Author: alicanerdurmaz

documentation/docs/core/refine-component/index.md

@@ -96,7 +96,7 @@ const App = () => (
 
 :::simple Accessing the Resource
 
-You can use [useResource](/docs/routing/hooks/use-resource) hook to get the current active resource by the route or you can pass the `name` or the `identifier` of a resource to the `useResource` hook to get the resource object.
+You can use [useResourceParams](/docs/routing/hooks/use-resource-params) hook to get the current active resource by the route or you can pass the `name` or the `identifier` of a resource to the `useResourceParams` hook to get the resource object.
 
 :::
 
@@ -212,7 +212,7 @@ There's also a third option, which is to pass an object with the `component` and
 
 ### meta
 
-`meta` can have any kind of property. It is used to store additional information about the resource. This property you pass can be received from the [useResource](/docs/routing/hooks/use-resource). Listed below are the properties that are used by Refine or its libraries.
+`meta` can have any kind of property. It is used to store additional information about the resource. This property you pass can be received from the [useResourceParams](/docs/routing/hooks/use-resource-params). Listed below are the properties that are used by Refine or its libraries.
 
 #### label
 

documentation/docs/migration-guide/4x-to-5x.md

@@ -416,7 +416,7 @@ Resource `options` have been renamed to `meta`:
 
 #### resourceName/resourceNameOrRouteName → resource
 
-🚨 Affects: useImport, useExport, useResource, All Button components
+🚨 Affects: useImport, useExport, All Button components
 
 ```diff
 useImport({
@@ -588,26 +588,19 @@ const MyComponent = () => {
 };
 ```
 
-#### useResource → useResourceParams (Recommended)
+#### useResource → useResourceParams
 
-```diff
-// useResource parameter simplification
-- useResource({ resourceNameOrRouteName: "posts" });
-+ useResource("posts");
-```
+The `useResource` hook has been removed in favor of `useResourceParams`. The new `useResourceParams` hook offers the same functionality as `useResource`, while introducing additional features and a more streamlined API. To reduce confusion and improve consistency, all resource-related logic should now use `useResourceParams` exclusively.
 
-:::tip Recommendation
-While `useResource` continues to work for backward compatibility, we now recommend using [`useResourceParams`](https://refine.dev/docs/routing/hooks/use-resource-params/) for new projects. It provides a more stable, granular, and precise solution for resource management.
+```diff
+- import { useResource } from "@refinedev/core";
++ import { useResourceParams } from "@refinedev/core";
 
-```typescript
-// Recommended approach
-import { useResourceParams } from "@refinedev/core";
 
-const { resource, action, id } = useResourceParams();
+- useResource("posts");
++ useResourceParams({ resource: "posts" });
 ```
 
-:::
-
 #### ignoreAccessControlProvider → accessControl
 
 ```diff

documentation/docs/routing/hooks/use-resource-params/index.md

@@ -3,7 +3,9 @@ title: useResourceParams
 source: packages/core/src/hooks/use-resource-params
 ---
 
-`useResourceParams` is used to get the related parameters of the current resource such as `resource`, `id` and `action`. It also provides `formAction` to determine the action of the form and `setId` to set the `id` programmatically without having to use a separate state for it.
+`useResourceParams` is used to access the related parameters of the current resource, such as `resource`, `id`, and `action`. It also provides `formAction` to determine the form action, and `setId` to set the `id` programmatically without needing a separate state. In addition, it returns the `resources` array defined in `<Refine />`.
+
+If you pass a resource name or identifier to `useResourceParams`, it will return the matching `resource` object. If no match is found, a temporary `resource` will be created using the provided name or identifier.
 
 ## Usage
 
@@ -68,6 +70,18 @@ Current action to be performed. This can be explicitly passed via the `action` p
 
 Apart from the `action` value, `formAction` can only be `create`, `edit` or `clone`. If the `action` is not one of these, `formAction` will be set to `create` for convenience.
 
+### resources
+
+An array of resources that you defined in `<Refine>`.
+
+### select
+
+The function allows you to retrieve a `resource` object and matched `identifier` by providing either a resource `name` or `identifier`. By default, if there is no match for the given `name` or `identifier`, the function will return the `resource` object and `identifier` associated with the provided value.
+
+If you don't pass any parameter to `useResource`, it will try to infer the `resource` from the current route. If there is no match, the `resource` and `identifier` will be `undefined`.
+
+The function also accepts a second parameter `force` which is `true` by default. If you set it to `false`, it will not return a `resource` object and `identifier` if there is no match.
+
 ## API Reference
 
 ### Properties
@@ -76,11 +90,13 @@ Apart from the `action` value, `formAction` can only be `create`, `edit` or `clo
 
 ### Return value
 
-| Description | Type                                                                       |
-| ----------- | -------------------------------------------------------------------------- |
-| resource    | `IResourceItem` \| `undefined`                                             |
-| identifier  | `string` \| `undefined`                                                    |
-| id          | [`BaseKey` \| `undefined`](/docs/core/interface-references#basekey)        |
-| setId       | `(id: BaseKey) => void`                                                    |
-| action      | `undefined` \| `"list"` \| `"create"` \| `"edit"` \| `"show"` \| `"clone"` |
-| formAction  | `"create"` \| `"edit"` \| `"clone"`                                        |
+| Description | Type                                                                                                                      |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------- |
+| resource    | `IResourceItem` \| `undefined`                                                                                            |
+| identifier  | `string` \| `undefined`                                                                                                   |
+| id          | [`BaseKey` \| `undefined`](/docs/core/interface-references#basekey)                                                       |
+| setId       | `(id: BaseKey) => void`                                                                                                   |
+| action      | `undefined` \| `"list"` \| `"create"` \| `"edit"` \| `"show"` \| `"clone"`                                                |
+| formAction  | `"create"` \| `"edit"` \| `"clone"`                                                                                       |
+| select      | `(resourceName: string, force?: boolean) => { resource: IResourceItem` \| `undefined, identifier: string` \| `undefined}` |
+| resources   | [`IResourceItem[]`](#interfaces)                                                                                          |

documentation/docs/routing/hooks/use-resource/index.md

@@ -154,11 +154,15 @@
     },
     {
       "from": "/docs/core/hooks/resource/useResource/",
-      "to": "/docs/routing/hooks/use-resource"
+      "to": "/docs/routing/hooks/use-resource-params"
     },
     {
       "from": "/docs/core/hooks/resource/useResourceWithRoute/",
-      "to": "/docs/routing/hooks/use-resource"
+      "to": "/docs/routing/hooks/use-resource-params"
+    },
+    {
+      "from": "/docs/routing/hooks/use-resource",
+      "to": "/docs/routing/hooks/use-resource-params"
     },
     {
       "from": "/docs/core/hooks/show/useShow/",
@@ -674,7 +678,7 @@
     },
     {
       "from": "/docs/api-reference/core/hooks/resource/useResourceWithRoute/",
-      "to": "/docs/routing/hooks/use-resource"
+      "to": "/docs/routing/hooks/use-resource-params"
     },
     {
       "from": "/docs/api-reference/core/hooks/refine/useTitle/",
@@ -1067,7 +1071,7 @@
     },
     {
       "from": "/docs/api-reference/core/hooks/resource/useResource",
-      "to": "/docs/routing/hooks/use-resource"
+      "to": "/docs/routing/hooks/use-resource-params"
     },
     {
       "from": "/docs/api-reference/core/hooks/show/useShow",
@@ -1915,7 +1919,7 @@
     },
     {
       "from": "/docs/core/hooks/navigation/use-resource",
-      "to": "/docs/routing/hooks/use-resource"
+      "to": "/docs/routing/hooks/use-resource-params"
     },
     {
       "from": "/docs/core/hooks/navigation/use-go",

documentation/redirects.json

@@ -244,7 +244,6 @@ module.exports = {
           label: "Hooks",
           items: [
             "routing/hooks/use-resource-params/index",
-            "routing/hooks/use-resource/index",
             "routing/hooks/use-go/index",
             "routing/hooks/use-back/index",
             "routing/hooks/use-parsed/index",

documentation/sidebars.js

@@ -605,9 +605,9 @@ const ShowcaseECommerce = ({ className }: { className?: string }) => {
             "https://refine.ams3.cdn.digitaloceanspaces.com/website/static/showcase-images/finefoods/actions-2.png",
           codePosition: "left",
           code: `
-                    import { useResource, useUpdate } from "@refinedev/core";
+                    import { useResourceParams, useUpdate } from "@refinedev/core";
 
-                    const { id }  = useResource();
+                    const { id }  = useResourceParams();
                     const { mutate } = useUpdate();
 
                     const onReject = () => mutate({
@@ -706,9 +706,9 @@ const ShowcaseDevOps = ({ className }: { className?: string }) => {
             "https://refine.ams3.cdn.digitaloceanspaces.com/website/static/showcase-images/devops/actions.png",
           codePosition: "left",
           code: `
-                        import { useDelete, useResource } from "@refinedev/core";
+                        import { useDelete, useResourceParams } from "@refinedev/core";
 
-                        const { id } = useResource();
+                        const { id } = useResourceParams();
                         const { mutate } = useDelete();
 
                         const onDelete = () => {

documentation/src/refine-theme/landing-hero-showcase-section.tsx

@@ -3,7 +3,7 @@ import {
   type IResourceComponentsProps,
   useNavigation,
   useOne,
-  useResource,
+  useResourceParams,
   useShow,
 } from "@refinedev/core";
 
@@ -12,7 +12,7 @@ import { ChevronLeft, EditIcon, ListIcon } from "lucide-react";
 
 export const BlogPostShow: React.FC<IResourceComponentsProps> = () => {
   const { edit, list } = useNavigation();
-  const { id } = useResource();
+  const { id } = useResourceParams();
   const { query: queryResult } = useShow({
     meta: {
       populate: ["category"],

examples/blog-refine-shadcn/src/pages/blog-posts/show.tsx

@@ -2,15 +2,15 @@ import { Button } from "@/components/ui/button";
 import {
   type IResourceComponentsProps,
   useNavigation,
-  useResource,
+  useResourceParams,
   useShow,
 } from "@refinedev/core";
 import { ChevronLeft, EditIcon, ListIcon } from "lucide-react";
 import React from "react";
 
 export const CategoryShow: React.FC<IResourceComponentsProps> = () => {
   const { edit, list } = useNavigation();
-  const { id } = useResource();
+  const { id } = useResourceParams();
   const { query: queryResult } = useShow({});
   const { data } = queryResult;
 

examples/blog-refine-shadcn/src/pages/categories/show.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import { useResource } from "@refinedev/core";
+import { useResourceParams } from "@refinedev/core";
 import { ListButton } from "@refinedev/mui";
 import { Box, Divider, Typography } from "@mui/material";
 import { ChevronLeftRectangleIcon } from "@/icons";
@@ -17,7 +17,7 @@ export const PageHeader = ({
   showListButton,
   showDivider,
 }: Props) => {
-  const { resource } = useResource();
+  const { resource } = useResourceParams();
 
   const prefferedTitle = title || resource?.meta?.label || "";