Skip to main content

usePeople

Overview​

usePeople is a hook used to fetch query of people in a project. This hook facilitates fetching project members, with added functionality for filtering by role and search, as well as retrieving your own role within the project.

Usage​

const Component = () => {
    const {
        people,
        selfRole,
        role,
        setRole,
        setSearch,
        isPending
    } = usePeople()
}

Parameters​

No parameters are needed.

Returns​

  • people: An array consisting of each member details
  • selfRole: Your own role in the selected project
  • role: A variable for role filter
  • selfRole: Handler to change role variable
  • setSearch: Handler for search text if needed
  • isPending: Pending state of fetching people api ( Boolean )