External module "src/conditonalsState"

Index

Type aliases

Functions

conditionalState

Type aliases

conditional

conditional: object

One conditional

Type declaration

Optional config?: object
- Optional fields?: object
  - [key: string]: fieldId
- Optional group?: object
  - [key: string]: object
    - [key: string]: object
      - compare: conditionalCompareType
      - field: fieldId
      - parent: string
      - value: string
- name: string
id: conditionalId
type: conditionalType

conditionalCompareType

conditionalCompareType: "is" | "isnot"

How the conditonal does its comparisons

todo: All cases

conditionalId

conditionalId: string

The type of value used for conditional id

conditionalType

conditionalType: "disable" | "enable" | "hide" | "show"

The type of conditional -- what it does

conditionals

conditionals: Array<conditional>

A collection of conditionals

Functions

conditionalState

conditionalState(): object

- Defined in src/conditonalsState.ts:57
Factory function for object to manage state of condtionals in the editor

Returns object
- addConditional: function
  - addConditional(conditional: conditional): boolean
  - - Defined in src/conditonalsState.ts:81
    Add a conditional to the collection
    
    Parameters
    - conditional: conditional
    Returns boolean
- getAllConditionals: function
  - getAllConditionals(): conditionals
  - - Defined in src/conditonalsState.ts:132
    Returns conditionals
- getConditional: function
  - getConditional(conditionalId: conditionalId): conditional | undefined
  - - Defined in src/conditonalsState.ts:125
    Get one conditional from collection
    
    Parameters
    - conditionalId: conditionalId
    Returns conditional | undefined
- removeConditional: function
  - removeConditional(conditionalId: conditionalId): boolean
  - - Defined in src/conditonalsState.ts:93
    Remove a conditional from the collection
    
    Parameters
    - conditionalId: conditionalId
    Returns boolean
- updateConditional: function
  - updateConditional(conditional: conditional): boolean
  - - Defined in src/conditonalsState.ts:108
    Update a conditional in the collection
    
    Parameters
    - conditional: conditional
    Returns boolean

Generated using TypeDoc