gitbeaker-hooks

gitbeaker-hooks

Overview

React Hooks library for Gitbeaker.

Installation

You can install this library using npm:

npm install gitbeaker-hooks

Usage

Wrap your app with the GitbeakerProvider and provide options object with token property.

import { GitbeakerProvider } from "gitbeaker-hooks";

const gitbeakerOptions = {
  token: "your-access-token",
};

ReactDOM.render(
  <React.StrictMode>
    <GitbeakerProvider options={gitbeakerOptions}>
      <App />
    </GitbeakerProvider>
  </React.StrictMode>,
  document.getElementById("root"),
);

Use the provided hooks to fetch GitLab data:

• useProjects
• useRepositoryTrees
• useBranches

import { useProjects } from "gitbeaker-hooks";

function App() {
  const { projects, isLoading } = useProjects();

  if (isLoading) {
    return <div>Loading...</div>;
  }
  return (
    <>
      <ul>
        {projects?.map((project) => <li key={project.id}>{project.name}</li>)}
      </ul>
    </>
  );
}

export default App;

API

Hooks

• useProjects(options) - Fetch multiple projects.

• useRepositoryTrees(projectId, options) - Get a list of repository files and directories in a project.

• useBranches(projectId, options) - Get a list of repository branches from a project, sorted by name alphabetically.

GitbeakerProvider

The GitbeakerProvider component should be used to wrap your app and provide the options object. The options object must include the token property.

Link

• Gitbeaker
• @gitbeaker/rest
• Docs for GitLab REST API

License

This project is licensed under the MIT License - see the LICENSE file for details.