Class StyleProvider<T, R>

Construct your own style provider with a custom fallback style object

Type parameters

T: __type
R

Hierarchy

StyleProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StyleProvider(fallback: T, converter?: undefined | function, options?: StyleProviderOptions): StyleProvider

- Defined in StyleProvider.ts:40
Parameters
- fallback: T
- Optional converter: undefined | function
- Default value options: StyleProviderOptions = {}
Returns StyleProvider

Properties

Private converter

converter: function

Type declaration

- (css: string): R
- Parameters
  - css: string
  Returns R

Private fallback

fallback: T

Private mount

mount: string

Private renderAll

renderAll: boolean

Private rendered

rendered: Map<DeepPartial<T>, R> = new Map()

Private renderedAll

renderedAll: Map<DeepPartial<T>, R> = new Map()

Private Optional renderedFallback

renderedFallback: RenderResult

Methods

Private dashCase

dashCase(s: string): string

- Defined in StyleProvider.ts:142
Convert PascalCase / camelCase to dash-case

Parameters
- s: string
Returns string

Private fields

fields(fallback: string[], custom: string[]): string

- Defined in StyleProvider.ts:93
Convert two arrays of fields to a final field resolver CSS string

Parameters
- fallback: string[]
- custom: string[]
Returns string

Private generate

generate(styles: DeepPartial<T>, renderAll: boolean): R

- Defined in StyleProvider.ts:72
Generate a CSS string from a styles object

Parameters
- styles: DeepPartial<T>
- renderAll: boolean
Returns R

Private parser

parser<S>(styles: S, type: StyleObjectType, prefix?: undefined | string): ParserResult

- Defined in StyleProvider.ts:114
Return an array of CSS vars and a list of created vars from a styles object

Type parameters
- S: __type
Parameters
- styles: S
- type: StyleObjectType
- Optional prefix: undefined | string
Returns ParserResult

Private render

render(styles: DeepPartial<T>, type: StyleObjectType): RenderResult

- Defined in StyleProvider.ts:102
Return a string of CSS vars and a list of created vars from a styles object

Parameters
- styles: DeepPartial<T>
- type: StyleObjectType
Returns RenderResult

rootStyleProvider

rootStyleProvider(styles?: DeepPartial<T>): R

- Defined in StyleProvider.ts:52
Generate the root CSS string from a styles object if no cached version is found

Parameters
- Optional styles: DeepPartial<T>
Returns R

styleProvider

styleProvider(styles?: DeepPartial<T>, renderAll?: boolean): R

- Defined in StyleProvider.ts:59
Generate a CSS string from a styles object if no cached version is found

Parameters
- Default value styles: DeepPartial<T> = emptyStyles
- Default value renderAll: boolean = this.renderAll
Returns R

Generated using TypeDoc