Overview
Border
Table of contents
- ColorValue (interface)
- EProps (interface)
- Props (interface)
- Color Property
- SProps (interface)
- BorderColor (type alias)
- Color (type alias)
- ColorObject (type alias)
- OriginColor (type alias)
- Rule (type alias)
- TextColor (type alias)
- ruleModule (constant)
- getColorValue (function)
- getDefaultColorTextValue (function)
- getTextColor (function)
- getTextColorValue (function)
ColorValue (interface)
Signature
interface ColorValue {
inverted?: boolean
level?: Level
name?: Color
opacity?: Opacity
}
Added in v0.2.0
EProps (interface)
Signature
interface EProps {}
Added in v0.2.0
Props (interface)
Color Property
The define text color,background color and border color.
The color value be define in theme.
Jss color={value} | backgroundColor={value} | borderColor={value} |
mkColor define text color and background color.
Signature
interface Props extends EProps, SProps {}
Added in v0.2.0
SProps (interface)
Signature
interface SProps {
/**
*background color
*/
mkBgColor?: ColorObject
/**
*border color
*/
mkBorderColor?: ColorObject
/**
*background color with auto text color
*/
mkColor?: ColorObject
/**
*opacity
*/
mkOpacity?: Opacity
/**
*text color
*/
mkTextColor?: ColorObject
}
Added in v0.2.0
BorderColor (type alias)
Signature
export type BorderColor = Color
Added in v0.2.0
Color (type alias)
Signature
export type Color = ColorNames | OriginColor
Added in v0.2.0
ColorObject (type alias)
Signature
export type ColorObject = Color | ColorValue
Added in v0.2.0
OriginColor (type alias)
Signature
export type OriginColor = 'inherit' | 'currentColor' | 'transparent'
Added in v0.2.0
Rule (type alias)
Signature
export type Rule = ExtendRule<ParentRule, SProps, EProps, Theme>
Added in v0.2.0
TextColor (type alias)
Signature
export type TextColor = Color
Added in v0.2.0
ruleModule (constant)
Signature
export const ruleModule: any = ...
Added in v0.2.0
getColorValue (function)
Signature
export const getColorValue = ({ theme, source }: { theme: Theme, source?: any }) => ...
Added in v0.2.0
getDefaultColorTextValue (function)
Signature
export const getDefaultColorTextValue = ({ value, source }: { value: ColorObject, source?: any }): {
name: Color,
level: Level,
inverted: boolean,
opacity: Opacity
} => ...
Added in v0.2.0
getTextColor (function)
Signature
export const getTextColor = ({ source }: { source?: any }) => ...
Added in v0.2.0
getTextColorValue (function)
Signature
export const getTextColorValue = ({ theme, source }: { theme: Theme, source?: any }) => ...
Added in v0.2.0