rofrischmann/fela

View on GitHub
docs/API.md

Summary

Maintainability
Test Coverage
# API Reference

Last but not least this chapter ships the API reference in detail. Despite explaining every single method its arguments and return value, you will also find some tips on some pages.

## Top-Level API
### fela
* [`createRenderer([config])`](api/fela/createRenderer.md)
* [`combineRules(...rules)`](api/fela/combineRules.md)
* [`enhance(...enhancers)`](api/fela/enhance.md)

#### [Renderer API](api/fela/Renderer.md)
* [`.renderRule(rule, [props])`](api/fela/Renderer.md#renderrulerule--props)
* [`.renderKeyframe(keyframe, [props])`](api/fela/Renderer.md#renderkeyframe--props)
* [`.renderFont(family, files, [properties])`](api/fela/Renderer.md#renderfontfamily-files--properties)
* [`.renderStatic(style, [selector])`](api/fela/Renderer.md#renderstaticstyle--selector)
* [`.subscribe(listener)`](api/fela/Renderer.md#subscribelistener)
* [`.clear()`](api/fela/Renderer.md#clear)

---

### fela-dom
* [`render(renderer)`](api/fela-dom/render.md)
* [`rehydrate(renderer)`](api/fela-dom/rehydrate.md)
* [`renderToMarkup(renderer)`](api/fela-dom/renderToMarkup.md)
* [`renderToSheetList(renderer)`](api/fela-dom/renderToSheetList.md)

---

### fela-native
* [`createRenderer([config])`](api/fela-native/createRenderer.md)

#### [Renderer API](api/fela-native/Renderer.md)
* [`.renderRule(rule, [props])`](api/fela-native/Renderer.md#renderrulerule--props)
* [`.subscribe(listener)`](api/fela-native/Renderer.md#subscribelistener)
* [`.clear()`](api/fela-native/Renderer.md#clear)

---

### Bindings
The bindings documentation covers all React-like APIs that are officially shipped with Fela.
This includes React, Preact and Inferno.

* [`connect(rules)`](api/bindings/connect.md)
* [`createComponent(rule, [type], [passThroughProps])`](api/bindings/createComponent.md)
* [`createComponentWithProxy(rule, [type], [passThroughProps])`](api/bindings/createComponentWithProxy.md)
* [`fe(type, [props], [children])`](api/bindings/fe.md)
* [`<FelaComponent style>`](api/bindings/FelaComponent.md)
* [`<FelaRenderer>`](api/bindings/FelaComponent.md)
* [`<FelaTheme>`](api/bindings/FelaTheme.md)
* [`<Provider renderer>`](api/bindings/Provider.md)
* [`RendererContext`](api/bindings/RendererContext.md)
* [`<ThemeProvider theme [overwrite]>`](api/bindings/ThemeProvider.md)
* [`ThemeContext`](api/bindings/ThemeContext.md)
* [`useFela(props)`](api/bindings/useFela.md)
* [`withTheme(component)`](api/bindings/withTheme.md)

---

### Jest Bindings
* [`createSnapshot(component, [theme], [renderer], [Provider], [ThemeProvider])`](api/jest-bindings/createSnapshot.md)