The tile component is used within the igc-tile-manager as a container for displaying various types of information.

Type Parameters

Hierarchy

Hierarchy

  • Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}>
    • IgrTile

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P & Omit<HTMLAttributes<HTMLElement>, keyof P>

    Returns IgrTile<P>

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<P & Omit<HTMLAttributes<HTMLElement>, keyof P>> & 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 colSpan(): number
  • The number of columns the tile will span.

    Remarks

    When setting a value that is less than 1, it will be coerced to 1.

    Default

    1
    

    Returns number

  • set colSpan(v): void
  • Parameters

    • v: number

    Returns void

  • get colStart(): number
  • The starting column for the tile.

    Returns number

  • set colStart(v): void
  • Parameters

    • v: number

    Returns void

  • get disableFullscreen(): boolean
  • Whether to disable the rendering of the tile fullscreen-action slot and its default fullscreen action button.

    Default

    false
    

    Returns boolean

  • set disableFullscreen(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disableMaximize(): boolean
  • Whether to disable the rendering of the tile maximize-action slot and its default maximize action button.

    Default

    false
    

    Returns boolean

  • set disableMaximize(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disableResize(): boolean
  • Indicates whether to disable tile resize behavior regardless ot its tile manager parent settings.

    Default

    false
    

    Returns boolean

  • set disableResize(v): void
  • Parameters

    • v: boolean

    Returns void

  • get fullscreen(): boolean
  • Indicates whether the tile occupies the whole screen.

    Returns boolean

  • get maximized(): boolean
  • Indicates whether the tile occupies all available space within the layout.

    Returns boolean

  • set maximized(v): void
  • Parameters

    • v: boolean

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get position(): number
  • Gets/sets the tile's visual position in the layout. Corresponds to the CSS order property.

    Returns number

  • set position(v): void
  • Parameters

    • v: number

    Returns void

  • get rowSpan(): number
  • The number of rows the tile will span.

    Remarks

    When setting a value that is less than 1, it will be coerced to 1.

    Default

    1
    

    Returns number

  • set rowSpan(v): void
  • Parameters

    • v: number

    Returns void

  • get rowStart(): number
  • The starting row for the tile.

    Returns number

  • set rowStart(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • nextContext: any

    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

  • 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<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • 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

  • 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

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    Returns any

  • Returns DOMElement<{
        children: any[];
        class: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["className"];
        id: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["id"];
        ref: ((ref) => void);
        style: {};
    }, any>

  • 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