') + ')', '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('^' + ".*" + ', '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" + ', '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('^' + ".*" + ', '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); } })(); })(); chore(charts): Annotate Victory types for example docs by dlabrecq · Pull Request #5315 · patternfly/patternfly-react · GitHub
Skip to content

chore(charts): Annotate Victory types for example docs - #5315

Merged
ddonahue007 merged 1 commit into
patternfly:masterfrom
dlabrecq:2139-chart-docs
Jan 7, 2021
Merged

chore(charts): Annotate Victory types for example docs#5315
ddonahue007 merged 1 commit into
patternfly:masterfrom
dlabrecq:2139-chart-docs

Conversation

@dlabrecq

@dlabrecqdlabrecq commented Jan 7, 2021•
edited
Loading

Copy link
Copy Markdown
Member

The example docs for react-charts currently show Victory's complex object types. For example, the ChartArea component shows AnimatePropTypeInterface as the animate prop type. However, the Victory docs show the animate type as type: boolean | object.

This change adds @propType annotations in order to replace Victory's complex object types, shown in the example docs, with something more readable.

Fixes#2139

Before
Screen Shot 2021-01-07 at 2 53 49 PM

After
Screen Shot 2021-01-07 at 2 53 13 PM

redallen
redallen previously approved these changes Jan 7, 2021
View reviewed changes
@patternfly-build

patternfly-build commented Jan 7, 2021•
edited
Loading

Copy link
Copy Markdown
Collaborator

PF4 preview: https://patternfly-react-pr-5315.surge.sh
A11y report: https://patternfly-react-pr-5315-a11y.surge.sh

ddonahue007
ddonahue007 approved these changes Jan 7, 2021
View reviewed changes

@ddonahue007ddonahue007 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@ddonahue007
ddonahue007 merged commit 0f738e9 into patternfly:masterJan 7, 2021
@patternfly-build

patternfly-build commented Jan 7, 2021

Copy link
Copy Markdown
Collaborator

Your changes have been released in:

  • @patternfly/react-charts@6.13.1
  • @patternfly/react-docs@5.13.4

Thanks for your contribution! 🎉

@dlabrecq

dlabrecq commented Jan 7, 2021

Copy link
Copy Markdown
MemberAuthor

Thanks!

@dlabrecq
dlabrecq deleted the 2139-chart-docs branch May 13, 2021 16:52
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@redallenredallenredallen approved these changes
@ddonahue007ddonahue007ddonahue007 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Chart docs: annotate types

4 participants

@dlabrecq@patternfly-build@redallen@ddonahue007