Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Update R package metadata YAML file for 1.0.2 by rpkyle · Pull Request #147 · plotly/dash-html-components · GitHub
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update R package metadata YAML file for 1.0.2 by rpkyle · Pull Request #147 · plotly/dash-html-components · GitHub
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update R package metadata YAML file for 1.0.2 by rpkyle · Pull Request #147 · plotly/dash-html-components · GitHub
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Update R package metadata YAML file for 1.0.2 by rpkyle · Pull Request #147 · plotly/dash-html-components · GitHub
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Update R package metadata YAML file for 1.0.2 by rpkyle · Pull Request #147 · plotly/dash-html-components · GitHub
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); Update R package metadata YAML file for 1.0.2 by rpkyle · Pull Request #147 · plotly/dash-html-components · GitHub
Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.

Update R package metadata YAML file for 1.0.2 - #147

Merged
rpkyle merged 24 commits into
devfrom
update-r-yaml
Jan 10, 2020
Merged

Update R package metadata YAML file for 1.0.2#147
rpkyle merged 24 commits into
devfrom
update-r-yaml

Conversation

@rpkyle

Copy link
Copy Markdown
Contributor

The YAML data used for populating title/description/examples should be up to date in the dev branch. This PR will backcommit the updates.

@rpkyle

Copy link
Copy Markdown
ContributorAuthor

@Marc-Andre-Rivet Could we merge this if there are no objections?

Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlAcronym(children='Mouse over these words to see the acronym for \'as soon as possible\'.',
title='ASAP')

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

htmlAcronym (and htmlAbbr above) should have their props reversed - children is the short text that's always shown, title is the longer explanation of it. https://www.w3docs.com/learn-html/html-acronym-tag.html

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, will fix this.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in b4e683f

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlCaption("This is an example of htmlCaption.")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in f462bce

Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml Outdated
Comment threaddash-info.yaml
htmlDetails(
children ="Hello"
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlSummary example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 03fabd8

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 344fbfa

Comment threaddash-info.yaml
)
)
)
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use the htmlDt example here too

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in db36bfd

Comment threaddash-info.yaml Outdated

app$layout(htmlDiv(list(
htmlFrameset(children =
htmlIframe(width = "600px", height = "600px",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? I'd think htmlFrameset should just show a deprecation comment like htmlFrame

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 19551a7

Comment threaddash-info.yaml Outdated

app$layout(
htmlDiv(list(
htmlHeader(htmlH1("This is a header")),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a little confusing this is a heading (<h1>) inside a header (<header>)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Literally taken straight from the MDN example 😆:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header

Will remove the heading tag.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's common to put headings in headers, just the way it's shown it makes it look like you're saying the <h1> is the header. Anyway yeah, cleaner for an example to just do htmlHeader("This is a header")

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 64a6b68

rpkyleand others added 2 commits January 9, 2020 17:16
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml Outdated
app$layout(
htmlDiv(list(
htmlIsindex(prompt = 'Search Document..')
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have a deprecation comment

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 3ed2ec5

Co-Authored-By: alexcjohnson <johnson.alex.c@gmail.com>
Comment threaddash-info.yaml
htmlDiv(list(
htmlImg(src = "https://upload.wikimedia.org/wikipedia/commons/0/0c/PIA17351-ApparentSizes-MarsDeimosPhobos-EarthMoon.jpg",
useMap = "#image-map"),
htmlMapEl(list(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this the only one that has a different name from its HTML counterpart (<map>)? we should add a comment about this (and to any others if there are any) so users can find regular HTML documentation about it.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5caaeda

Comment threaddash-info.yaml Outdated
- name: htmlNextid
dontrun: TRUE
code: |
# Warning: The <nextid> tag is obsolete, as of HTML Version 3.2.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then take out the code below, which doesn't use htmlNextid at all?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 5555dff

Comment threaddash-info.yaml Outdated
htmlH2("Warning: A browser without support for JavaScript
will show the text inside the noscript element.
Since Dash uses JavaScript internally,
using this option might cause incompatibility issues."),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I doubt it... probably just wouldn't show up at all. Anyway since it would need js in order to create it, the only reasonable option is to put <noscript> in the index template.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write this example, so I'm not sure. But that makes sense to me.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 46a624c

Comment threaddash-info.yaml
)

app$run_server()
- name: htmlObjectEl

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah this one also has a mutated name...

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 989ac96

Comment threaddash-info.yaml
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
htmlP("Thisverylongstringwithnowhitespaceswon'tlookverygood"),
htmlWbr(),
htmlP("butatleastyoucanspecifya'natural'placeforthestringtobebrokenup")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we not wrap the strings in htmlP, just "longstring", htmlWbr(), "secondpart"? I don't think it does anything as is.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alternative:

app$layout(
htmlDiv(list(
"In a long string, it might be a good idea to add an htmlWbr to specify word breaks",
"Thisverylongstringwithnowhitespaceswon'tlookverygood",
htmlWbr(),
"butatleastyoucanspecifya'natural'placeforthestringtobebrokenup"
)
)
)

yields

In a long string, it might be a good idea to add an htmlWbr to specify word breaksThisverylongstringwithnowhitespaceswon'tlookverygoodbutatleastyoucanspecifya'natural'placeforthestringtobebrokenup

while the original snippet appears to produce

In a long string, it might be a good idea to add an htmlWbr to specify word breaks
Thisverylongstringwithnowhitespaceswon'tlookverygood
butatleastyoucanspecifya'natural'placeforthestringtobebrokenup

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm not worth spending a lot of time on, but if you're already breaking the words into different <p> then what does it matter if you <wbr>? Seems like then it just acts as a <br>. But if I try it in Python using just strings or strings in <span>s:

html.Div([
"a"*100,
"b"*100,
html.Wbr(),
"c"*100,
html.Wbr(),
html.Span("d"*100),
html.Span("e"*100)
])

I get what I expected:
Screen Shot 2020-01-09 at 9 21 09 PM

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, will merge this now but revisit this example later.

Comment threaddash-info.yaml
app$layout(htmlDiv(list(
htmlForm(children=list(
htmlP(children=list('Username: ', dccInput(type='text', id='username', placeholder='username'))),
htmlP(children=list('Password: ', dccInput(type='password', id='password', placeholder='password'))),

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need library(dashCoreComponents) for this example

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in 209a10d

Comment threaddash-info.yaml
code: |
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ideally though I suppose we don't want library(dashCoreComponents) where it's not used... that happens a lot.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and I'm guilty of the same. It was sloppy to not purge those entries from the examples. We can't always live in the ideal world, but it's better to lead by (good) example.

fixed in 137542f

@alexcjohnson

Copy link
Copy Markdown
Collaborator

As discussed on slack, I gave this a more thorough review largely so we can at some point use these code snippets automatically in the dashr.plot.ly docs for the html components.

@alexcjohnsonalexcjohnson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 thanks for the tweaks!

@rpkyle
rpkyle merged commit f879970 into devJan 10, 2020
@rpkyle
rpkyle deleted the update-r-yaml branch January 10, 2020 04:40
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@rpkyle@alexcjohnson@HammadTheOne