[Select] Add resetOnQuery prop

[switz]

Fixes #2867

Checklist

• Enable CircleCI for your fork
• Include tests
• Update documentation

Changes proposed in this pull request:

Adds a prop called resetActiveItemOnQuery which will update a Select/QueryList's activeItem while querying.

This feels to me like it should default to true, but I'll defer to you.

Reviewers should focus on:

Set resetActiveItemOnQuery=true and query for "Forrest". You'll see the first item in the list become active as soon as the existing activeItem falls out of scope.

Screenshot

[palantirtech]

Thanks for your interest in palantir/blueprint, @switz! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

[giladgray]

@switz 😱 this is awesome! will review more carefully soon, just so excited to see this feature implemented!!!

[giladgray]

code looks great, nice tests 👍
just want to discuss the prop name real quick 😄

[giladgray]

ok so I see why you called it resetActiveItemOnQuery instead of resetOnQuery, but i kinda feel like the mere fact that it has query in the name suggests it won't reset the query on query. we can add a note in the prop docs to clarify. thoughts?

[switz]

Yeah, I don't love the name either but felt it was clearer than resetOnQuery. I'm open to a better name and am happy to expand the docs a bit.

[switz]

Any thoughts on true by default?

[giladgray]

let's go with resetOnQuery and see how it feels. i like the consistency.

i'm definitely inclined towards true by default -- it's the behavior i've been trying to implement all along. question is if it noticeably breaks common use cases?

[switz]

Ok, I think that prop name is a bit unclear, but will push up a build with that change & defaulting to true. Playing with the demo a bit feels good -- I don't think that it would break any common use cases.

[switz]

Switch prop name from resetActiveItemOnQuery to resetOnQuery and default prop to true

Preview: documentation | landing | table

[giladgray]

@switz this second sentence is not accurate... changing the query always resets to first active item. did you intend it to only reset if the active item falls out of scope?

[switz]

That's a great point -- I'm not sure which is better to be honest. I can update the docs in the meantime.

[switz]

Match documentation to current functionality

Preview: documentation | landing | table

[giladgray]

"Whether the active item should be reset to the first matching item every time the query changes."

simple, precise.

[giladgray]

oops, not ready. move the prop default to the lowest level and edit the docs.

[giladgray]

hmm actually this default does not belong here, it should be in QueryList itself so it applies to all components. you can revert this change as it was already passed through the spread.

[switz]

I put it there because queryList doesn't have a default props (from what I could tell). Do you want me to add one or can you point me to where it's located?

[giladgray]

it's only used the one time in QueryList so you could just modify that method to do the deconstruct-default like you have here.

[switz]

Unless there's some es6 fanciness that I don't know. If I just handle it in that method I have to do this:

  public setQuery(query: string, resetActiveItem?: boolean) {
    const { resetOnQuery } = this.props;

    // only override resetActiveItem if param is undefined
    if (typeof resetActiveItem === 'undefined') {
        // default to true if resetOnQuery prop is not defined
        if (typeof resetOnQuery === 'undefined') {
            resetActiveItem = true;
        }
        else {
            resetActiveItem = resetOnQuery;
        }
    }
    // ...rest of fn
  }

so I think I'll add a public static defaultProps to the component

public static defaultProps = {
    resetOnQuery: true,
};
// ...later on...
public setQuery(query: string, resetActiveItem = this.props.resetOnQuery) {

[giladgray]

nope, in QueryList please

[giladgray]

in QueryList

[giladgray]

in QueryList

[giladgray]

Whether the active item should be reset to the first matching item when an item is selected.
The query will also be reset to the empty string.

and please make this same change in resetOnClose

[switz]

Not sure I follow -- you want that to replace the docs for resetOnSelect (in listItemProps.ts) & resetOnClose (in select.tsx)?

[giladgray]

that's the goal. i can do it if you're not comfortable

[switz]

Move default prop down to the lowest level, queryList

Preview: documentation | landing | table

[switz]

Move default prop down to the lowest level, queryList

Preview: documentation | landing | table

[giladgray]

👏 great work @switz! question about the tests.

[giladgray]

why was this necessary? does setting the query prop cause an extra re-render?

[switz]

yeah it re-renders the items

[giladgray]

opened a followup PR that resolves this... check it #2916