Comments (2)
Hi @drewpc!
This is how react-headings used to be, in version 2.x
. And unfortunately, this solution came with its downsides...
- It was very easy to miss a heading, and therefore break the hierarchy:
<Section>
<Section>
<H>This is a hx+1</H> {/* problem: we skipped hx */}
</Section>
</Section>
- Headings could also easily be inserted after their sub-headings, again breaking the hierarchy:
<Section>
<Section>
<H>My hx+1</H>
</Section>
<H>My hx</H> {/* problem: hx comes after hx+1 */}
</Section>
Those are the ones that come to mind right now.
While seemingly trivial, the lack of structure and guarantees created confusion for some, myself included.
Although react-headings 3 is not perfect, it helped mitigate those issues. Do you know how we could make the API more readable while avoiding the problems mentioned?
from react-headings.
Oh great! Those are issues I hadn't considered previously. In my tests, the second issue worked fine as is--a header coming after a section rendered with the proper level. The first issue required a bit of rethinking, but I was able to make it work with a state variable that tracks whether or not an H tag was used in a section.
I'll run it through some tests and submit a PR later today.
from react-headings.
Related Issues (2)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from react-headings.