Interface BrandingConfiguration

Hierarchy

  • BrandingConfiguration

Properties

border? color? formFields? loadingHeight? main? primaryButton? secondaryButton? widgetSize?

Properties

Optional border

border?: {
    borderColor?: string;
    borderRadius?: number;
    borderThickness?: number;
}

Defines border styles.

Type declaration

  • Optional borderColor?: string
  • Optional borderRadius?: number
  • Optional borderThickness?: number

Optional color

color?: {
    accentColorShades?: {
        background?: string;
        border?: string;
        icon?: string;
        text?: string;
    };
    backgroundColor?: string;
    critical?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    };
    informative?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    };
    neutral?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
        [k: string]: unknown;
    };
    success?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    };
    textColorShades?: {
        mainText: string;
        subduedText: string;
    };
    warning?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    };
}

Type declaration

  • Optional accentColorShades?: {
        background?: string;
        border?: string;
        icon?: string;
        text?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional icon?: string
    • Optional text?: string
  • Optional backgroundColor?: string
  • Optional critical?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional iconAndBadge?: string
    • Optional text?: string
  • Optional informative?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional iconAndBadge?: string
    • Optional text?: string
  • Optional neutral?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
        [k: string]: unknown;
    }
    • [k: string]: unknown
    • Optional background?: string
    • Optional border?: string
    • Optional iconAndBadge?: string
    • Optional text?: string
  • Optional success?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional iconAndBadge?: string
    • Optional text?: string
  • Optional textColorShades?: {
        mainText: string;
        subduedText: string;
    }
    • mainText: string
    • subduedText: string
  • Optional warning?: {
        background?: string;
        border?: string;
        iconAndBadge?: string;
        text?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional iconAndBadge?: string
    • Optional text?: string

Optional formFields

formFields?: {
    borderRadius?: number;
    disabledBackgroundColor?: string;
    formFieldColor?: {
        background?: string;
        border?: string;
        inputText?: string;
    };
    hoverStateColor?: string;
    selectedStateColor?: string;
}

Defines form field colors.

Type declaration

  • Optional borderRadius?: number
  • Optional disabledBackgroundColor?: string
  • Optional formFieldColor?: {
        background?: string;
        border?: string;
        inputText?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional inputText?: string
  • Optional hoverStateColor?: string
  • Optional selectedStateColor?: string

Optional loadingHeight

loadingHeight?: number

Optional main

main?: {
    brandColor?: string;
    brandFont?: string;
}

Defines all branding related styles.

Type declaration

  • Optional brandColor?: string
  • Optional brandFont?: string

Optional primaryButton

primaryButton?: {
    borderRadius?: number;
    buttonColor?: {
        background?: string;
        border?: string;
        label?: string;
    };
    buttonHoverColor?: {
        background?: string;
        border?: string;
        label?: string;
    };
}

Type declaration

  • Optional borderRadius?: number
  • Optional buttonColor?: {
        background?: string;
        border?: string;
        label?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional label?: string
  • Optional buttonHoverColor?: {
        background?: string;
        border?: string;
        label?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional label?: string

Optional secondaryButton

secondaryButton?: {
    borderRadius?: number;
    buttonColor?: {
        background?: string;
        border?: string;
        label?: string;
    };
    buttonHoverColor?: {
        background?: string;
        border?: string;
        label?: string;
    };
}

Type declaration

  • Optional borderRadius?: number
  • Optional buttonColor?: {
        background?: string;
        border?: string;
        label?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional label?: string
  • Optional buttonHoverColor?: {
        background?: string;
        border?: string;
        label?: string;
    }
    • Optional background?: string
    • Optional border?: string
    • Optional label?: string

Optional widgetSize

widgetSize?: {
    embeddedWidgets?: {
        maxWidth?: {
            unit: "px" | "%";
            value: number;
        };
        minWidth?: {
            unit: "px" | "%";
            value: number;
        };
    };
    popupWidgets?: {
        maxWidth?: {
            unit: "px" | "%";
            value: number;
        };
        minWidth?: {
            unit: "px" | "%";
            value: number;
        };
    };
}

Defines widget dimensions.

Type declaration

  • Optional embeddedWidgets?: {
        maxWidth?: {
            unit: "px" | "%";
            value: number;
        };
        minWidth?: {
            unit: "px" | "%";
            value: number;
        };
    }
    • Optional maxWidth?: {
          unit: "px" | "%";
          value: number;
      }
      • unit: "px" | "%"
      • value: number
    • Optional minWidth?: {
          unit: "px" | "%";
          value: number;
      }
      • unit: "px" | "%"
      • value: number
  • Optional popupWidgets?: {
        maxWidth?: {
            unit: "px" | "%";
            value: number;
        };
        minWidth?: {
            unit: "px" | "%";
            value: number;
        };
    }
    • Optional maxWidth?: {
          unit: "px" | "%";
          value: number;
      }
      • unit: "px" | "%"
      • value: number
    • Optional minWidth?: {
          unit: "px" | "%";
          value: number;
      }
      • unit: "px" | "%"
      • value: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc