Interface Props

Props for the Button component.

interface Props {
    background?:
        | "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";
    borderColor?: | "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;
    doNotTranslate?: boolean;
    endIcon?: ReactNode;
    height?: string
    | number;
    iconButton?: ReactNode;
    iconPlacement?: "end" | "start";
    isLoading?: boolean;
    onClick: () => void;
    overrideColor?: string;
    startIcon?: ReactNode;
    textColor?:
        | "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";
    textSize?: string
    | number;
    title?: string;
    width?: string | number;
}

Hierarchy

  • ButtonProps
    • Props

Properties

background? borderColor? children? doNotTranslate? endIcon? height? iconButton? iconPlacement? isLoading? onClick overrideColor? startIcon? textColor? textSize? title? width?

Properties

Optionalbackground

background?:
    | "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"

The color of the button. Values can be 'primary' | 'failure' | 'warning' | 'success' | 'lightGray' | 'darkGray' | 'text', or any valid CSS color string (e.g., hex, rgb, etc).

OptionalborderColor

borderColor?:
    | "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"

Optionalchildren

children?: ReactNode

The content of the component.

OptionaldoNotTranslate

doNotTranslate?: boolean

OptionalendIcon

endIcon?: ReactNode

Element placed after the children.

Optionalheight

height?: string | number

The height of the button.

OptionaliconButton

iconButton?: ReactNode

OptionaliconPlacement

iconPlacement?: "end" | "start"

OptionalisLoading

isLoading?: boolean

onClick

onClick: () => void

Function to execute when the button is clicked.

OptionaloverrideColor

overrideColor?: string

OptionalstartIcon

startIcon?: ReactNode

Element placed before the children.

OptionaltextColor

textColor?:
    | "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"

OptionaltextSize

textSize?: string | number

Optionaltitle

title?: string

The text to display on the button.

Optionalwidth

width?: string | number

The width of the button.

Settings

Member Visibility

On This Page

Properties