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<IIgrIconButtonProps> & 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 ariaLabel(): string
  • Returns string

  • set ariaLabel(v): void
  • Parameters

    • v: string

    Returns void

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

  • set clicked(ev): void
  • Parameters

    Returns void

  • get collection(): string
  • The name of the icon collection.

    Returns string

  • set collection(v): void
  • Parameters

    • v: string

    Returns void

  • get disabled(): boolean
  • Determines whether the button is disabled.

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get download(): string
  • Prompts to save the linked URL instead of navigating to it.

    Returns string

  • set download(v): void
  • Parameters

    • v: string

    Returns void

  • get href(): string
  • The URL the button points to.

    Returns string

  • set href(v): void
  • Parameters

    • v: string

    Returns void

  • get mirrored(): boolean
  • Whether to flip the icon button. Useful for RTL layouts.

    Returns boolean

  • set mirrored(v): void
  • Parameters

    • v: boolean

    Returns void

  • get name(): string
  • The name of the icon.

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get rel(): string
  • The relationship of the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types

    Returns string

  • set rel(v): void
  • Parameters

    • v: string

    Returns void

  • get size(): SizableComponentSize
  • Returns SizableComponentSize

  • set size(v): void
  • Parameters

    Returns void

  • get target(): ButtonBaseTarget
  • Where to display the linked URL, as the name for a browsing context.

    Returns ButtonBaseTarget

  • set target(v): void
  • Parameters

    Returns void

  • get type(): ButtonBaseType
  • The type of the button. Defaults to undefined.

    Returns ButtonBaseType

  • set type(v): void
  • Parameters

    Returns void

  • get variant(): IconButtonVariant
  • The visual variant of the icon button.

    Returns IconButtonVariant

  • set variant(v): void
  • Parameters

    Returns void

Methods

  • Removes focus from the button.

    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

    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

    Returns any

  • Parameters

    • name: string
    • url: string
    • collection: string

    Returns void

  • Parameters

    • name: string
    • iconText: string
    • collection: string

    Returns void

  • Returns DOMElement<{
        children: any[];
        className: string;
        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