- added ability to hide searchbar

- added section that explains what token permissions are needed

Author: frostplexx

README.md

@@ -9,6 +9,26 @@ Obsidian GitHub Issues is a plugin for the Obsidian note-taking app that enables
 - **Rich Preview:** View a comprehensive preview of the embedded issues, including their status, comments, assignees, labels, and other relevant details. This feature helps you quickly gain context and stay informed about the progress of your issues.
 
 ## Installation
+
+### Prerequisites
+Before installing the Obsidian GitHub Issues plugin, you need to generate a Personal Access Token (PAT) for your GitHub account. This token is used to authenticate your Obsidian app with GitHub and enable the plugin to access your GitHub repositories. To generate a PAT, follow these steps:
+
+- Navigate to your GitHub account settings.
+- Click on the "Developer Settings" tab.
+- Select "Personal Access Tokens" from the sidebar.
+- Click on the "Generate New Token (classic)" button.
+- Give it a name and an expiration date.
+- The token needs the following permissions:
+  - If you want to use the plugin with public and private repositories, you need to select the following permissions: 
+    - repo (Full control of private repositories)
+  - If you only want to use the plugin with public repositories, you need to select the following permissions:
+    - public_repo (Access public repositories)
+- Click on the "Generate Token" button.
+- Copy the generated token and save it somewhere safe.
+- **Note:** This token is only displayed once. If you lose it, you will have to generate a new one.
+
+### Install from Obsidian
+
 To install the Obsidian GitHub Issues plugin, follow these steps:
 
 - Open Obsidian and navigate to the "Community Plugins" section in the settings.
@@ -17,4 +37,11 @@ To install the Obsidian GitHub Issues plugin, follow these steps:
 - Click the "Install" button next to the plugin name.
 - Once the installation is complete, open the plugin settings and enter your GitHub Username and Personal Access Token
 
+### Install from GitHub
+
+To install the Obsidian GitHub Issues plugin from GitHub, follow these steps:
 
+- Download the latest release of the plugin from the GitHub repository
+- Extract the contents of the zip file into your Obsidian vault's plugins folder.
+- Open the plugin settings and enter your GitHub Username and Personal Access Token
+- Reload Obsidian to activate the plugin.

main.ts

@@ -19,12 +19,14 @@ interface MyPluginSettings {
 	username: string;
 	password: string
 	issue_appearance: IssueAppearance;
+	show_searchbar: boolean;
 }
 
 const DEFAULT_SETTINGS: MyPluginSettings = {
 	username: '',
 	password: '',
-	issue_appearance: IssueAppearance.DEFAULT
+	issue_appearance: IssueAppearance.DEFAULT,
+	show_searchbar: true
 }
 
 export default class MyPlugin extends Plugin {
@@ -95,32 +97,33 @@ export default class MyPlugin extends Plugin {
 			refreshButton.style.left = "3px"
 			refreshButton.style.top = "3px"
 
-			const searchfield = el.createEl("input")
-			searchfield.setAttribute("type", "text")
-			searchfield.setAttribute("placeholder", "Search Titles, Labels,...")
-			searchfield.style.backgroundColor = "inherit";
-			searchfield.style.width = "80%"
-			searchfield.style.marginTop = "10px"
-			searchfield.style.height = "30px"
-			searchfield.style.boxShadow = 'none'
-			searchfield.style.padding = '10px'
-			searchfield.style.alignItems = 'center'
-			searchfield.style.justifyContent = 'center'
-			searchfield.style.cursor = "pointer"
-
-			searchfield.addEventListener("input", () => {
-				//go through the children of "el" and hide all that don't match the search if the search is empty show all
-				const search = searchfield.value.toLowerCase()
-				el.childNodes.forEach((child) => {
-					if(child instanceof HTMLElement){
-						if(child.innerText.toLowerCase().includes(search)){
-							child.style.display = "flex"
-						} else if (child !== refreshButton && child !== searchfield){
-							child.style.display = "none"
+			if(this.settings.show_searchbar) {
+				const searchfield = el.createEl("input")
+				searchfield.setAttribute("type", "text")
+				searchfield.setAttribute("placeholder", "Search Titles, Labels,...")
+				searchfield.style.backgroundColor = "inherit";
+				searchfield.style.width = "80%"
+				searchfield.style.marginTop = "10px"
+				searchfield.style.height = "30px"
+				searchfield.style.boxShadow = 'none'
+				searchfield.style.padding = '10px'
+				searchfield.style.alignItems = 'center'
+				searchfield.style.justifyContent = 'center'
+
+				searchfield.addEventListener("input", () => {
+					//go through the children of "el" and hide all that don't match the search if the search is empty show all
+					const search = searchfield.value.toLowerCase()
+					el.childNodes.forEach((child) => {
+						if (child instanceof HTMLElement) {
+							if (child.innerText.toLowerCase().includes(search)) {
+								child.style.display = "flex"
+							} else if (child !== refreshButton && child !== searchfield) {
+								child.style.display = "none"
+							}
 						}
-					}
-				})
-			});
+					})
+				});	searchfield.style.cursor = "pointer"
+			}
 
 			refreshButton.addEventListener("mouseenter", () => {
 				refreshButton.style.background = "var(--background-modifier-hover)"
@@ -333,13 +336,25 @@ class GithubIssuesSettings extends PluginSettingTab {
 			.addDropdown(dropdown => dropdown
 				.addOption(IssueAppearance.DEFAULT, "Default")
 				.addOption(IssueAppearance.COMPACT, "Compact")
-				.setValue("default")
+				.setValue(this.plugin.settings.issue_appearance)
 				.onChange(async (value: IssueAppearance) => {
 					console.log("Appearance: " + value)
 					this.plugin.settings.issue_appearance = value;
 					await this.plugin.saveSettings()
 					//TODO trigger a rerender of the issues
 				}));
+		new Setting(containerEl)
+			.setName("Show Searchbar")
+			.setDesc("Show a searchbar above the issues in the embed.")
+			.addToggle(toggle => toggle
+				.setValue(this.plugin.settings.show_searchbar)
+				.onChange(async (value) => {
+					console.log("Show Searchbar: " + value)
+					this.plugin.settings.show_searchbar = value;
+					await this.plugin.saveSettings()
+					//TODO trigger a rerender of the issues
+
+				}));
 	}
 }