Skip to content

Commit 5186eec

Browse files
committed
!refactor(renderer): rename render to load and clear to unload
1 parent 72eaa16 commit 5186eec

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

lib/create-theme-renderer.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export const createThemeRenderer = (options = {}) => {
8181
selectorPrefix: validateNamespacePrefix(namespace),
8282
});
8383

84-
const render = () => renderToDom(renderer);
84+
const load = () => renderToDom(renderer);
8585

8686
/**
8787
* Renders global styles
@@ -119,10 +119,10 @@ export const createThemeRenderer = (options = {}) => {
119119
};
120120

121121
return {
122-
clear: renderer.clear,
123-
render,
122+
load,
124123
renderGlobalStyles,
125124
renderStyle,
125+
unload: renderer.clear,
126126
_subscribe: renderer.subscribe,
127127
};
128128
};

readme.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,10 @@ const renderer = createThemeRenderer({
204204
});
205205
```
206206

207-
Initialize the theme renderer in a single entry point in your code to render CSS to the DOM.
207+
Initialize and load the theme renderer in a single entry point in your code to render CSS to the DOM.
208208

209209
```js
210-
renderer.render();
210+
renderer.load();
211211
```
212212

213213
### Render themed styles
@@ -375,7 +375,7 @@ const renderer = createThemeRenderer({
375375
themeSpec,
376376
});
377377

378-
renderer.render();
378+
renderer.load();
379379

380380
const style1 = {
381381
color: 'brand.primary';
@@ -423,7 +423,7 @@ const renderer = createThemeRenderer({
423423
themeSpec,
424424
});
425425

426-
renderer.render();
426+
renderer.load();
427427

428428
const globalStyles = {...}; // your other global styles
429429

@@ -768,10 +768,10 @@ See *theme spec* defined in [§ Glossary](#glossary).
768768

769769
Returns a *theme renderer* with methods to resolve and render *themed styles* to the DOM.
770770

771-
- `renderer.clear()`: Clears and removes all rendered CSS.
772-
- `renderer.render()`: Initializes the renderer.
771+
- `renderer.load()`: Initializes and loads the renderer.
773772
- `renderer.renderStyle(style, props?)`: Resolves and renders the provided *style object* or *style rule*). Accepts optional *style props*.
774773
- `renderer.renderGlobalStyles(style)`: Resolves and renders the provided *global styles* object.
774+
- `renderer.unload()`: Unloads and removes all rendered CSS.
775775

776776
<details>
777777
<summary>Example</summary>
@@ -799,7 +799,7 @@ const renderer = createThemeRenderer({
799799
Initialize the renderer in a single entry point in your code with:
800800

801801
```js
802-
renderer.render();
802+
renderer.load();
803803
```
804804

805805
Render *global styles* with:
@@ -833,10 +833,10 @@ renderer.renderStyle(styleObject);
833833
renderer.renderStyle(styleRule, {isPadded: true});
834834
```
835835

836-
Clear all rendered styles with:
836+
Unload and clear all rendered styles with:
837837

838838
```js
839-
renderer.clear();
839+
renderer.unload();
840840
```
841841
</details>
842842

@@ -870,7 +870,7 @@ const renderer = createThemeRenderer({
870870
themeSpec,
871871
});
872872

873-
renderer.render();
873+
renderer.load();
874874
```
875875

876876
</details>

test/create-theme-renderer.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import {createThemeRenderer} from '../index.js';
55
import {resolveRenderGlobalStyles, resolveRenderStyle} from './util.js';
66

77
test('createThemeRenderer', async (t) => {
8-
await t.test('renderer.render', (t) => {
8+
await t.test('renderer.load', (t) => {
99
/** Untested assertion rendering to DOM via fela-dom (v11) */
1010
t.test('should run the render method', () => {
1111
const renderer = createThemeRenderer();
12-
assert.throws(() => renderer.render());
12+
assert.throws(() => renderer.load());
1313
});
1414
});
1515

0 commit comments

Comments
 (0)