Skip to content

Docs: Add tooltips to buttons when <Example> is used, not just <Code> #41582

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

Merged
merged 3 commits into from
Aug 10, 2025
Merged

Docs: Add tooltips to buttons when <Example> is used, not just <Code> #41582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1fa6372
fix(docs): Add a tooltip on buttons whenever `<Example>` is called an…
louismaximepiton Jul 1, 2025
4cdec3f
Merge branch 'main' into main-lmp-tooltip-example-fix
julien-deramond Aug 10, 2025
7f9ef54
Rename nested param and change comment
julien-deramond Aug 10, 2025
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
39 changes: 24 additions & 15 deletions site/src/components/shortcodes/Code.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,20 @@ interface Props {
* This takes precedence over the `code` prop.
*/
filePath?: string
/**
* Defines if the `<Code>` component is nested inside an `<Example>` component or not.
* @default false
*/
nestedInExample?: boolean
}

const { class: className, code, containerClass, fileMatch, filePath, lang } = Astro.props
const { class: className, code, containerClass, fileMatch, filePath, lang, nestedInExample = false } = Astro.props

let codeToDisplay = filePath
? fs.readFileSync(path.join(process.cwd(), filePath), 'utf8')
: Array.isArray(code)
? code.join('\n')
: code
? code.join('\n')
: code

if (filePath && fileMatch && codeToDisplay) {
const match = codeToDisplay.match(new RegExp(fileMatch))
Expand Down Expand Up @@ -130,19 +135,23 @@ if (filePath && fileMatch && codeToDisplay) {
})
</script>

<div class:list={['bd-code-snippet', containerClass]}>
<div class:list={[{ 'bd-code-snippet': !nestedInExample }, containerClass]}>
{
Astro.slots.has('pre') ? (
<slot name="pre" />
) : (
<div class="bd-clipboard">
<button type="button" class="btn-clipboard">
<svg class="bi" role="img" aria-label="Copy">
<use xlink:href="#clipboard" />
</svg>
</button>
</div>
)
nestedInExample
? (<></>)
: Astro.slots.has('pre')
? (
<slot name="pre" />
)
: (
<div class="bd-clipboard">
<button type="button" class="btn-clipboard">
<svg class="bi" role="img" aria-label="Copy">
<use xlink:href="#clipboard" />
</svg>
</button>
</div>
)
}
<div class="highlight">
{
Expand Down
6 changes: 2 additions & 4 deletions site/src/components/shortcodes/Example.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
import { replacePlaceholdersInHtml } from '@libs/placeholder'
import { Prism } from '@astrojs/prism'
import Code from '@components/shortcodes/Code.astro'

interface Props {
/**
Expand Down Expand Up @@ -96,9 +96,7 @@ const simplifiedMarkup = markup
</div>
</div>
)}
<div class="highlight">
<Prism code={simplifiedMarkup} lang={lang} />
</div>
<Code code={simplifiedMarkup} lang={lang} nestedInExample={true} />
</>
)
}
Expand Down