Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Questions:

  •  N/D

Technical Refinement

Description

Today in Sanity’s Hero Component there’s a Reversed option that can be toggled on that enables a background color and changes the texts and buttons to a light color.

  • intl-whitelabel-cms

    • TASK 1–Create new toggle named Background Color

      • path: intl-whitelabel-cms/schemas/components/documents/hero.tsx

        • We will need to add a new toggle option named Background Color

          • The description of the toggle should be updated to “Turn title:Background Color

          • name: backgroundColor

          • description: Turn this on to add and choose a background color for the homepage Hero.

          Image Modified
    • TASK 2–Create dropdown colors

      • path: intl-whitelabel-cms/schemas/components/documents/hero.tsx

        • Use the example:

          • intl-whitelabel-cms/schemas/configuration/pos-configuration/documents/pos-configuration.ts

          • intl-whitelabel-cms/schemas/configuration/pos-configuration/objects/pos-vendor-config-option.ts

        • Create a dropdown to choose the background color with the following options

        • When the Background Color toggle is on it should show:

          • Burger King:

            • BBQ Brown (default) - value: brown

            • Fiery Red - value: red

            • Crunchy Green - value: green

            • Flaming Orange - value: orange

            • Melty Yellow - value: yellow

          • Popeyes:

            • Orange (default) - value: orange

            • Purple - value: purple

          • Firehouse Subs:

            • House Red (default) - value: red

            • House Yellow - value: yellow

        • OBS: the values should be the color names in lowercase, if possible.

    • TASK 3–Create toggle named Split Background

      • path: intl-whitelabel-cms/schemas/components/documents/hero.tsx

        • We will need to add a toggle named Split Background (default is false)

          • The Split Background toggle should have the following description: “Turn this on to split the background color.”

          • By turning the Split Background toggle on the background color area should be reduced

            Image Removed

      TASK 4—Deprecate 3—Deprecate Reversed toggle

      • path: intl-whitelabel-cms/schemas/components/documents/hero.tsx

        • The Reversed toggle should be deprecatedThe Reversed toggle option should be removed from Sanity’s UI

  • ctg-component-library

    • TASK 5—Change 4—Change component hero

      • path: ctg-components-library/src/components/hero/hero.tsx

      • We will add tree new attributes:

        • example:

          Code Block
          languagetypescript
        backgroundHero?: string; isSplit
        • background?:
        boolean;
        •  
        backgroundSplit?:
        • string;
      • After that, we will update the component to support the themes

        • full backgroundsplit background

        • texts and buttons with the same color

        • texts and buttons with different colors

        By turning the Split Background toggle on the background color area should be reduced

        • The Heading and Sub-Heading should be displayed over the colored background

        • The CTAs should be displayed below the colored background area

        • The background color of the bottom portion should not be configurable

      • If the Reversed toggle was on when deprecated it should now point and default to the new Background Color toggle defaulting to the on state in the respective colors:

        • Burger King

          • Brown

        • Popeyes

          • Orange

        • Firehouse Subs

          • Red

  • intl-whitelabel-app

    • TASK 6—Change 5—Change graphql queries and run apollo generate

      • path: intl-whitelabel-app/workspaces/frontend/src/queries/sanity/fragments/hero.graphql

    • TASK 7–Create 6–Create feature flag

    • TASK 8–Create 7—Create color constants (tokens)

    • TASK 9—Create 8—Create configuration to create hero theme

      • Burger King:

        • Brown (default option)

        • Red

        • Green

        • Orange

        • Yellow

      • Popeyes:

        • Orange (default option)

        • Purple

      • Firehouse Subs:

        • Red (default option)

        • Yellow

      • If the Reversed toggle was on when deprecated it should now point and default to the new Background Color toggle defaulting to the on state in the respective colors (create method to validate it):

        • Burger King

          • Brown

        • Popeyes

          • Orange

        • Firehouse Subs

          • Red

Code Block
languagetypescript
export const configTheme = {
  plk: {
    default: 'orange',
    purple: {},
    orange: {
      backgroundHero: theme.token('background-hero-orange'),
      isSplit: false,
      backgroundSplit: theme.token('background-default'),
    },
  },
  bk: {
    brown: {},
    red: {},
    green: {},
    orange: {},
    yellow: {},
  },
  fhs: {
    red: {},
    yellow: {},
  },
};
  • TASK 10—Send
  • TASK 9—Send the theme to hero component

    • path: intl-whitelabel-app/workspaces/frontend/src/components/features/components/hero/hero-container.tsx

    • Use the feature flag here.

    • Update the ctg-component-library version

    • Use the method created to generate the theme by Brand and add on hero component

      Code Block
      languagetypescript
      <Hero
        ...
        backgroundHero={backgroundHero}
        isSplit={true}
        backgroundSplit={backgroundSplit}
      />

Screenshots

  • N/D

POC

  • N/D

Impact Analysis

  • Hero component

Dependencies

  • N/D

Unit Test

  • N/D