Class ObjectStyle

Index

Constructors

Methods

addChild addClasses assignStyle assignValue clearValue get hasAssignedValue removeClasses setClasses setKey

Constructors

constructor

new ObjectStyle(
    selector: string,
    defaults?: Record<string, any>,
    values?: Record<string, any>,
): ObjectStyle
data class containing the style values for a specific selector
Parameters
- selector: string
- Optionaldefaults: Record<string, any>
- Optionalvalues: Record<string, any>
Returns ObjectStyle

Methods

addChild

addChild(style: ObjectStyle): boolean
register a child style
Parameters
- style: ObjectStyle
Returns boolean

addClasses

addClasses(cls: string | string[]): boolean
add one or more classes
Parameters
- cls: string | string[]
Returns boolean
true if one or more classes were added, false otherwise

assignStyle

assignStyle(
    style: Style,
    parentStyle: string,
    context?: null | string,
): { acquiredColors: string[] }
Parameters
- style: Style
- parentStyle: string
- Optionalcontext: null | string
Returns { acquiredColors: string[] }

assignValue

assignValue(name: string, value: string | number): void
Parameters
- name: string
- value: string | number
Returns void

clearValue

clearValue(name: string): void
Parameters
- name: string
Returns void

get

get(option: string, fallback?: any): any
Parameters
- option: string
- Optionalfallback: any
Returns any

hasAssignedValue

hasAssignedValue(name: string): boolean
Parameters
- name: string
Returns boolean

removeClasses

removeClasses(cls: string | string[]): boolean
remove one or more classes
Parameters
- cls: string | string[]
Returns boolean
true if one or more classes were removed, false otherwise

setClasses

setClasses(cls: string | string[]): boolean
update the object styles class
Parameters
- cls: string | string[]
Returns boolean
true if classes were changed, false otherwise

setKey

setKey(key?: string): boolean
update the object styles key
Parameters
- Optionalkey: string
Returns boolean
true if the key was changed