Options
All
  • Public
  • Public/Protected
  • All
Menu

ForgeRock JavaScript SDK with UI

Index

Type aliases

CallbackRendererFactory

CallbackRendererFactory: (cb: FRCallback, index: number, step: FRStep, onChange: () => void) => CallbackRenderer | undefined

Represents a callback renderer factory.

param

The callback to render

param

The index position of the callback in the step

param

The step that contains the callback

param

A function to call when the callback value changes

Type declaration

    • (cb: FRCallback, index: number, step: FRStep, onChange: () => void): CallbackRenderer | undefined
    • Parameters

      • cb: FRCallback
      • index: number
      • step: FRStep
      • onChange: () => void
          • (): void
          • Returns void

      Returns CallbackRenderer | undefined

FRAnyStep

FRAnyStep: FRStep | FREndStep

Represents any step type of authentication, including the final step type.

FREndStep

FREndStep: FRLoginSuccess | FRLoginFailure | void

Represents the final step type of authentication, which could be success or failure.

Functions

Const basicStepHandlerFactory

Const expressStepHandlerFactory

renderErrors

  • renderErrors(failedPolicies: PolicyRequirement[], property: string): HTMLUListElement | undefined
  • Returns a UL element containing an LI for each policy failure message.

    Parameters

    • failedPolicies: PolicyRequirement[]

      The policy requirements that failed validation

    • property: string

      The object property name the policy applies to

    Returns HTMLUListElement | undefined