Hierarchy

Hierarchy

Constructors

  • Parameters

    Returns IgrXRipple

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<IIgrXRippleProps> & 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 actualHoverColor(): string
  • Gets or sets the actual color to use for the background when the ripple is hovered.

    Returns string

  • set actualHoverColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualRippleColor(): string
  • Gets or sets the color to use for the actual background when the checkbox is unchecked.

    Returns string

  • set actualRippleColor(v): void
  • Parameters

    • v: string

    Returns void

  • get eventSource(): any
  • Gets or sets the target element to inject ripples into.

    Returns any

  • set eventSource(v): void
  • Parameters

    • v: any

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get hoverColor(): string
  • Gets or sets the color to use for the background when the ripple is hovered.

    Returns string

  • set hoverColor(v): void
  • Parameters

    • v: string

    Returns void

  • get i(): XRipple
  • Returns XRipple

  • get isCentered(): boolean
  • Gets or sets if the ripple is centered.

    Returns boolean

  • set isCentered(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isDisabled(): boolean
  • Gets or sets if the ripple is disabled.

    Returns boolean

  • set isDisabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isHoverEnabled(): boolean
  • Gets or sets if the ripple is centered.

    Returns boolean

  • set isHoverEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get left(): string
  • Returns string

  • set left(value): void
  • Parameters

    • value: string

    Returns void

  • get position(): string
  • Returns string

  • set position(value): void
  • Parameters

    • value: string

    Returns void

  • get rippleColor(): string
  • Gets or sets the color to use for the background when the checkbox is unchecked.

    Returns string

  • set rippleColor(v): void
  • Parameters

    • v: string

    Returns void

  • get rippleDuration(): number
  • Gets or sets the duration to use for the ripple animation.

    Returns number

  • set rippleDuration(v): void
  • Parameters

    • v: number

    Returns void

  • get top(): string
  • Returns string

  • set top(value): void
  • Parameters

    • value: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • 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<IIgrXRippleProps>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Returns void

  • Returns void

  • Returns a serialized copy of the exported visual model

    Returns string

  • Exports visual information about the current state of the grid.

    Returns any

  • Parameters

    • name: string

    Returns any

  • 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

  • Returns void

  • Returns void

  • Returns void

  • Returns DetailedReactHTMLElement<{
        className: string;
        ref: ((ref) => void);
    }, any>

  • 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

  • Returns void