Documentation - clarify where `link: true` goes
See original GitHub issueThe JSS docs on observables mentions that one needs to use link: true
, but does not mention where.
For example, given:
this.styles = jss.createStyleSheet(this.css).attach()
It’s not clear which of the following is correct:
this.styles = jss.createStyleSheet(this.css, {link: true}).attach()
this.styles = jss.createStyleSheet(this.css).attach({link: true})
Seems like it’s neither; rather, if you trace .attach
, it looks like it uses this.options.link
, but the expected jss.options
is undefined.
All to say, there’s a gap that needs to be filled about where link: true
goes.
Issue Analytics
- State:
- Created 5 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
Understanding SC 2.4.4:Link Purpose (In Context) (Level A)
A link contains text that gives a description of the information at that URI · A link is preceded by a text description...
Read more >Process documentation: The ultimate how-to with examples
Process documentation is a description of how to execute a process. It works by outlining the exact steps needed to complete a task...
Read more >What is a URL? - Learn web development | MDN
In theory, each valid URL points to a unique resource. Such resources can be an HTML page, a CSS document, an image, etc....
Read more >Technical Documentation in Software Development - AltexSoft
Documentation exists to explain product functionality, unify project-related information, and allow for discussing all significant questions ...
Read more >Bias Detection and Model Explainability - AWS
Detect bias in your data or machine learning (ML) model and explain ML models and predictions using Amazon SageMaker Clarify.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
yeah, I guess docs will never be perfect, thats one every one needs to send fixes like this one 😃
Here it says that observables need the Sheet option
link: true
.Also the options for a Sheet a declared here: https://github.com/cssinjs/jss/blob/master/docs/js-api.md#create-style-sheet
But I think we could add an example with how to use observables.