React Github Link Button

A React component that displays a Github button, which redirects to the specified repository link and displays a message on hover.

Installation

npm install react-github-link-button

This package has no dependencies and is fully typed with TypeScript.

Usage

import { GithubButton } from 'react-github-link-button/dist';

function App() {
  return (
    <div className="App">
      <GithubButton link="https://github.com/" message="Go to Github" />
    </div>
  );
}

Props

| Prop | Type | Description | | ---- | ---- | ----------- | | link | string | The link to the Github repository. | | message | string | The message to display on hover. |

Example

A running example can be found in the "example" folder in this repository.

Limitations

The hover box has predefined dimensions, so it is recommended to use short messages.

License

This project is licensed under the ISC License.

Issues and Contributions

If you find any issues or have questions about this library, feel free to create a pull request in the Github repository.