mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
6c53a28e3a
* Document className and Tailwind arbitrary value support All built-in components now accept a className prop (mint#10540), and dynamic Tailwind utilities work in className on MDX components (mint#6737). Two pages stated the opposite. - Correct the claims that Tailwind arbitrary values are unsupported in customize/custom-scripts and guides/custom-layouts - Add className and arbitrary value guidance to the Tailwind section of custom-scripts, including the runtime-class limitation and the Tab content-panel caveat - Add a Style components section to the components overview - Add className property rows to every component reference page that supports it, and note the three components that do not - Document inline Markdown support in component title props - Correct the callouts page, which said typed callouts accept only children - Replace inline style resizing with Tailwind classes in image embeds - Add a help center article for Tailwind classes not applying in the editor's live preview, and note the limitation in custom-layouts - Point skill.md at className before custom.css - Accept className, keyframes, and unstyled in the Vale vocabulary Resolves DOC-316, DOC-317 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> * Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
109 lines
2.5 KiB
Plaintext
109 lines
2.5 KiB
Plaintext
---
|
|
title: "Code groups"
|
|
description: "Use the CodeGroup component to display multiple code examples in a tabbed interface and let readers compare implementations across languages."
|
|
keywords: ["code groups", "tabbed code", "multi-language examples", "CodeGroup"]
|
|
---
|
|
|
|
Use the `CodeGroup` component to display multiple code blocks in a tabbed interface, allowing users to compare implementations across different programming languages or see alternative approaches for the same task.
|
|
|
|
<CodeGroup>
|
|
|
|
```javascript helloWorld.js
|
|
console.log("Hello World");
|
|
```
|
|
|
|
```python hello_world.py
|
|
print('Hello World!')
|
|
```
|
|
|
|
```java HelloWorld.java
|
|
class HelloWorld {
|
|
public static void main(String[] args) {
|
|
System.out.println("Hello, World!");
|
|
}
|
|
}
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
Code groups inherit global styling from your `docs.json` file. Customize your theme using `styling.codeblocks`. See [Settings](/organize/settings-appearance#styling) for configuration options.
|
|
|
|
Code groups automatically synchronize with other code groups and [tabs](/components/tabs) on the same page when their labels match. When you select a language in one code group, all tabs and code groups with matching labels update to show the same language.
|
|
|
|
## Create code groups
|
|
|
|
To create a code group, wrap multiple code blocks with `<CodeGroup>` tags. Each code block must include a title, which becomes the tab label.
|
|
|
|
````mdx
|
|
<CodeGroup>
|
|
|
|
```javascript helloWorld.js
|
|
console.log("Hello World");
|
|
```
|
|
|
|
```python hello_world.py
|
|
print('Hello World!')
|
|
```
|
|
|
|
```java HelloWorld.java
|
|
class HelloWorld {
|
|
public static void main(String[] args) {
|
|
System.out.println("Hello, World!");
|
|
}
|
|
}
|
|
```
|
|
|
|
</CodeGroup>
|
|
````
|
|
|
|
## Language dropdown
|
|
|
|
You can replace the tabs in a code group with a dropdown menu to toggle between languages using the `dropdown` prop.
|
|
|
|
<CodeGroup dropdown>
|
|
|
|
```javascript helloWorld.js
|
|
console.log("Hello World");
|
|
```
|
|
|
|
```python hello_world.py
|
|
print('Hello World!')
|
|
```
|
|
|
|
```java HelloWorld.java
|
|
class HelloWorld {
|
|
public static void main(String[] args) {
|
|
System.out.println("Hello, World!");
|
|
}
|
|
}
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
````mdx highlight=1
|
|
<CodeGroup dropdown>
|
|
|
|
```javascript helloWorld.js
|
|
console.log("Hello World");
|
|
```
|
|
|
|
```python hello_world.py
|
|
print('Hello World!')
|
|
```
|
|
|
|
```java HelloWorld.java
|
|
class HelloWorld {
|
|
public static void main(String[] args) {
|
|
System.out.println("Hello, World!");
|
|
}
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
````
|
|
|
|
## Properties
|
|
|
|
<ResponseField name="className" type="string">
|
|
Additional CSS classes to apply to the code group container.
|
|
</ResponseField>
|