Represents a DropDown component.

Hierarchy

Hierarchy

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrSelectProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get autofocus(): boolean
  • The autofocus attribute of the control.

    Returns boolean

  • set autofocus(v): void
  • Parameters

    • v: boolean

    Returns void

  • get blur(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set blur(ev): void
  • Parameters

    Returns void

  • get dir(): SelectDir
  • The direction attribute of the control.

    Returns SelectDir

  • set dir(v): void
  • Parameters

    Returns void

  • get disabled(): boolean
  • The disabled attribute of the control.

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get distance(): number
  • The distance from the target element.

    Returns number

  • set distance(v): void
  • Parameters

    • v: number

    Returns void

  • get flip(): boolean
  • Whether the component should be flipped to the opposite side of the target once it's about to overflow the visible area. When true, once enough space is detected on its preferred side, it will flip back.

    Returns boolean

  • set flip(v): void
  • Parameters

    • v: boolean

    Returns void

  • get focus(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set focus(ev): void
  • Parameters

    Returns void

  • get invalid(): boolean
  • The invalid attribute of the control.

    Returns boolean

  • set invalid(v): void
  • Parameters

    • v: boolean

    Returns void

  • get keepOpenOnOutsideClick(): boolean
  • Whether the component should be kept open on clicking outside of it.

    Returns boolean

  • set keepOpenOnOutsideClick(v): void
  • Parameters

    • v: boolean

    Returns void

  • get keepOpenOnSelect(): boolean
  • Whether the dropdown should be kept open on selection.

    Returns boolean

  • set keepOpenOnSelect(v): void
  • Parameters

    • v: boolean

    Returns void

  • get label(): string
  • The label attribute of the control.

    Returns string

  • set label(v): void
  • Parameters

    • v: string

    Returns void

  • get name(): string
  • The name attribute of the control.

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get open(): boolean
  • Sets the open state of the component.

    Returns boolean

  • set open(v): void
  • Parameters

    • v: boolean

    Returns void

  • get outlined(): boolean
  • The outlined attribute of the control.

    Returns boolean

  • set outlined(v): void
  • Parameters

    • v: boolean

    Returns void

  • get placeholder(): string
  • The placeholder attribute of the control.

    Returns string

  • set placeholder(v): void
  • Parameters

    • v: string

    Returns void

  • get placement(): DropdownPlacement
  • The preferred placement of the component around the target element.

    Returns DropdownPlacement

  • set placement(v): void
  • Parameters

    Returns void

  • get positionStrategy(): DropdownPositionStrategy
  • Sets the component's positioning strategy.

    Returns DropdownPositionStrategy

  • set positionStrategy(v): void
  • Parameters

    Returns void

  • get required(): boolean
  • The required attribute of the control.

    Returns boolean

  • set required(v): void
  • Parameters

    • v: boolean

    Returns void

  • get sameWidth(): boolean
  • Whether the dropdown's width should be the same as the target's one.

    Returns boolean

  • set sameWidth(v): void
  • Parameters

    • v: boolean

    Returns void

  • get scrollStrategy(): DropdownScrollStrategy
  • Determines the behavior of the component during scrolling the container.

    Returns DropdownScrollStrategy

  • set scrollStrategy(v): void
  • Parameters

    Returns void

  • get value(): string
  • The value attribute of the control.

    Returns string

  • set value(v): void
  • Parameters

    • v: string

    Returns void

Methods

  • Removes focus from the component.

    Returns void

  • Checks the validity of the control.

    Returns void

  • Clears the current selection of the dropdown.

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IIgrSelectProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Sets focus on the component.

    Parameters

    Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Hides the dropdown.

    Returns void

  • Returns DOMElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
        style: {};
    }, any>

  • Checks the validity of the control and moves the focus to it if it is not valid.

    Returns void

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Shows the dropdown.

    Returns void

  • Shows the dropdown.

    Parameters

    • target_: any

    Returns void

  • Toggles the open state of the dropdown.

    Returns void

  • Toggles the open state of the dropdown.

    Parameters

    • target_: any

    Returns void