The step component is used within the igc-stepper element and it holds the content of each step. It also supports custom indicators, title and subtitle.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrStep

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P

    Returns IgrStep<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> & 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 active(): boolean
  • Gets/sets whether the step is activе.

    Returns boolean

  • set active(v): void
  • Parameters

    • v: boolean

    Returns void

  • get complete(): boolean
  • Gets/sets whether the step is completed.

    Remarks

    When set to true the following separator is styled solid.

    Returns boolean

  • set complete(v): void
  • Parameters

    • v: boolean

    Returns void

  • get disabled(): boolean
  • Gets/sets whether the step is interactable.

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get invalid(): boolean
  • Gets/sets whether the step is invalid.

    Returns boolean

  • set invalid(v): void
  • Parameters

    • v: boolean

    Returns void

  • get optional(): boolean
  • Gets/sets whether the step is optional.

    Remarks

    Optional steps validity does not affect the default behavior when the stepper is in linear mode i.e. if optional step is invalid the user could still move to the next step.

    Returns boolean

  • set optional(v): void
  • Parameters

    • v: boolean

    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<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>
    • prevState: Readonly<{}>

    Returns any

  • Returns DOMElement<{
        children: any[];
        class: P["className"];
        id: P["id"];
        ref: ((ref) => void);
        style: P["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

  • Parameters

    Returns void