Documentation for renderFilteredItems() #3864

ViggoV · 2019-11-21T15:18:51Z

Environment

Package version(s): @blueprintjs/core@3.17.2 @blueprintjs/select@3.11.2
Browser and OS versions: MacOS Catalina (10.15.1) / Chrome 78.0.3904.108

Question

Is there any solid documentation for the renderFilteredItems() utility function exported from the select package? It is briefly mentioned under the itemListRenderer props section of the select component documentation, but the only other mention I can find of it is in this issue #3281 ans well as a brief mention in a changelog.

In the itemListRenderer props section it is stated that it supports a noResults state, but it doesn't say how to use it and it doesn't render the noResults defined on the Select/Suggest component..

ViggoV · 2019-11-21T15:38:16Z

I figured it out. Would be nice with a short entry in the docs though.

To other confused souls:
Pass the first and only argument given to the itemListRenderer directly on as the first argument for renderFilteredItems, which will render the filtered items as defined in your itemRenderer. Then you can pass a component for displaying noResults as the second argument:

<Suggest
  // ...
  itemListRenderer={props => (
    <SomeMenuComponent>
      {renderFilteredItems(props, <SomeNoResultsComponent />)}
    </SomeMenuComponent>
  )}
  // ...
/>

I assume the same is the case for the third argument, which would then represent an initalContent component

giladgray · 2019-12-15T09:03:04Z

the code itself is documented, which should appear in an editor. sorry it's not on the site.
https://github.com/palantir/blueprint/blob/develop/packages/select/src/common/itemListRenderer.ts#L68-L83

adidahiya added Domain: documentation good first issue help wanted P2 Package: select labels Nov 21, 2019

palantir / blueprint

Documentation for renderFilteredItems() #3864

Documentation for renderFilteredItems() #3864

ViggoV commented Nov 21, 2019

ViggoV commented Nov 21, 2019

giladgray commented Dec 15, 2019

palantir / blueprint

Join GitHub today

Documentation for renderFilteredItems() #3864

Documentation for renderFilteredItems() #3864

Comments

ViggoV commented Nov 21, 2019

Environment

Question

ViggoV commented Nov 21, 2019

giladgray commented Dec 15, 2019

Essential cookies

Always active

Analytics cookies