Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pass cardOptions to custom renderers #35

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+93 −6
Open

Pass cardOptions to custom renderers #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ var renderer = new MobiledocDOMRenderer({
sectionElementRenderer: {
P: function(_, dom) { return dom.createElement('span'); },
H1: function(_, dom) { return dom.createElement('h2'); },
H2: function(tagName, dom) {
H2: function(tagName, dom, cardOptions) {
var element = dom.createElement(tagName);
element.setAttribute('class', 'subheadline');
return element;
Expand All @@ -114,7 +114,7 @@ a section's content.
var renderer = new MobiledocDOMRenderer({
markupElementRenderer: {
B: function(_, dom) { return dom.createElement('strong'); },
A: function(tagName, dom, attrs={}) {
A: function(tagName, dom, attrs={}, cardOptions) {
let element = dom.createElement(tagName);

for (let attr in attrs) {
Expand Down
4 changes: 2 additions & 2 deletions lib/renderers/0-2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export default class Renderer {
let lowerCaseTagName = tagName.toLowerCase();
if (this.markupElementRenderer[lowerCaseTagName]) {
let attrObj = attrs.reduce(kvReduce, {});
let openedElement = this.markupElementRenderer[lowerCaseTagName](tagName, this.dom, attrObj);
let openedElement = this.markupElementRenderer[lowerCaseTagName](tagName, this.dom, attrObj, this.cardOptions);
pushElement(openedElement);
} else {
let openedElement = createElementFromMarkerType(this.dom, markerType);
Expand Down Expand Up @@ -274,7 +274,7 @@ export default class Renderer {
let element;
let lowerCaseTagName = tagName.toLowerCase();
if (this.sectionElementRenderer[lowerCaseTagName]) {
element = this.sectionElementRenderer[lowerCaseTagName](tagName, this.dom);
element = this.sectionElementRenderer[lowerCaseTagName](tagName, this.dom, this.cardOptions);
} else if (isMarkupSectionElementName(tagName)) {
element = this.dom.createElement(tagName);
} else {
Expand Down
4 changes: 2 additions & 2 deletions lib/renderers/0-3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export default class Renderer {
let lowerCaseTagName = tagName.toLowerCase();
if (this.markupElementRenderer[lowerCaseTagName]) {
let attrObj = attrs.reduce(kvReduce, {});
let openedElement = this.markupElementRenderer[lowerCaseTagName](tagName, this.dom, attrObj);
let openedElement = this.markupElementRenderer[lowerCaseTagName](tagName, this.dom, attrObj, this.cardOptions);
pushElement(openedElement);
} else {
let openedElement = createElementFromMarkerType(this.dom, markerType);
Expand Down Expand Up @@ -378,7 +378,7 @@ export default class Renderer {
let element;
let lowerCaseTagName = tagName.toLowerCase();
if (this.sectionElementRenderer[lowerCaseTagName]) {
element = this.sectionElementRenderer[lowerCaseTagName](tagName, this.dom);
element = this.sectionElementRenderer[lowerCaseTagName](tagName, this.dom, this.cardOptions);
} else if (isMarkupSectionElementName(tagName)) {
element = this.dom.createElement(tagName);
} else {
Expand Down
44 changes: 44 additions & 0 deletions tests/unit/renderers/0-2-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,6 +614,50 @@ test('renders a mobiledoc with markupElementRenderer', (assert) => {
'renders text nodes as proper type');
});

test('passes cardOptions to markupElementRenderer and sectionElementRenderer', (assert) => {
let passedSectionCardOptions, passedMarkupCardOptions;
let cardOptions = {};

let mobiledoc = {
"version": MOBILEDOC_VERSION,
"sections": [
[
["A", [ "href", "#foo" ]]
],
[
[MARKUP_SECTION_TYPE, "p", [
[[], 0, "Lorem ipsum "],
[[0], 1, "dolor"],
[[], 0, " sit amet."]]
]
]
]
};
renderer = new Renderer({
cardOptions,
markupElementRenderer: {
A: (tagName, dom, attrs, cardOptions) => {
passedMarkupCardOptions = cardOptions;
return dom.createElement('a');
}
},
sectionElementRenderer: {
P: (tagName, dom, cardOptions) => {
passedSectionCardOptions = cardOptions;
return dom.createElement('p');
}
}
});

renderer.render(mobiledoc);

assert.ok(!!passedSectionCardOptions, 'passes cardOptions to sectionElementRenderer');
assert.ok(!!passedMarkupCardOptions, 'passes cardOptions to markupElementRenderer');
assert.deepEqual(passedSectionCardOptions, cardOptions);
assert.deepEqual(passedMarkupCardOptions, cardOptions);
});


test('unexpected markup types are not passed to markup renderer', (assert) => {
let mobiledoc = {
version: MOBILEDOC_VERSION,
Expand Down
43 changes: 43 additions & 0 deletions tests/unit/renderers/0-3-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,6 +804,49 @@ test('renders a mobiledoc with markupElementRenderer', (assert) => {
'renders text nodes as proper type');
});

test('passes cardOptions to markupElementRenderer and sectionElementRenderer', (assert) => {
let passedSectionCardOptions, passedMarkupCardOptions;
let cardOptions = {};

let mobiledoc = {
"version": MOBILEDOC_VERSION,
"atoms": [],
"cards": [],
"markups": [
["a", [ "href", "#foo" ]]
],
"sections": [
[MARKUP_SECTION_TYPE, "p", [
[MARKUP_MARKER_TYPE, [], 0, "Lorem ipsum "],
[MARKUP_MARKER_TYPE, [0], 1, "dolor"],
[MARKUP_MARKER_TYPE, [], 0, " sit amet."]]
]
]
};
renderer = new Renderer({
cardOptions,
markupElementRenderer: {
A: (tagName, dom, attrs, cardOptions) => {
passedMarkupCardOptions = cardOptions;
return dom.createElement('a');
}
},
sectionElementRenderer: {
P: (tagName, dom, cardOptions) => {
passedSectionCardOptions = cardOptions;
return dom.createElement('p');
}
}
});

renderer.render(mobiledoc);

assert.ok(!!passedSectionCardOptions, 'passes cardOptions to sectionElementRenderer');
assert.ok(!!passedMarkupCardOptions, 'passes cardOptions to markupElementRenderer');
assert.deepEqual(passedSectionCardOptions, cardOptions);
assert.deepEqual(passedMarkupCardOptions, cardOptions);
});

test('unexpected markup types are not handled by markup renderer', (assert) => {
let mobiledoc = {
version: MOBILEDOC_VERSION,
Expand Down