Hex Core JS
    Preparing search index...

    Type Alias ButtonWithConfirmationProps

    ButtonWithConfirmationProps: {
        buttonClassName?: string;
        buttonStyle?: React.CSSProperties;
        cancelButtonProps?: Partial<ConfigurableConfirmationButtonProps>;
        confirmationContent: React.ReactNode;
        confirmationDisplay?: "popup" | "modal" | "dynamic";
        confirmButtonProps?: Partial<ConfigurableConfirmationButtonProps>;
        horizontalAlign?: "any" | "left" | "center" | "right";
        noConfirm?: boolean;
        verticalAlign?: "any" | "top" | "center" | "bottom";
    } & ButtonProps

    Type Declaration

    • OptionalbuttonClassName?: string

      CSS class to pass to the button.

    • OptionalbuttonStyle?: React.CSSProperties

      CSS styles to pass to the button.

    • OptionalcancelButtonProps?: Partial<ConfigurableConfirmationButtonProps>

      Props to pass to the cancel button. Defaults are taken from the ButtonProps passed to the <ButtonWithConfirmation>.

    • confirmationContent: React.ReactNode

      Content to render when showing the confirmation pop-up. Should ask whether the user is sure they want to take this action or explain the implications of taking this action.

    • OptionalconfirmationDisplay?: "popup" | "modal" | "dynamic"

      Determines how the confirmation is displayed. The "popup" option displays as a small popup/tooltip-like box over the base button. The "modal" option displays as a modal. The "dynamic" option uses a mix of the two other options depending on the user's screen size (using modal on smaller screens).

    • OptionalconfirmButtonProps?: Partial<ConfigurableConfirmationButtonProps>

      Props to pass to the confirm button. Defaults are taken from the ButtonProps passed to the <ButtonWithConfirmation>.

    • OptionalhorizontalAlign?: "any" | "left" | "center" | "right"

      Horizontal alignment of the confirmation box.

    • OptionalnoConfirm?: boolean

      Bypass confirmation

    • OptionalverticalAlign?: "any" | "top" | "center" | "bottom"

      Vertical alignment of the confirmation box.