Skip to content

feat(plugin): support label property for Bug Report button #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
azu merged 3 commits into from
Jul 16, 2020
Merged

feat(plugin): support label property for Bug Report button #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
728aa14
#3 add label option
ryo-gk Jul 16, 2020
adb2434
#3 add label usage on README
ryo-gk Jul 16, 2020
173af78
#3 remove unnecessary property for explanation
ryo-gk Jul 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,26 @@ For private repositories, set this flag.
}
```

- `label`: button label (optional, default is `Bug Report`)

Set button label if you want to use other than default.

```json
{
"gitbook": ">=3.0.0",
"title": "Example",
"plugins": [
"github-issue-feedback"
],
"pluginsConfig": {
"github-issue-feedback": {
"repo": "your/private_repo",
"label": "Report Issue on GitHub"
}
}
}
```

## Changelog

See [Releases page](https://github.com/azu/gitbook-plugin-github-issue-feedback/releases).
Expand Down
2 changes: 1 addition & 1 deletion src/plugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ window.require(["gitbook"], function(gitbook) {
gitbook.events.bind("start", function(e, pluginConfig) {
var config = pluginConfig["github-issue-feedback"];
var reportElement = document.createElement("button");
reportElement.textContent = "Bug Report";
reportElement.textContent = config["label"] || "Bug Report";
reportElement.className = "gitbook-plugin-github-issue-feedback";
reportElement.setAttribute("style", "position:fixed; right:0;bottom:0;");
var clickEvent = ("ontouchstart" in window) ? "touchend" : "click";
Expand Down