Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMutable<Context>

Type parameters

  • Context

Hierarchy

  • IMutable

Index

Properties

Methods

Properties

Optional Action

Action: ReferencedTypedComponent<Action, ViewStyle, TextStyle, Context>

An optional action component that can be provided, and will be rendered when the icon is tapped

param

the reference function for the element

param

the styles that can be applied to the top level view that are usually applied to the default input container

param

coloured text styles that are applied to the default text input field

Icon

Icon: Component<IButtonState>

The icon that is rendered for the user to tap on to start the action

param

the state of the async button that the icon is put into

Optional context

context: Context

A context object that can be passed as the second argument to the action function

provides

provides: ReadonlySet<InputType>

Specifies which types of input this action can provide. This is used to determine which actions to show when the required input type has been set on the input component.

type

type: string

The type of the action. Must be unique for this action instance. Only one action of each type is allowed to be added to the input component

Methods

action

  • action(component: Action | undefined, context: Context): Promise<IInputImmutable | void>
  • Performs the actual action.

    Parameters

    • component: Action | undefined

      the rendered Action component, if it was provided

    • context: Context

      the action context that references the context property on this interface

    Returns Promise<IInputImmutable | void>

    optionally, any user input that was created