Skip to main content

Interface: UseThemeClassesReturn

Defined in: src/theme/useTheme.ts:55

Interface for useThemeClasses hook return type.

Properties​

getBackgroundClass​

getBackgroundClass: (
    variant?:
        | "primary"
        | "secondary"
        | "tertiary"
) => {
    backgroundColor: string;
};

Defined in: src/theme/useTheme.ts:56

Parameters​

variant?​

"primary" | "secondary" | "tertiary"

Returns​

{
    backgroundColor: string;
}
backgroundColor​
backgroundColor: string;

getBorderClass​

getBorderClass: (
    variant?:
        | "primary"
        | "secondary"
        | "focus"
) => {
    borderColor: string;
};

Defined in: src/theme/useTheme.ts:64

Parameters​

variant?​

"primary" | "secondary" | "focus"

Returns​

{
    borderColor: string;
}
borderColor​
borderColor: string;

getColor​

getColor: (path: string) => string;

Defined in: src/theme/useTheme.ts:72

Parameters​

path​

string

Returns​

string

getStatusClass​

getStatusClass: (
    status:
        | "unknown"
        | "degraded"
        | "down"
        | "paused"
        | "pending"
        | "up"
        | "mixed"
) => {
    color: string;
};

Defined in: src/theme/useTheme.ts:73

Parameters​

status​

"unknown" | "degraded" | "down" | "paused" | "pending" | "up" | "mixed"

Returns​

{
    color: string;
}
color​
color: string;

getSurfaceClass​

getSurfaceClass: (
    variant?:
        | "base"
        | "elevated"
        | "overlay"
) => {
    backgroundColor: string;
};

Defined in: src/theme/useTheme.ts:76

Parameters​

variant?​

"base" | "elevated" | "overlay"

Returns​

{
    backgroundColor: string;
}
backgroundColor​
backgroundColor: string;

getTextClass​

getTextClass: (
    variant?:
        | "primary"
        | "secondary"
        | "tertiary"
        | "inverse"
) => {
    color: string;
};

Defined in: src/theme/useTheme.ts:84

Parameters​

variant?​

"primary" | "secondary" | "tertiary" | "inverse"

Returns​

{
    color: string;
}
color​
color: string;