useResource

useResource is used to get the resources array that you defined in <Refine>. It also returns resource object, resourceName and query params id and action.

import { useResource } from '@pankod/refine-core'

const { resources, resource, action, id } = useResource()

Properties

resourceNameOrRouteName

It is used to get resource object by name or route name.

import { useResource } from '@pankod/refine-core'

const { resource } = useResource({
  resourceNameOrRouteName: 'posts',
})

Return Values

resources

An array of resources that you defined in <Refine>.

resource

Resource object.

resourceName

Resource name of resource object.

id

Query param id.

action

Query param action.

API Reference

Properties

Return value

Description	Type
resources	IResourceItem[]
resource	IResourceItem
resourceName	string
id	BaseKey
action	undefined | "create" | "edit" | "show" | "clone"

Interfaces

type OptionsProps<TExtends = { [key: string]: any }> = TExtends & {
  label?: string
  route?: string
  hide?: boolean
  auditLog?: {
    permissions?: AuditLogPermissions[number][] | string[]
  }
}

interface IResourceComponentsProps<
  TCrudData = any,
  TOptionsPropsExtends = { [key: string]: any },
> {
  canCreate?: boolean
  canEdit?: boolean
  canDelete?: boolean
  canShow?: boolean
  name?: string
  initialData?: TCrudData
  options?: OptionsProps<TOptionsPropsExtends>
}

interface IResourceComponents {
  list?: React.FunctionComponent<IResourceComponentsProps<any, any>>
  create?: React.FunctionComponent<IResourceComponentsProps<any, any>>
  edit?: React.FunctionComponent<IResourceComponentsProps<any, any>>
  show?: React.FunctionComponent<IResourceComponentsProps<any, any>>
}

interface IResourceItem extends IResourceComponents {
  name: string
  label?: string
  route?: string
  icon?: ReactNode
  canCreate?: boolean
  canEdit?: boolean
  canShow?: boolean
  canDelete?: boolean
  options?: OptionsProps
  parentName?: string
}

The canCreate, canShow and canEdit properties are defined automatically if the create, show and edit components are defined on the resources property in <Refine>.