Skip to content

This library allows users to implement a feedback button which will post issues on a Github repository.

Notifications You must be signed in to change notification settings

Jkense/React-Report-To-Github-Button

Repository files navigation

Github Report Button

This library allows users to implement a feedback button which will post issues on a Github repository.

version license


How To Install

This package requires react.

  1. Install through:
npm install github-report-button --save
  1. Import GithubReportButton from github-report-button:

    import GithubReportButton from 'github-report-button'
  2. Create Personal access token:

    https://github.com/settings/tokens

    Allow public_repo as a scope

    Scope

  3. Use GithubReportButton component:

    <ExampleComponent token="yourToken" owner="yourUsername" repo="yourPublicRepo"/>

    You can pass the following parameters:

Parameter Default value
token Required
owner Required
repo Required
buttonHeight (Optional) 7.5vh
buttonText (Optional) 'report an issue'

About

This library allows users to implement a feedback button which will post issues on a Github repository.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages