Class ComponentStypDomFormat

Component's DOM style production format.

Renders CSS styles as text.

This format is generally slower than ComponentStypObjectFormat, but allows to render styles before element is connected to document.

Hierarchy

ComponentStypFormat
- ComponentStypDomFormat

Index

Constructors

constructor

new ComponentStypDomFormat(context: ComponentContext<any>, when?: {
when?: "connected" | "settled";
}): ComponentStypDomFormat
Constructs DOM style production format.
Parameters
- context: ComponentContext<any>
  
  Target component context.
- when: {
  when?: "connected" | "settled";
  } = {}
  
  When to start style rendering. settled by default.
  - Optional Readonly when?: "connected" | "settled"
Returns ComponentStypDomFormat
Overrides ComponentStypFormat.constructor
- Defined in wesib/css/src/component-styp-dom.format.ts:31

Properties

`Readonly` context

context: ComponentContext<any>

Target component context.

`Readonly` when

when: "connected" | "settled"

When to start component style rendering.

One of: settled (the default) - to start rendering when component is settled. connected - to start rendering when component's element is connected to document.

Methods

config

config(config?: ComponentStypFormatConfig & StypDomFormatConfig): StypDomFormatConfig
Builds configuration of DOM style production format.

This method is called by format one.

Returns
Configuration of DOM style production format.
Parameters
- Optional config: ComponentStypFormatConfig & StypDomFormatConfig
  
  Original component style production format configuration.
Returns StypDomFormatConfig
- Defined in wesib/css/src/component-styp-dom.format.ts:56

format

format(config?: ComponentStypFormatConfig & StypDomFormatConfig): StypFormat
Builds CSS style production format to by its config.

This method is called by produce one.

Returns
Component style production format.
Parameters
- Optional config: ComponentStypFormatConfig & StypDomFormatConfig
  
  Component style production format configuration.
Returns StypFormat
Overrides ComponentStypFormat.format
- Defined in wesib/css/src/component-styp-dom.format.ts:43

newProducer

newProducer(rules: Source, config?: ComponentStypFormatConfig): ((this: void) => Supply)
Creates component's CSS stylesheets producer based on the given CSS rules.

Utilizes ComponentStyleProducer.

Returns
CSS rules producer function returning CSS rules supply. Once cut off the produced stylesheets are removed.
Parameters
- rules: Source
  
  A source of CSS rules to produce stylesheets for.
- Optional config: ComponentStypFormatConfig
  
  Style production format configuration.
Returns ((this: void) => Supply)
- - (this: void): Supply
  - Creates component's CSS stylesheets producer based on the given CSS rules.
    
    Utilizes ComponentStyleProducer.
    
    Returns
    CSS rules producer function returning CSS rules supply. Once cut off the produced stylesheets are removed.
    Parameters
    - this: void
    Returns Supply
Inherited from ComponentStypFormat.newProducer
- Defined in wesib/css/src/component-styp-format.ts:151

produce

produce(rules: Source, config?: ComponentStypFormatConfig): Supply
Produces and dynamically updates component's CSS stylesheets based on the given CSS rules.

Utilizes component's producer function.

Returns
CSS rules supply. Once cut off the produced stylesheets are removed.
Parameters
- rules: Source
  
  A source of CSS rules to produce stylesheets for.
- Optional config: ComponentStypFormatConfig
  
  Style production format configuration.
Returns Supply
Inherited from ComponentStypFormat.produce
- Defined in wesib/css/src/component-styp-format.ts:132

renderer

renderer(config: ComponentStypFormatConfig): undefined | StypRenderer | readonly StypRenderer[]
Builds component-specific style renderer.

This renderer applies host selector to generated CSS rules.

This method is called by format one.

Returns
Component style renderer(s).
Parameters
- config: ComponentStypFormatConfig
  
  Component style production format configuration.
Returns undefined | StypRenderer | readonly StypRenderer[]
Inherited from ComponentStypFormat.renderer
- Defined in wesib/css/src/component-styp-format.ts:193

`Static` perContext

perContext(target: Target<ComponentStypFormat, ComponentStypFormat, CxValues>): Definition<ComponentStypFormat>
Parameters
- target: Target<ComponentStypFormat, ComponentStypFormat, CxValues>
Returns Definition<ComponentStypFormat>
Inherited from ComponentStypFormat.perContext
- Defined in wesib/css/src/component-styp-format.ts:107

`Static` toString

toString(): string
Returns string
Inherited from ComponentStypFormat.toString
- Defined in wesib/css/src/component-styp-format.ts:113

Class ComponentStypDomFormat

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

context: ComponentContext<any>

when: { when?: "connected" | "settled"; } = {}

Optional Readonly when?: "connected" | "settled"

Returns ComponentStypDomFormat

Properties

Readonly context

Readonly when

Methods

config

Returns

Parameters

Optional config: ComponentStypFormatConfig & StypDomFormatConfig

Returns StypDomFormatConfig

format

Returns

Parameters

Optional config: ComponentStypFormatConfig & StypDomFormatConfig

Returns StypFormat

newProducer

Returns

Parameters

rules: Source

Optional config: ComponentStypFormatConfig

Returns ((this: void) => Supply)

Returns

Parameters

this: void

Returns Supply

produce

Returns

Parameters

rules: Source

Optional config: ComponentStypFormatConfig

Returns Supply

renderer

Returns

Parameters

config: ComponentStypFormatConfig

Returns undefined | StypRenderer | readonly StypRenderer[]

Static perContext

Parameters

target: Target<ComponentStypFormat, ComponentStypFormat, CxValues>

Returns Definition<ComponentStypFormat>

Static toString

Returns string

Settings

Member Visibility

Theme

when: {
when?: "connected" | "settled";
} = {}

`Optional` `Readonly` when?: "connected" | "settled"

`Readonly` context

`Readonly` when

`Optional` config: ComponentStypFormatConfig & StypDomFormatConfig

`Optional` config: ComponentStypFormatConfig & StypDomFormatConfig

`Optional` config: ComponentStypFormatConfig

`Optional` config: ComponentStypFormatConfig

`Static` perContext

`Static` toString