Skip to content

find as you type search #799

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.

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

Closed
wants to merge 21 commits into from
Closed

find as you type search #799

wants to merge 21 commits into from

Conversation

sethladd
Copy link
Contributor

@sethladd sethladd commented Aug 8, 2015

WIP

@devoncarew @keertip the plan is to generate a simple JSON file, enough to power a find-as-you-type search.

Do either of you have an opinion on how to implement the HTML bits for this? (e.g. found a good example?)

@sethladd sethladd mentioned this pull request Aug 8, 2015
@sethladd
Copy link
Contributor Author

cc @keertip @devoncarew please take a look. I think this is good enough to try out and send feedback.

Just tried it on the SDK. First thing I noticed: we need to rank somehow. Suggestions welcome. (e.g. does a class name outrank a field name?)

@@ -166,13 +168,34 @@ class HtmlGeneratorInstance {

if (package != null) {
_generateDocs();
_generateJson();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps _generateIndex() or _generateSearchIndex()?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

@devoncarew
Copy link
Member

Looks great! A question about mobile behavior.

@sethladd
Copy link
Contributor Author

Ready for review. It's not perfect, but I believe it's enough to get feedback on the actual behavior. Would like to do a build with this behavior and then tweak the ranking algorithm, based on feedback.

This also fixes a few issues with paddings and lines.

Search box is hidden for very small widths, will need to revisit. Should be visible for nearly all desktop users.

cc @devoncarew

@devoncarew
Copy link
Member

It's a big one! Awesome to have this feature. 🔥

One bit of feedback on the UI. I'm not sure what the material design spec for search boxes is, but the square box doesn't say search to me. Consider putting a border-radius: 2px on it to round the edges.

lgtm

@sethladd
Copy link
Contributor Author

Consider putting a border-radius: 2px on it to round the edges.

Sure, I'll give it a try.

Thanks for the review!

@sethladd sethladd closed this in f29c8f9 Aug 13, 2015
@sethladd sethladd deleted the sl-find-as-you-type branch August 13, 2015 22:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants