Interface SmartStickyPopperProps

Props accepted by the SmartStickyPopper component.

interface SmartStickyPopperProps {
    anchorEl: null | HTMLElement;
    autoResizeOnScroll?: boolean;
    backgroundColor?:
        | "primary"
        | "blue5"
        | "white"
        | "textFaded"
        | "navigation"
        | "navigationTop"
        | "navigationSide"
        | "background"
        | "drawer"
        | "cards"
        | "cardDivider"
        | "cardSectionSeparator"
        | "fieldsOnCard"
        | "fieldsFloating"
        | "buttonSecondary"
        | "iconsDisabled"
        | "red"
        | "orange"
        | "greenDark"
        | "greenLight"
        | "text"
        | "redDark"
        | "orangeDark"
        | "greenDark2"
        | "blueDark"
        | "lineColor"
        | "iconButtonBg";
    borderTopColor?: | "primary"
    | "blue5"
    | "white"
    | "textFaded"
    | "navigation"
    | "navigationTop"
    | "navigationSide"
    | "background"
    | "drawer"
    | "cards"
    | "cardDivider"
    | "cardSectionSeparator"
    | "fieldsOnCard"
    | "fieldsFloating"
    | "buttonSecondary"
    | "iconsDisabled"
    | "red"
    | "orange"
    | "greenDark"
    | "greenLight"
    | "text"
    | "redDark"
    | "orangeDark"
    | "greenDark2"
    | "blueDark"
    | "lineColor"
    | "iconButtonBg";
    children: ReactNode;
    color?: | "primary"
    | "blue5"
    | "white"
    | "textFaded"
    | "navigation"
    | "navigationTop"
    | "navigationSide"
    | "background"
    | "drawer"
    | "cards"
    | "cardDivider"
    | "cardSectionSeparator"
    | "fieldsOnCard"
    | "fieldsFloating"
    | "buttonSecondary"
    | "iconsDisabled"
    | "red"
    | "orange"
    | "greenDark"
    | "greenLight"
    | "text"
    | "redDark"
    | "orangeDark"
    | "greenDark2"
    | "blueDark"
    | "lineColor"
    | "iconButtonBg";
    fullWidth?: boolean;
    noHeader?: boolean;
    onClose: () => void;
    open: boolean;
    sx?: SxProps<Theme>;
    targetMainScrollId?: string;
    title?: string;
    top?: number;
    width?: string | number;
}

Hierarchy

  • PopperProps
    • SmartStickyPopperProps

Properties

anchorEl autoResizeOnScroll? backgroundColor? borderTopColor? children color? fullWidth? noHeader? onClose open sx? targetMainScrollId? title? top? width?

Properties

anchorEl

anchorEl: null | HTMLElement

The anchor element for the popper.

OptionalautoResizeOnScroll

autoResizeOnScroll?: boolean

Whether to dynamically calculate and resize height on scroll.

OptionalbackgroundColor

backgroundColor?:
    | "primary"
    | "blue5"
    | "white"
    | "textFaded"
    | "navigation"
    | "navigationTop"
    | "navigationSide"
    | "background"
    | "drawer"
    | "cards"
    | "cardDivider"
    | "cardSectionSeparator"
    | "fieldsOnCard"
    | "fieldsFloating"
    | "buttonSecondary"
    | "iconsDisabled"
    | "red"
    | "orange"
    | "greenDark"
    | "greenLight"
    | "text"
    | "redDark"
    | "orangeDark"
    | "greenDark2"
    | "blueDark"
    | "lineColor"
    | "iconButtonBg"

Background theme color token.

OptionalborderTopColor

borderTopColor?:
    | "primary"
    | "blue5"
    | "white"
    | "textFaded"
    | "navigation"
    | "navigationTop"
    | "navigationSide"
    | "background"
    | "drawer"
    | "cards"
    | "cardDivider"
    | "cardSectionSeparator"
    | "fieldsOnCard"
    | "fieldsFloating"
    | "buttonSecondary"
    | "iconsDisabled"
    | "red"
    | "orange"
    | "greenDark"
    | "greenLight"
    | "text"
    | "redDark"
    | "orangeDark"
    | "greenDark2"
    | "blueDark"
    | "lineColor"
    | "iconButtonBg"

Custom top border color.

children

children: ReactNode

Children to render inside the popper content.

Optionalcolor

color?:
    | "primary"
    | "blue5"
    | "white"
    | "textFaded"
    | "navigation"
    | "navigationTop"
    | "navigationSide"
    | "background"
    | "drawer"
    | "cards"
    | "cardDivider"
    | "cardSectionSeparator"
    | "fieldsOnCard"
    | "fieldsFloating"
    | "buttonSecondary"
    | "iconsDisabled"
    | "red"
    | "orange"
    | "greenDark"
    | "greenLight"
    | "text"
    | "redDark"
    | "orangeDark"
    | "greenDark2"
    | "blueDark"
    | "lineColor"
    | "iconButtonBg"

Text color theme token.

OptionalfullWidth

fullWidth?: boolean

Whether to take full width of the screen.

OptionalnoHeader

noHeader?: boolean

Whether to hide the header section.

onClose

onClose: () => void

Function to be called on close.

open

open: boolean

Whether the popper is open.

Optionalsx

sx?: SxProps<Theme>

MUI system-style prop for custom styles.

OptionaltargetMainScrollId

targetMainScrollId?: string

Optional scroll container ID for listening to scroll events.

Optionaltitle

title?: string

Title to show in the sticky header.

Optionaltop

top?: number

Offset from the top when docked.

Optionalwidth

width?: string | number

Custom width for the popper.

Settings

Member Visibility

On This Page

Properties