@docsvision/webclient
Version:
Type definitions for DocsVision WebClient scripts and extensions.
339 lines (338 loc) • 20.7 kB
TypeScript
import { InputBasedControlState, InputBasedControlImpl } from '@docsvision/webclient/System/InputBasedControlImpl';
import React from 'react';
import { Typeahead } from '@docsvision/webclient/Helpers/Typeahead/Typeahead';
import { ITypeaheadVariant } from '@docsvision/webclient/Helpers/Typeahead/Models/ITypeaheadVariant';
import { SimpleEvent } from '@docsvision/webclient/System/SimpleEvent';
import { ITypeaheadSearchResult } from '@docsvision/webclient/Helpers/Typeahead/Models/ITypeaheadSearchResult';
import { FolderViewItemsParams } from '@docsvision/webclient/Platform/FolderViewItems';
/** @internal */
export declare type FolderViewVariant = ITypeaheadVariant & {
isDefault: boolean;
};
/** @internal */
export declare type FolderViewSearchResult = {
items: Array<FolderViewVariant>;
hasMore: boolean;
};
/** @internal */
export interface IFolderViewItemsState extends FolderViewItemsParams, InputBasedControlState<string> {
typeahead: Typeahead;
inputKeyDown: SimpleEvent<React.KeyboardEvent>;
selected: FolderViewVariant;
services: any;
}
export interface FolderViewItemsState extends IFolderViewItemsState {
}
/** @internal */
export declare type FolderViewItemsImplState = IFolderViewItemsState;
/** @internal */
export declare class FolderViewItemsImpl extends InputBasedControlImpl<string, FolderViewItemsParams, IFolderViewItemsState> {
constructor(props: any, state: any);
protected getTextValue(): string;
protected getCssClass(): string;
protected renderInto(props: FolderViewItemsParams, container: HTMLElement): void;
protected onInputChange(ev: React.ChangeEvent): void;
protected getInputProps(): {
readOnly: boolean;
ref?: React.LegacyRef<HTMLInputElement>;
key?: React.ReactText;
accept?: string;
alt?: string;
autoComplete?: string;
autoFocus?: boolean;
capture?: string | boolean;
checked?: boolean;
crossOrigin?: string;
disabled?: boolean;
enterKeyHint?: "search" | "enter" | "done" | "go" | "next" | "previous" | "send";
form?: string;
formAction?: string;
formEncType?: string;
formMethod?: string;
formNoValidate?: boolean;
formTarget?: string;
height?: React.ReactText;
list?: string;
max?: React.ReactText;
maxLength?: number;
min?: React.ReactText;
minLength?: number;
multiple?: boolean;
name?: string;
pattern?: string;
placeholder?: string;
required?: boolean;
size?: number;
src?: string;
step?: React.ReactText;
type?: string;
value?: string | number | readonly string[];
width?: React.ReactText;
onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
defaultChecked?: boolean;
defaultValue?: string | number | readonly string[];
suppressContentEditableWarning?: boolean;
suppressHydrationWarning?: boolean;
accessKey?: string;
className?: string;
contentEditable?: boolean | "inherit" | "true" | "false";
contextMenu?: string;
dir?: string;
draggable?: boolean | "true" | "false";
hidden?: boolean;
id?: string;
lang?: string;
slot?: string;
spellCheck?: boolean | "true" | "false";
style?: React.CSSProperties;
tabIndex?: number;
title?: string;
translate?: "no" | "yes";
radioGroup?: string;
role?: string;
about?: string;
datatype?: string;
inlist?: any;
prefix?: string;
property?: string;
resource?: string;
typeof?: string;
vocab?: string;
autoCapitalize?: string;
autoCorrect?: string;
autoSave?: string;
color?: string;
itemProp?: string;
itemScope?: boolean;
itemType?: string;
itemID?: string;
itemRef?: string;
results?: number;
security?: string;
unselectable?: "on" | "off";
inputMode?: "text" | "url" | "none" | "tel" | "email" | "numeric" | "decimal" | "search";
is?: string;
'aria-activedescendant'?: string;
'aria-atomic'?: boolean | "true" | "false";
'aria-autocomplete'?: "none" | "list" | "inline" | "both";
'aria-busy'?: boolean | "true" | "false";
'aria-checked'?: boolean | "true" | "false" | "mixed";
'aria-colcount'?: number;
'aria-colindex'?: number;
'aria-colspan'?: number;
'aria-controls'?: string;
'aria-current'?: boolean | "time" | "true" | "false" | "step" | "page" | "location" | "date";
'aria-describedby'?: string;
'aria-details'?: string;
'aria-disabled'?: boolean | "true" | "false";
'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup";
'aria-errormessage'?: string;
'aria-expanded'?: boolean | "true" | "false";
'aria-flowto'?: string;
'aria-grabbed'?: boolean | "true" | "false";
'aria-haspopup'?: boolean | "dialog" | "menu" | "true" | "false" | "listbox" | "tree" | "grid";
'aria-hidden'?: boolean | "true" | "false";
'aria-invalid'?: boolean | "true" | "false" | "grammar" | "spelling";
'aria-keyshortcuts'?: string;
'aria-label'?: string;
'aria-labelledby'?: string;
'aria-level'?: number;
'aria-live'?: "off" | "assertive" | "polite";
'aria-modal'?: boolean | "true" | "false";
'aria-multiline'?: boolean | "true" | "false";
'aria-multiselectable'?: boolean | "true" | "false";
'aria-orientation'?: "horizontal" | "vertical";
'aria-owns'?: string;
'aria-placeholder'?: string;
'aria-posinset'?: number;
'aria-pressed'?: boolean | "true" | "false" | "mixed";
'aria-readonly'?: boolean | "true" | "false";
'aria-relevant'?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
'aria-required'?: boolean | "true" | "false";
'aria-roledescription'?: string;
'aria-rowcount'?: number;
'aria-rowindex'?: number;
'aria-rowspan'?: number;
'aria-selected'?: boolean | "true" | "false";
'aria-setsize'?: number;
'aria-sort'?: "none" | "ascending" | "descending" | "other";
'aria-valuemax'?: number;
'aria-valuemin'?: number;
'aria-valuenow'?: number;
'aria-valuetext'?: string;
children?: React.ReactNode;
dangerouslySetInnerHTML?: {
__html: string;
};
onCopy?: (event: React.ClipboardEvent<HTMLInputElement>) => void;
onCopyCapture?: (event: React.ClipboardEvent<HTMLInputElement>) => void;
onCut?: (event: React.ClipboardEvent<HTMLInputElement>) => void;
onCutCapture?: (event: React.ClipboardEvent<HTMLInputElement>) => void;
onPaste?: (event: React.ClipboardEvent<HTMLInputElement>) => void;
onPasteCapture?: (event: React.ClipboardEvent<HTMLInputElement>) => void;
onCompositionEnd?: (event: React.CompositionEvent<HTMLInputElement>) => void;
onCompositionEndCapture?: (event: React.CompositionEvent<HTMLInputElement>) => void;
onCompositionStart?: (event: React.CompositionEvent<HTMLInputElement>) => void;
onCompositionStartCapture?: (event: React.CompositionEvent<HTMLInputElement>) => void;
onCompositionUpdate?: (event: React.CompositionEvent<HTMLInputElement>) => void;
onCompositionUpdateCapture?: (event: React.CompositionEvent<HTMLInputElement>) => void;
onFocus?: (event: React.FocusEvent<HTMLInputElement>) => void;
onFocusCapture?: (event: React.FocusEvent<HTMLInputElement>) => void;
onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
onBlurCapture?: (event: React.FocusEvent<HTMLInputElement>) => void;
onChangeCapture?: (event: React.FormEvent<HTMLInputElement>) => void;
onBeforeInput?: (event: React.FormEvent<HTMLInputElement>) => void;
onBeforeInputCapture?: (event: React.FormEvent<HTMLInputElement>) => void;
onInput?: (event: React.FormEvent<HTMLInputElement>) => void;
onInputCapture?: (event: React.FormEvent<HTMLInputElement>) => void;
onReset?: (event: React.FormEvent<HTMLInputElement>) => void;
onResetCapture?: (event: React.FormEvent<HTMLInputElement>) => void;
onSubmit?: (event: React.FormEvent<HTMLInputElement>) => void;
onSubmitCapture?: (event: React.FormEvent<HTMLInputElement>) => void;
onInvalid?: (event: React.FormEvent<HTMLInputElement>) => void;
onInvalidCapture?: (event: React.FormEvent<HTMLInputElement>) => void;
onLoad?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onError?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onErrorCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onKeyDown?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
onKeyDownCapture?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
onKeyPress?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
onKeyPressCapture?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
onKeyUp?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
onKeyUpCapture?: (event: React.KeyboardEvent<HTMLInputElement>) => void;
onAbort?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onAbortCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onCanPlay?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onCanPlayCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onCanPlayThrough?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onCanPlayThroughCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onDurationChange?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onDurationChangeCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onEmptied?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onEmptiedCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onEncrypted?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onEncryptedCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onEnded?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onEndedCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadedData?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadedDataCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadedMetadata?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadedMetadataCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadStart?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onLoadStartCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onPause?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onPauseCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onPlay?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onPlayCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onPlaying?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onPlayingCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onProgress?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onProgressCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onRateChange?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onRateChangeCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSeeked?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSeekedCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSeeking?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSeekingCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onStalled?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onStalledCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSuspend?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSuspendCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onTimeUpdate?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onTimeUpdateCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onVolumeChange?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onVolumeChangeCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onWaiting?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onWaitingCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onAuxClick?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onAuxClickCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onClick?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onClickCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onContextMenu?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onContextMenuCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onDoubleClick?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onDoubleClickCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onDrag?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragEnd?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragEndCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragEnter?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragEnterCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragExit?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragExitCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragLeave?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragLeaveCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragOver?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragOverCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragStart?: (event: React.DragEvent<HTMLInputElement>) => void;
onDragStartCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onDrop?: (event: React.DragEvent<HTMLInputElement>) => void;
onDropCapture?: (event: React.DragEvent<HTMLInputElement>) => void;
onMouseDown?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseDownCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseEnter?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseLeave?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseMove?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseMoveCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseOut?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseOutCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseOver?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseOverCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseUp?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onMouseUpCapture?: (event: React.MouseEvent<HTMLInputElement, MouseEvent>) => void;
onSelect?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onSelectCapture?: (event: React.SyntheticEvent<HTMLInputElement, Event>) => void;
onTouchCancel?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchCancelCapture?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchEnd?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchEndCapture?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchMove?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchMoveCapture?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchStart?: (event: React.TouchEvent<HTMLInputElement>) => void;
onTouchStartCapture?: (event: React.TouchEvent<HTMLInputElement>) => void;
onPointerDown?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerDownCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerMove?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerMoveCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerUp?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerUpCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerCancel?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerCancelCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerEnter?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerEnterCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerLeave?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerLeaveCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerOver?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerOverCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerOut?: (event: React.PointerEvent<HTMLInputElement>) => void;
onPointerOutCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onGotPointerCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onGotPointerCaptureCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onLostPointerCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onLostPointerCaptureCapture?: (event: React.PointerEvent<HTMLInputElement>) => void;
onScroll?: (event: React.UIEvent<HTMLInputElement, UIEvent>) => void;
onScrollCapture?: (event: React.UIEvent<HTMLInputElement, UIEvent>) => void;
onWheel?: (event: React.WheelEvent<HTMLInputElement>) => void;
onWheelCapture?: (event: React.WheelEvent<HTMLInputElement>) => void;
onAnimationStart?: (event: React.AnimationEvent<HTMLInputElement>) => void;
onAnimationStartCapture?: (event: React.AnimationEvent<HTMLInputElement>) => void;
onAnimationEnd?: (event: React.AnimationEvent<HTMLInputElement>) => void;
onAnimationEndCapture?: (event: React.AnimationEvent<HTMLInputElement>) => void;
onAnimationIteration?: (event: React.AnimationEvent<HTMLInputElement>) => void;
onAnimationIterationCapture?: (event: React.AnimationEvent<HTMLInputElement>) => void;
onTransitionEnd?: (event: React.TransitionEvent<HTMLInputElement>) => void;
onTransitionEndCapture?: (event: React.TransitionEvent<HTMLInputElement>) => void;
css?:
import("@emotion/core").InterpolationWithTheme<any>;
};
protected attachTypeahead(typeahead: Typeahead): void;
protected onTypeaheadSelected(variant: FolderViewVariant): Promise<void>;
protected processTypeaheadSelected(variant: FolderViewVariant): Promise<void>;
protected findItems(): Promise<ITypeaheadSearchResult>;
setDefault(): Promise<void>;
getById(id: string): Promise<FolderViewVariant>;
protected renderTypeahead(): JSX.Element;
protected renderTypeaheadInput(): JSX.Element;
protected renderInputWithPlaceholder(): JSX.Element;
}