title, subtitle #1761
Merged
title, subtitle #1761
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
mbostock
reviewed
Aug 3, 2023
src/plot.js
Outdated
Comment on lines
328
to
336
| for (const e of [[title, "h2"], [subtitle, "h3"], ...legends, svg, [caption, "figcaption"]]) { | ||
| const [contents, tag] = Array.isArray(e) ? e : [e]; | ||
| if (contents == null) continue; | ||
| if (tag && (!contents.ownerDocument || tag === "figcaption")) { | ||
| const c = document.createElement(tag); | ||
| if (tag === "h2" || tag === "h3") c.className = `${className}-${tag}`; | ||
| c.appendChild(contents.ownerDocument ? contents : document.createTextNode(contents)); | ||
| figure.appendChild(c); | ||
| } else figure.appendChild(contents); |
There was a problem hiding this comment.
This feels like it’s written a bit too generically; probably better to just break out the code separately for title, subtitle, legends, svg, and caption.
Note that we could also do figure.append(...legends, svg) for that case.
There was a problem hiding this comment.
I've updated the logic, hopefully it feels more readable/less messy?
mbostock
reviewed
Aug 3, 2023
mbostock
reviewed
Aug 8, 2023
mbostock
requested changes
Aug 8, 2023
|
I've now added documentation, with a custom stylesheet to bypass vitepress margins on h2 and h3. |
Co-authored-by: Mike Bostock <[email protected]>
mbostock
reviewed
Aug 9, 2023
mbostock
approved these changes
Aug 9, 2023
This was referenced Aug 10, 2023
Fil
added a commit
that referenced
this pull request
Aug 21, 2023
* title, subtitle * better JSDoc links (scoped to this PR) * make the figure creation logic more readable (hopefully)
chaichontat
pushed a commit
to chaichontat/plot
that referenced
this pull request
Jan 14, 2024
* title, subtitle * better JSDoc links (scoped to this PR) * make the figure creation logic more readable (hopefully)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add top-level title and subtitle options.
Like caption, these options make a figure element. By default the title is considered text, and set in a H2 element. The subtitle in a H3 element. If an HTML node is passed, it is used as is (this differs from caption, where the contents are always wrapped in a figcaption element).
I'd like to add default styles, but better discuss them here before, because changing the styles will modify all the snapshot tests. And, in that case, maybe add
${className}-figureon the figure element?Default styles could be something like:
Demo: https://observablehq.com/@observablehq/plot-title-1761
closes #92
supersedes #423