Skip to main content

StateManagerOptions

Overview​

Type: interface

Additional options for StateManager and AsyncStateManager.

Properties​

  • name — The display name. Only used for debugging.
    Type: string
    Required: No — (default value: undefined)
  • clientOnly — This only concerns React for the time being. If set to true, then this State Manager cannot be used for server-side rendering.
    Type: boolean
    Required: No — (default value: false)
  • scope — To be used with useScoped from 'cotton-box-react'.
    Type: StateManager or AsyncStateManager
    Required: No — (default value: undefined)
  • visibility — This only concerns React for the time being. This is used to control whether state values will be exposed in the React Developer Tools.
    Type: StateManagerVisibility
    Required: No — (default value: StateManagerVisibility.ENVIRONMENT)
  • suspense — Suspense React components that consume this State Manager while the State Manager is initializing.
    Type: boolean
    Required: No — (default value: false)