Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add StackBlitz edit button for examples #37233

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Docs: Add StackBlitz edit button for examples #37233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5267ef5
Add StackBlitz edit button for examples
julien-deramond Oct 1, 2022
318bbcb
Merge branch 'main' into main-jd-stackblitz-for-examples
julien-deramond Nov 17, 2022
10317a7
Fix a11y of 'Try it' buttons
julien-deramond Nov 17, 2022
5aaa09d
Merge branch 'main' into main-jd-stackblitz-for-examples
julien-deramond Dec 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions site/content/docs/5.2/examples/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ aliases: "/examples/"
loading="lazy">
<h3 class="h5 mb-1">{{ $example.name }}</h3>
</a>
<button type="button" class="btn-edit text-nowrap float-end" title="Try it on StackBlitz" style="margin-top: -30px" data-sb-js-snippet="{{ $example.name | urlize }}">
<svg class="bi" aria-hidden="true"><use xlink:href="#lightning-charge-fill"/></svg>
</button>
<p class="text-muted">{{ $example.description }}</p>
</div>
{{ if (eq (add $i 1) $len) }}</div>{{ end }}
Expand Down
101 changes: 101 additions & 0 deletions site/layouts/partials/scripts.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
<script src="https://cdn.jsdelivr.net/npm/@stackblitz/sdk@1/bundles/sdk.umd.js"></script>
{{- end }}

{{ if eq .Page.Layout "single" -}}
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this duplicated in another layout file?

If so, we should deduplicate common code because it's a significant amount of it. Ideally, the inline JS should go into external JS files, but it won't be easy if we need Hugo to process them.

So, at least deduplicating common StackBlitz layout code this would be an improvement.

<script src="https://cdn.jsdelivr.net/npm/@stackblitz/sdk@1/bundles/sdk.umd.js"></script>
{{- end }}

{{- $vendor := resources.Match "js/vendor/*.js" -}}
{{- $js := resources.Match "js/*.js" -}}
{{- $targetDocsJSPath := path.Join "/docs" .Site.Params.docs_version "assets/js/docs.js" -}}
Expand Down Expand Up @@ -70,3 +74,100 @@
}
</script>
{{- end }}

{{ if eq .Page.Layout "single" -}}
<script>
// Open in StackBlitz logic
document.querySelectorAll('.btn-edit').forEach(btn => {
btn.addEventListener('click', event => {
const exampleRef = event.target.closest('.btn-edit').getAttribute('data-sb-js-snippet')

StackBlitzSDK.openBootstrapSnippet(exampleRef)
})

StackBlitzSDK.openBootstrapSnippet = async (exampleRef) => {
const isRTL = '-rtl' === exampleRef.substring(exampleRef.length - 4)

const exampleMarkup = "../examples/" + exampleRef + "/index.html"
let markup
let jsSnippet = 'import \'./style.css\';'

await fetch(exampleMarkup)
.then(response => response.text())
.then(text => markup = text)

let d = document.createElement('html')
d.innerHTML = markup

const exampleCSS = d.querySelector('style').innerHTML

// Get CSS file
const css = "../examples/"
+ (isRTL ? (exampleRef.substring(0, exampleRef.length - 4)) : exampleRef)
+ "/"
+ (isRTL ? (exampleRef.substring(0, exampleRef.length - 4) + '.rtl') : exampleRef)
+ ".css"
let cssContent = ''
const response = await fetch(css)

if (response.ok) {
cssContent = await response.text()
}

// Get JS file
// First try in the basic directory
const js = "../examples/" + (isRTL ? (exampleRef.substring(0, exampleRef.length - 4)) : exampleRef) + "/" + (isRTL ? (exampleRef.substring(0, exampleRef.length - 4)) : exampleRef) + ".js"
let jsContent = ''
const responseJS = await fetch(js)

if (responseJS.ok) {
jsContent = await responseJS.text()
}

// Second try for RTL in the basic-rtl directory
if (isRTL && !responseJS.ok) {
const jsRTL = "../examples/" + exampleRef + "/" + exampleRef.substring(0, exampleRef.length - 4) + ".js"
const responseJSRTL = await fetch(jsRTL)

if (responseJSRTL.ok) {
jsContent = await responseJSRTL.text()
}
}

// Get HTML content
let htmlContent = d.querySelector('body').outerHTML.replaceAll('"/docs/5.', '"https://getbootstrap.com/docs/5.')

// Special use case to handle images from Heroes example
htmlContent = htmlContent.replaceAll('src="bootstrap-', 'src="https://getbootstrap.com/docs/5.2/examples/' + exampleRef + '/bootstrap-')
// Special use case to handle images from Features example
htmlContent = htmlContent.replaceAll('background-image: url(\'', 'background-image: url(\'https://getbootstrap.com/docs/5.2/examples/' + exampleRef + '/')

const t = `<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="{{ .Site.Params.cdn.css }}" rel="stylesheet">
<title>Bootstrap Example</title>
<${'script'} src="{{ .Site.Params.cdn.js_bundle }}"></${'script'}>
</head>
${htmlContent}
</html>`

const project = {
files: {
'index.html': t,
'index.js': jsSnippet + '\r\n\r\n' + jsContent,
'style.css': exampleCSS + cssContent,
},
title: 'Bootstrap Example',
description: `Official example from ${window.location.href}`,
template: 'javascript',
tags: ['bootstrap']
}

StackBlitzSDK.openProject(project, { openFile: 'index.html' })
}
})
</script>
{{- end }}