Gazebo_simulation-Frontend/node_modules/downshift/typings/index.d.ts
2020-12-21 10:29:31 -05:00

230 lines
6.6 KiB
TypeScript

import * as React from 'react'
type Callback = () => void
export interface DownshiftState<Item> {
highlightedIndex: number | null
inputValue: string | null
isOpen: boolean
selectedItem: Item | null
}
export enum StateChangeTypes {
unknown = '__autocomplete_unknown__',
mouseUp = '__autocomplete_mouseup__',
itemMouseEnter = '__autocomplete_item_mouseenter__',
keyDownArrowUp = '__autocomplete_keydown_arrow_up__',
keyDownArrowDown = '__autocomplete_keydown_arrow_down__',
keyDownEscape = '__autocomplete_keydown_escape__',
keyDownEnter = '__autocomplete_keydown_enter__',
clickItem = '__autocomplete_click_item__',
blurInput = '__autocomplete_blur_input__',
changeInput = '__autocomplete_change_input__',
keyDownSpaceButton = '__autocomplete_keydown_space_button__',
clickButton = '__autocomplete_click_button__',
blurButton = '__autocomplete_blur_button__',
controlledPropUpdatedSelectedItem = '__autocomplete_controlled_prop_updated_selected_item__',
touchEnd = '__autocomplete_touchend__',
}
export interface DownshiftProps<Item> {
initialSelectedItem?: Item
initialInputValue?: string
initialHighlightedIndex?: number | null
initialIsOpen?: boolean
defaultHighlightedIndex?: number | null
defaultIsOpen?: boolean
itemToString?: (item: Item | null) => string
selectedItemChanged?: (prevItem: Item, item: Item) => boolean
getA11yStatusMessage?: (options: A11yStatusMessageOptions<Item>) => string
onChange?: (
selectedItem: Item | null,
stateAndHelpers: ControllerStateAndHelpers<Item>,
) => void
onSelect?: (
selectedItem: Item | null,
stateAndHelpers: ControllerStateAndHelpers<Item>,
) => void
onStateChange?: (
options: StateChangeOptions<Item>,
stateAndHelpers: ControllerStateAndHelpers<Item>,
) => void
onInputValueChange?: (
inputValue: string,
stateAndHelpers: ControllerStateAndHelpers<Item>,
) => void
stateReducer?: (
state: DownshiftState<Item>,
changes: StateChangeOptions<Item>,
) => Partial<StateChangeOptions<Item>>
itemCount?: number
highlightedIndex?: number | null
inputValue?: string | null
isOpen?: boolean
selectedItem?: Item | null
children?: ChildrenFunction<Item>
id?: string
inputId?: string
labelId?: string
menuId?: string
getItemId?: (index?: number) => string
environment?: Environment
onOuterClick?: (stateAndHelpers: ControllerStateAndHelpers<Item>) => void
onUserAction?: (
options: StateChangeOptions<Item>,
stateAndHelpers: ControllerStateAndHelpers<Item>,
) => void
suppressRefError?: boolean
}
export interface Environment {
addEventListener: typeof window.addEventListener
removeEventListener: typeof window.removeEventListener
document: Document
}
export interface A11yStatusMessageOptions<Item> {
highlightedIndex: number | null
inputValue: string
isOpen: boolean
itemToString: (item: Item) => string
previousResultCount: number
resultCount: number
highlightedItem: Item
selectedItem: Item
}
export interface StateChangeOptions<Item>
extends Partial<DownshiftState<Item>> {
type: StateChangeTypes
}
type StateChangeFunction<Item> = (
state: DownshiftState<Item>,
) => Partial<StateChangeOptions<Item>>
export interface GetRootPropsOptions {
refKey: string
}
export interface GetInputPropsOptions
extends React.HTMLProps<HTMLInputElement> {
disabled?: boolean
}
export interface GetLabelPropsOptions
extends React.HTMLProps<HTMLLabelElement> {}
export interface GetToggleButtonPropsOptions
extends React.HTMLProps<HTMLButtonElement> {
disabled?: boolean
}
export interface GetMenuPropsOptions extends React.HTMLProps<HTMLElement> {
refKey?: string
['aria-label']?: string
}
export interface GetPropsCommonOptions {
suppressRefError?: boolean
}
export interface GetItemPropsOptions<Item>
extends React.HTMLProps<HTMLElement> {
index?: number
item: Item
isSelected?: boolean
disabled?: boolean
}
export interface PropGetters<Item> {
getRootProps: (
options?: GetRootPropsOptions,
otherOptions?: GetPropsCommonOptions,
) => any
getToggleButtonProps: (options?: GetToggleButtonPropsOptions) => any
getLabelProps: (options?: GetLabelPropsOptions) => any
getMenuProps: (
options?: GetMenuPropsOptions,
otherOptions?: GetPropsCommonOptions,
) => any
getInputProps: <T>(options?: T) => T & GetInputPropsOptions
getItemProps: (options: GetItemPropsOptions<Item>) => any
}
export interface Actions<Item> {
reset: (
otherStateToSet?: Partial<StateChangeOptions<Item>>,
cb?: Callback,
) => void
openMenu: (cb?: Callback) => void
closeMenu: (cb?: Callback) => void
toggleMenu: (
otherStateToSet?: Partial<StateChangeOptions<Item>>,
cb?: Callback,
) => void
selectItem: (
item: Item,
otherStateToSet?: Partial<StateChangeOptions<Item>>,
cb?: Callback,
) => void
selectItemAtIndex: (
index: number,
otherStateToSet?: Partial<StateChangeOptions<Item>>,
cb?: Callback,
) => void
selectHighlightedItem: (
otherStateToSet?: Partial<StateChangeOptions<Item>>,
cb?: Callback,
) => void
setHighlightedIndex: (
index: number,
otherStateToSet?: Partial<StateChangeOptions<Item>>,
cb?: Callback,
) => void
clearSelection: (cb?: Callback) => void
clearItems: () => void
setItemCount: (count: number) => void
unsetItemCount: () => void
setState: (
stateToSet: Partial<StateChangeOptions<Item>> | StateChangeFunction<Item>,
cb?: Callback,
) => void
// props
itemToString: (item: Item) => string
}
export type ControllerStateAndHelpers<Item> = DownshiftState<Item> &
PropGetters<Item> &
Actions<Item>
export type ChildrenFunction<Item> = (
options: ControllerStateAndHelpers<Item>,
) => React.ReactNode
export type DownshiftInterface<Item> = React.ComponentClass<
DownshiftProps<Item>
> & {
stateChangeTypes: {
unknown: StateChangeTypes.unknown
mouseUp: StateChangeTypes.mouseUp
itemMouseEnter: StateChangeTypes.itemMouseEnter
keyDownArrowUp: StateChangeTypes.keyDownArrowUp
keyDownArrowDown: StateChangeTypes.keyDownArrowDown
keyDownEscape: StateChangeTypes.keyDownEscape
keyDownEnter: StateChangeTypes.keyDownEnter
clickItem: StateChangeTypes.clickItem
blurInput: StateChangeTypes.blurInput
changeInput: StateChangeTypes.changeInput
keyDownSpaceButton: StateChangeTypes.keyDownSpaceButton
clickButton: StateChangeTypes.clickButton
blurButton: StateChangeTypes.blurButton
controlledPropUpdatedSelectedItem: StateChangeTypes.controlledPropUpdatedSelectedItem
touchEnd: StateChangeTypes.touchEnd
}
}
declare const Downshift: DownshiftInterface<any>
export default Downshift
export function resetIdCounter(): void