forked from palantir/blueprint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itemRenderer.ts
64 lines (51 loc) · 2.24 KB
/
itemRenderer.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
* Copyright 2017 Palantir Technologies, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { MouseEventHandler, Ref } from "react";
/** @deprecated use ItemModifiers */
export type IItemModifiers = ItemModifiers;
export interface ItemModifiers {
/** Whether this is the "active" (focused) item, meaning keyboard interactions will act upon it. */
active: boolean;
/** Whether this item is disabled and should ignore interactions. */
disabled: boolean;
/** Whether this item matches the predicate. A typical renderer could hide `false` values. */
matchesPredicate: boolean;
}
/** @deprecated use ItemRendererProps */
export type IItemRendererProps = ItemRendererProps;
/**
* An object describing how to render a particular item.
* An `itemRenderer` receives the item as its first argument, and this object as its second argument.
*/
export interface ItemRendererProps {
/** A ref that receives the native HTML element rendered by this item. */
ref: Ref<any>;
/** Click event handler to select this item. */
handleClick: MouseEventHandler<HTMLElement>;
/**
* Focus event handler to set this as the "active" item.
*
* N.B. this is optional to preserve back-compat; it will become required in the next major version.
*/
handleFocus?: () => void;
index?: number;
/** Modifiers that describe how to render this item, such as `active` or `disabled`. */
modifiers: ItemModifiers;
/** The current query string used to filter the items. */
query: string;
}
/** Type alias for a function that receives an item and props and renders a JSX element (or `null`). */
export type ItemRenderer<T> = (item: T, itemProps: ItemRendererProps) => JSX.Element | null;