@elastic/distillate 0.1.0 → 0.2.0

package/docs/reference/api/emotion.md

@@ -2,24 +2,9 @@
 
 ## Interfaces
 
-### CreateDomSinkOptions [#createdomsinkoptions]
-
-Defined in: [dom\_sink.ts:25](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L25)
-
-Host document and optional flush scheduler for a `<style>` sink.
-
-#### Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| $$$document$$$ `document` | [`DocumentLike`](#documentlike) | The host document where the style element will be appended. | [dom\_sink.ts:27](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L27) |
-| $$$schedule$$$ `schedule?` | (`flush`) => `void` | Defers the flush. Defaults to `queueMicrotask`. | [dom\_sink.ts:29](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L29) |
-
-***
-
 ### CreateEmotionOptions [#createemotionoptions]
 
-Defined in: [emotion.ts:33](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L33)
+Defined in: [emotion.ts:30](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L30)
 
 Shared sink for Emotion compat modules on one registry.
 
@@ -27,50 +12,13 @@ Shared sink for Emotion compat modules on one registry.
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| $$$sink$$$ `sink?` | [`StyleSink`](#stylesink) | Notified when a compat module registers. Shared across `createEmotion` calls on the same registry. | [emotion.ts:35](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L35) |
-
-***
-
-### DocumentLike [#documentlike]
-
-Defined in: [dom\_sink.ts:17](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L17)
-
-Minimal interface for a DOM `Document` able to create and append style tags.
-
-#### Properties
-
-| Property | Modifier | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ | ------ |
-| $$$head$$$ `head` | `readonly` | `object` | Node that receives the created style element. | [dom\_sink.ts:21](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L21) |
-| `head.appendChild` | `public` | `void` | - | [dom\_sink.ts:21](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L21) |
-
-#### Methods
-
-##### createElement() [#createelement]
-
-```ts
-createElement(tagName): StyleElementLike;
-```
-
-Defined in: [dom\_sink.ts:19](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L19)
-
-Creates a `<style>` element.
-
-###### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `tagName` | `"style"` |
-
-###### Returns
-
-[`StyleElementLike`](#styleelementlike)
+| $$$sink$$$ `sink?` | [`StyleSink`](index-1.md#stylesink) | Notified when a compat module registers. Shared across `createEmotion` calls on the same registry. | [emotion.ts:32](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L32) |
 
 ***
 
 ### Emotion [#emotion]
 
-Defined in: [emotion.ts:59](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L59)
+Defined in: [emotion.ts:56](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L56)
 
 Emotion-shaped authoring API bound to one Distillery registry.
 
@@ -82,7 +30,7 @@ Emotion-shaped authoring API bound to one Distillery registry.
 css(strings, ...values): EmotionCss;
 ```
 
-Defined in: [emotion.ts:61](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L61)
+Defined in: [emotion.ts:58](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L58)
 
 Authors styles and returns a handle that can be used directly or passed to `cx`.
 
@@ -103,7 +51,7 @@ Authors styles and returns a handle that can be used directly or passed to `cx`.
 cx(...args): string;
 ```
 
-Defined in: [emotion.ts:63](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L63)
+Defined in: [emotion.ts:60](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L60)
 
 Combines handles, conditional classes, and plain strings into a space-separated string.
 
@@ -123,7 +71,7 @@ Combines handles, conditional classes, and plain strings into a space-separated
 globalModules(): readonly StylesModule<StylesObject>[];
 ```
 
-Defined in: [emotion.ts:72](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L72)
+Defined in: [emotion.ts:69](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L69)
 
 Returns the underlying modules backing `injectGlobal` calls.
 
@@ -137,7 +85,7 @@ readonly [`StylesModule`](index-1.md#stylesmodule)\<[`StylesObject`](index-1.md#
 injectGlobal(strings, ...values): void;
 ```
 
-Defined in: [emotion.ts:65](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L65)
+Defined in: [emotion.ts:62](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L62)
 
 Defines styles that apply globally (e.g. `body`, `html`).
 
@@ -158,7 +106,7 @@ Defines styles that apply globally (e.g. `body`, `html`).
 stylesheet(): string;
 ```
 
-Defined in: [emotion.ts:70](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L70)
+Defined in: [emotion.ts:67](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L67)
 
 Emits the full CSS for all generated emotion styles.
 
@@ -170,7 +118,7 @@ Emits the full CSS for all generated emotion styles.
 
 ### EmotionCss [#emotioncss-1]
 
-Defined in: [emotion.ts:39](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L39)
+Defined in: [emotion.ts:36](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L36)
 
 Style handle that stringifies to its readable class name.
 
@@ -182,13 +130,13 @@ Style handle that stringifies to its readable class name.
 
 | Property | Modifier | Type | Description | Inherited from | Defined in |
 | ------ | ------ | ------ | ------ | ------ | ------ |
-| $$$declarations$$$ `declarations` | `readonly` | [`Declarations`](index-1.md#declarations) | CSS properties for this handle. | [`StyleHandle`](index-1.md#stylehandle).[`declarations`](index-1.md#declarations-1) | [styles/types.ts:117](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L117) |
-| $$$key$$$ `key` | `readonly` | `string` | Full path joined by dots. | [`StyleHandle`](index-1.md#stylehandle).[`key`](index-1.md#key-1) | [styles/types.ts:113](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L113) |
-| $$$kind$$$ `kind` | `readonly` | `"handle"` | Discriminant for [StyleEntry](index-1.md#styleentry). | [`StyleHandle`](index-1.md#stylehandle).[`kind`](index-1.md#kind) | [styles/types.ts:107](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L107) |
-| $$$localname$$$ `localName` | `readonly` | `string` | Leaf key if at root, or composed path for nested handles. | [`StyleHandle`](index-1.md#stylehandle).[`localName`](index-1.md#localname) | [styles/types.ts:111](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L111) |
-| $$$modulename$$$ `moduleName` | `readonly` | `string` | The registered module name this handle belongs to. | [`StyleHandle`](index-1.md#stylehandle).[`moduleName`](index-1.md#modulename) | [styles/types.ts:109](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L109) |
-| $$$readablename$$$ `readableName` | `readonly` | `string` | Predictable name used for output CSS classes. | [`StyleHandle`](index-1.md#stylehandle).[`readableName`](index-1.md#readablename) | [styles/types.ts:115](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L115) |
-| $$$variant$$$ `variant` | `readonly` | `boolean` | `true` when produced inside `variants(...)`. Skipped by [StylesCollector.use](index-1.md#use). | [`StyleHandle`](index-1.md#stylehandle).[`variant`](index-1.md#variant) | [styles/types.ts:119](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L119) |
+| $$$declarations$$$ `declarations` | `readonly` | [`Declarations`](index-1.md#declarations) | CSS properties for this handle. | [`StyleHandle`](index-1.md#stylehandle).[`declarations`](index-1.md#declarations-1) | [styles/types.ts:117](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L117) |
+| $$$key$$$ `key` | `readonly` | `string` | Full path joined by dots. | [`StyleHandle`](index-1.md#stylehandle).[`key`](index-1.md#key-1) | [styles/types.ts:113](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L113) |
+| $$$kind$$$ `kind` | `readonly` | `"handle"` | Discriminant for [StyleEntry](index-1.md#styleentry). | [`StyleHandle`](index-1.md#stylehandle).[`kind`](index-1.md#kind) | [styles/types.ts:107](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L107) |
+| $$$localname$$$ `localName` | `readonly` | `string` | Leaf key if at root, or composed path for nested handles. | [`StyleHandle`](index-1.md#stylehandle).[`localName`](index-1.md#localname) | [styles/types.ts:111](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L111) |
+| $$$modulename$$$ `moduleName` | `readonly` | `string` | The registered module name this handle belongs to. | [`StyleHandle`](index-1.md#stylehandle).[`moduleName`](index-1.md#modulename) | [styles/types.ts:109](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L109) |
+| $$$readablename$$$ `readableName` | `readonly` | `string` | Predictable name used for output CSS classes. | [`StyleHandle`](index-1.md#stylehandle).[`readableName`](index-1.md#readablename) | [styles/types.ts:115](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L115) |
+| $$$variant$$$ `variant` | `readonly` | `boolean` | `true` when produced inside `variants(...)`. Skipped by [StylesCollector.use](index-1.md#use). | [`StyleHandle`](index-1.md#stylehandle).[`variant`](index-1.md#variant) | [styles/types.ts:119](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L119) |
 
 #### Methods
 
@@ -198,7 +146,7 @@ Style handle that stringifies to its readable class name.
 toPrimitive: string;
 ```
 
-Defined in: [emotion.ts:43](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L43)
+Defined in: [emotion.ts:40](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L40)
 
 Template interpolation; same as [EmotionCss.toString](#tostring).
 
@@ -218,7 +166,7 @@ Template interpolation; same as [EmotionCss.toString](#tostring).
 resolveClassName(context): string;
 ```
 
-Defined in: [styles/types.ts:121](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/styles/types.ts#L121)
+Defined in: [styles/types.ts:121](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/styles/types.ts#L121)
 
 Produces the final class name via the provided resolver context.
 
@@ -235,7 +183,7 @@ Produces the final class name via the provided resolver context.
 
 ###### Inherited from
 
-[`StyleHandle`](index-1.md#stylehandle).[`resolveClassName`](index-1.md#resolveclassname)
+[`StyleHandle`](index-1.md#stylehandle).[`resolveClassName`](index-1.md#resolveclassname-1)
 
 ##### toString() [#tostring]
 
@@ -243,7 +191,7 @@ Produces the final class name via the provided resolver context.
 toString(): string;
 ```
 
-Defined in: [emotion.ts:41](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L41)
+Defined in: [emotion.ts:38](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L38)
 
 Stringifies to the readable class name.
 
@@ -251,50 +199,6 @@ Stringifies to the readable class name.
 
 `string`
 
-***
-
-### StyleElementLike [#styleelementlike]
-
-Defined in: [dom\_sink.ts:11](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L11)
-
-Minimal interface for a DOM `<style>` element.
-
-#### Properties
-
-| Property | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ |
-| $$$textcontent$$$ `textContent` | `string` \| `null` | Current stylesheet text, or `null` before the first flush. | [dom\_sink.ts:13](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L13) |
-
-***
-
-### StyleSink [#stylesink]
-
-Defined in: [emotion.ts:27](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L27)
-
-Receives stylesheet invalidation from Emotion compat modules.
-
-#### Methods
-
-##### invalidate() [#invalidate]
-
-```ts
-invalidate(render): void;
-```
-
-Defined in: [emotion.ts:29](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L29)
-
-Marks the sink dirty. `render` produces the current stylesheet when it flushes.
-
-###### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `render` | () => `string` |
-
-###### Returns
-
-`void`
-
 ## Type Aliases
 
 ### ClassNameArg [#classnamearg]
@@ -314,41 +218,19 @@ type ClassNameArg =
 };
 ```
 
-Defined in: [emotion.ts:47](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L47)
+Defined in: [emotion.ts:44](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L44)
 
 One `cx(...)` argument: a class, handle, list, or truthy map.
 
 ## Functions
 
-### createDomSink() [#createdomsink]
-
-```ts
-function createDomSink(__namedParameters): StyleSink;
-```
-
-Defined in: [dom\_sink.ts:35](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/dom_sink.ts#L35)
-
-One managed `<style>` element, rewritten on each flush.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `__namedParameters` | [`CreateDomSinkOptions`](#createdomsinkoptions) |
-
-#### Returns
-
-[`StyleSink`](#stylesink)
-
-***
-
 ### createEmotion() [#createemotion]
 
 ```ts
 function createEmotion<TTokens>(distillery, options?): Emotion;
 ```
 
-Defined in: [emotion.ts:117](https://github.com/elastic/distillate/blob/f131912edadeb90a659ad22ee215412bedb1394d/src/emotion.ts#L117)
+Defined in: [emotion.ts:114](https://github.com/elastic/distillate/blob/d1dccb0eb5372d5984331c21603220340752a304/src/emotion.ts#L114)
 
 `@emotion/css`-shaped API over a distillery.
 
@@ -370,3 +252,39 @@ Defined in: [emotion.ts:117](https://github.com/elastic/distillate/blob/f131912e
 #### Returns
 
 [`Emotion`](#emotion)
+
+## References
+
+### createDomSink [#createdomsink]
+
+Re-exports [createDomSink](index-1.md#createdomsink)
+
+***
+
+### CreateDomSinkOptions [#createdomsinkoptions]
+
+Re-exports [CreateDomSinkOptions](index-1.md#createdomsinkoptions)
+
+***
+
+### DocumentLike [#documentlike]
+
+Re-exports [DocumentLike](index-1.md#documentlike)
+
+***
+
+### StyleElementLike [#styleelementlike]
+
+Re-exports [StyleElementLike](index-1.md#styleelementlike)
+
+***
+
+### StyleParentLike [#styleparentlike]
+
+Re-exports [StyleParentLike](index-1.md#styleparentlike)
+
+***
+
+### StyleSink [#stylesink]
+
+Re-exports [StyleSink](index-1.md#stylesink)