diff --git a/ui/app/templates/components/freestyle/sg-search-box.hbs b/ui/app/templates/components/freestyle/sg-search-box.hbs new file mode 100644 index 000000000..4a0323b81 --- /dev/null +++ b/ui/app/templates/components/freestyle/sg-search-box.hbs @@ -0,0 +1,19 @@ +{{#freestyle-usage "search-box" title="Search Box"}} + {{search-box + searchTerm=(mut searchTerm1) + placeholder="Search things..."}} +{{/freestyle-usage}} +{{#freestyle-annotation}} +
The search box component is a thin wrapper around a simple input. Although the searchTerm passed to it is a mutable reference, internally search term is debounced. This is to prevent potentially expensive code that depends on searchTerm from recomputing many times as a user types.
+There is no form of the search box component that defers updating the searchTerm reference until the user manually clicks a "Search" button. This can be achieved by placing a button next to the search bar component and using it to perform search, but search should be automatic whenever possible.
+{{/freestyle-annotation}} + +{{#freestyle-usage "search-box-compact" title="Search Box Compact"}} + {{search-box + searchTerm=(mut searchTerm2) + placeholder="Search things..." + inputClass="is-compact"}} +{{/freestyle-usage}} +{{#freestyle-annotation}} +Search box provides an inputClass property to control the inner input. This is nice for fitting the search box into smaller spaces, such as boxed-section heads.
+{{/freestyle-annotation}} diff --git a/ui/app/templates/freestyle.hbs b/ui/app/templates/freestyle.hbs index 124a9c0c5..3ca493348 100644 --- a/ui/app/templates/freestyle.hbs +++ b/ui/app/templates/freestyle.hbs @@ -69,6 +69,7 @@ {{/section.subsection}} {{#section.subsection name="Search box"}} + {{freestyle/sg-search-box}} {{/section.subsection}} {{#section.subsection name="Table"}} {{/section.subsection}}