Function MockWorkspaceBannerSection

  • Banner sections can have both image and text type metadata in place even though only one type can be active at a time -- a bit annoying to work with.

    Parameters

    • Optionaloverrides: {
          colSpan?: ColSpan;
          id?: string;
          metadata?: {
              backgroundColor?: string;
              backgroundImage?: {
                  slug?: string;
                  type?: ImageSourceType;
              };
              backgroundImageUrl?: string;
              bannerType?: "image" | "solid";
              fontColor?: string;
              fontFamily?: string;
              fontSize?: string;
              fontVariant?: string;
              height?: number;
              logoAlign?: "left" | "right" | "center";
              logoImage?: {
                  slug?: string;
                  type?: ImageSourceType;
              };
              logoImageUrl?: string;
              logoText?: string;
              logoType?: "image" | "none" | "text";
          };
          offset?: number;
          type?: "banner";
      }
      • OptionalcolSpan?: ColSpan
      • Optionalid?: string
      • Optionalmetadata?: {
            backgroundColor?: string;
            backgroundImage?: {
                slug?: string;
                type?: ImageSourceType;
            };
            backgroundImageUrl?: string;
            bannerType?: "image" | "solid";
            fontColor?: string;
            fontFamily?: string;
            fontSize?: string;
            fontVariant?: string;
            height?: number;
            logoAlign?: "left" | "right" | "center";
            logoImage?: {
                slug?: string;
                type?: ImageSourceType;
            };
            logoImageUrl?: string;
            logoText?: string;
            logoType?: "image" | "none" | "text";
        }
        • OptionalbackgroundColor?: string
        • OptionalbackgroundImage?: {
              slug?: string;
              type?: ImageSourceType;
          }
          • Optionalslug?: string
          • Optionaltype?: ImageSourceType
        • OptionalbackgroundImageUrl?: string

          Use backgroundImage object instead. Sections shouldn't store imageUrls directly.

        • OptionalbannerType?: "image" | "solid"
        • OptionalfontColor?: string
        • OptionalfontFamily?: string
        • OptionalfontSize?: string
        • OptionalfontVariant?: string
        • Optionalheight?: number
        • OptionallogoAlign?: "left" | "right" | "center"
        • OptionallogoImage?: {
              slug?: string;
              type?: ImageSourceType;
          }
          • Optionalslug?: string
          • Optionaltype?: ImageSourceType
        • OptionallogoImageUrl?: string

          Use logoImage object instead. Sections shouldn't store imageUrls directly.

        • OptionallogoText?: string
        • OptionallogoType?: "image" | "none" | "text"
      • Optionaloffset?: number
      • Optionaltype?: "banner"

    Returns DeviceApi.BannerSection