document params for shared templates

Author: denyskon

templates/shared/search/button.tmpl

@@ -1 +1,3 @@
+<!-- Disable (optional) - if search button has to be disabled -->
+<!-- Tooltip (optional) - a tooltip to be displayed on hover -->
 <button class="ui small primary icon button" aria-label="{{ctx.Locale.Tr "search.search"}}" {{with .Tooltip}}data-tooltip-content="{{.}}"{{end}}{{if .Disabled}} disabled{{end}}>{{svg "octicon-search"}}</button>

templates/shared/search/combo.tmpl

@@ -1,3 +1,7 @@
+<!-- Value - value of the search field (for search results page) -->
+<!-- Disabled (optional) - if search field/button has to be disabled -->
+<!-- Placeholder (optional) - placeholder text to be used -->
+<!-- Tooltip (optional) - a tooltip to be displayed on button hover -->
 <div class="ui fluid action input">
 	{{template "shared/search/input" dict "Value" .Value "Disabled" .Disabled "Placeholder" .Placeholder}}
 	{{template "shared/search/button" dict "Disabled" .Disabled "Tooltip" .Tooltip}}

templates/shared/search/combo_fuzzy.tmpl

@@ -1,3 +1,8 @@
+<!-- Value - value of the search field (for search results page) -->
+<!-- Disabled (optional) - if search field/button has to be disabled -->
+<!-- Placeholder (optional) - placeholder text to be used -->
+<!-- IsFuzzy - state of the fuzzy search toggle -->
+<!-- Tooltip (optional) - a tooltip to be displayed on button hover -->
 <div class="ui fluid action input">
 	{{template "shared/search/input" dict "Value" .Value "Disabled" .Disabled "Placeholder" .Placeholder}}
 	{{template "shared/search/fuzzy" dict "Disabled" .Disabled "IsFuzzy" .IsFuzzy}}

templates/shared/search/fuzzy.tmpl

@@ -1,3 +1,5 @@
+<!-- Disabled (optional) - if dropdown has to be disabled -->
+<!-- IsFuzzy - state of the fuzzy search toggle -->
 <div class="ui small dropdown selection {{if .Disabled}} disabled{{end}}" data-tooltip-content="{{ctx.Locale.Tr "search.type_tooltip"}}">
 	<input name="fuzzy" type="hidden"{{if .Disabled}} disabled{{end}} value="{{.IsFuzzy}}">{{svg "octicon-triangle-down" 14 "dropdown icon"}}
 	<div class="text">{{if .IsFuzzy}}{{ctx.Locale.Tr "search.fuzzy"}}{{else}}{{ctx.Locale.Tr "search.match"}}{{end}}</div>

templates/shared/search/input.tmpl

@@ -1 +1,4 @@
-<input type="search" spellcheck="false" name="q" maxlength="255" placeholder="{{if .Placeholder}}{{.Placeholder}}{{else}}{{ctx.Locale.Tr "search.search"}}…{{end}}"{{if .Value}} value="{{.Value}}"{{end}}{{if .Disabled}} disabled{{end}} {{if .Autofocus}}autofocus{{end}}>
+<!-- Value - value of the search field (for search results page) -->
+<!-- Disabled (optional) - if search field has to be disabled -->
+<!-- Placeholder (optional) - placeholder text to be used -->
+<input type="search" spellcheck="false" name="q" maxlength="255" placeholder="{{if .Placeholder}}{{.Placeholder}}{{else}}{{ctx.Locale.Tr "search.search"}}…{{end}}"{{if .Value}} value="{{.Value}}"{{end}}{{if .Disabled}} disabled{{end}} autofocus>