Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "styling"

Index

Functions

Const getClasses

  • getClasses(parentId: string, id: string, type: string, flowKey: string): string[]
  • Get an array of class names that were previously registered. Also includes classes from the classes attribute

    Parameters

    • parentId: string

      Id of the parent container

    • id: string

      Id of the target component, container or outcome

    • type: string

      Adds a default class of this type prefixed with mw- .e.g mw-input for an input type

    • flowKey: string

    Returns string[]

Const registerComponent

  • registerComponent(componentType: string, classes: string | string[] | Function): void
  • Register class names for a specific component type, these are returned from getClasses

    Parameters

    • componentType: string

      Type name of the component as it appears in the metadata e.g. input

    • classes: string | string[] | Function

      Class names to include with this component type

    Returns void

Const registerContainer

  • registerContainer(containerType: string, classes: string | string[] | Function): void
  • Register class names for a specific container type, these are returned from getClasses

    Parameters

    • containerType: string

      Type name of the container as it appears in the metadata e.g. VERTICAL_FLOW

    • classes: string | string[] | Function

      Class names to include with this container type

    Returns void

Generated using TypeDoc