refactor: use glimmer component for search-input #205
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,67 @@ | ||
| <div class="search-input" ...attributes> | ||
| {{#if this.searchService.index}} | ||
| <input | ||
| id="search-input" | ||
| type="search" | ||
| value={{this.value}} | ||
| oninput={{perform this.search value="target.value"}} | ||
| placeholder="Search the guides" | ||
| autocomplete="off" | ||
| data-test-search-input | ||
| {{on "focus" this.onfocus}} | ||
| {{on "blur" (perform this.closeMenu)}} | ||
| /> | ||
|
|
||
| {{! Search results dropdown }} | ||
| <EmberTether | ||
| @target="#search-input" | ||
| @targetAttachment="bottom right" | ||
| @attachment="top right" | ||
| @constraints={{this._resultTetherConstraints}} | ||
| @class="ds-dropdown-results" | ||
| > | ||
| {{#if this.showDropdown}} | ||
| <div class="ds-suggestions ds-dropdown-menu" data-test-search-dropdown> | ||
| <DropdownHeader> | ||
| Search Results | ||
| </DropdownHeader> | ||
| {{#each this.searchService.results as |result|}} | ||
| <SearchResult @result={{result}} /> | ||
| {{else}} | ||
| <div class="algolia-docsearch-suggestion"> | ||
| <div | ||
| class="algolia-docsearch-suggestion--noresults" | ||
| data-test-search-noresults | ||
| > | ||
| <p> | ||
| No results found. | ||
| {{#if this.deprecationsGuideURL}} | ||
| Try searching the | ||
| <a | ||
| href={{this.deprecationsGuideURL}} | ||
| target="_deprecations" | ||
| > | ||
|
There was a problem hiding this comment. @mansona is There was a problem hiding this comment. no this isn't something I'm aware of 😂 We can probably remove it 🤷 |
||
| deprecations guide | ||
| </a>. | ||
| {{/if}} | ||
| </p> | ||
| </div> | ||
| </div> | ||
| {{/each}} | ||
| <div class="powered-by-algolia"> | ||
| <a | ||
| href="https://www.algolia.com/" | ||
| target="_blank" | ||
| rel="noopener noreferrer" | ||
| > | ||
| <img | ||
| src="/images/logos/search-by-algolia.svg" | ||
| alt="Search Powered by Algolia" | ||
| /> | ||
| </a> | ||
| </div> | ||
| </div> | ||
| {{/if}} | ||
| </EmberTether> | ||
| {{/if}} | ||
| </div> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,59 @@ | ||
| import Component from '@glimmer/component'; | ||
| import { tracked } from '@glimmer/tracking'; | ||
| import { inject as service } from '@ember/service'; | ||
| import { action } from '@ember/object'; | ||
| import { task, timeout } from 'ember-concurrency'; | ||
| import config from 'ember-get-config'; | ||
|
|
||
| const SEARCH_DEBOUNCE_PERIOD = 300; | ||
| const SEARCH_CLOSE_PERIOD = 200; | ||
|
|
||
| export default class SearchInputComponent extends Component { | ||
| @service('search') searchService; | ||
|
|
||
| _resultTetherConstraints = [ | ||
| { | ||
| to: 'window', | ||
| pin: ['left', 'right'], | ||
| }, | ||
| ]; | ||
|
|
||
| @tracked _focused = false; | ||
| @tracked query; | ||
| @tracked value = ''; | ||
|
|
||
| get deprecationsGuideURL() { | ||
| return config['deprecationsGuideURL']; | ||
| } | ||
|
|
||
| get showDropdown() { | ||
| return this.query && this._focused; | ||
| } | ||
|
|
||
| search = task(async (query) => { | ||
| await timeout(SEARCH_DEBOUNCE_PERIOD); | ||
|
|
||
| this.query = query; | ||
|
|
||
| // Hide and don't run query if there's no search query | ||
| if (!query) { | ||
| return (this._focused = false); | ||
| } | ||
|
|
||
| // ensure search results are visible if the menu was previously closed above | ||
| this._focused = true; | ||
|
|
||
| await this.searchService.search.perform(query, this.args.projectVersion); | ||
| }); | ||
|
|
||
| closeMenu = task({ restartable: true }, async () => { | ||
| await timeout(SEARCH_CLOSE_PERIOD); | ||
|
There was a problem hiding this comment. it looks like you might have put the restartable on the closeMenu task instead of the search task 🤔 |
||
|
|
||
| this._focused = false; | ||
| }); | ||
|
|
||
| @action | ||
| onfocus() { | ||
| this._focused = true; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,42 @@ | ||
| import Service from '@ember/service'; | ||
| import { tracked } from '@glimmer/tracking'; | ||
| import { task } from 'ember-concurrency'; | ||
| import algoliasearch from 'algoliasearch'; | ||
| import { getOwner } from '@ember/application'; | ||
|
|
||
| export default class SearchServices extends Service { | ||
| @tracked results = []; | ||
| client = null; | ||
| index = null; | ||
|
|
||
| constructor() { | ||
| super(...arguments); | ||
|
|
||
| const config = getOwner(this).resolveRegistration('config:environment'); | ||
| const { algoliaId, algoliaKey, indexName } = config['algolia'] || {}; | ||
|
|
||
| if (algoliaId && algoliaKey && indexName) { | ||
| this.client = algoliasearch(algoliaId, algoliaKey); | ||
| this.index = this.client.initIndex(indexName); | ||
| } | ||
| } | ||
|
|
||
| search = task({ restartable: true }, async (query, projectVersion) => { | ||
| const searchObj = { | ||
| hitsPerPage: 15, | ||
| restrictSearchableAttributes: ['content'], | ||
| }; | ||
|
|
||
| if (projectVersion && projectVersion.match(/\d+\.\d+\.\d+/)) { | ||
| searchObj.facetFilters = [[`version:${projectVersion}`]]; | ||
| } | ||
|
|
||
| return (this.results = await this.doSearch(query, searchObj)); | ||
| }); | ||
|
|
||
| doSearch(query, searchObj) { | ||
| return this.index.search(query, searchObj).then((results) => { | ||
| return results.hits; | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"compilerOptions":{"target":"es6","experimentalDecorators":true},"exclude":["node_modules","bower_components","tmp","vendor",".git","dist"]} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is using 'perform' the standard in this project? To explicitly indicate the action?
In the line above it's commenly written.