Tabs
Tabs create interactive tabbed interfaces that organize content into multiple panels. They're perfect for displaying different versions of code, multiple examples, or organizing related content into logical sections. Each tab has a clickable header and contains its own content area.
Properties
Properties outside of id, title, and default will be ignored, however they can be useful. In the example below some ignored properties have been added to aid with reability, eg. javascript-end.
id
string required
A unique identifier for the tab. This is automatically generated from the title if not provided, using slugification.
title
string required
The text displayed in the tab header. This is what users will see and click on to switch between tabs.
default
string optional
The ID of the tab that should be active by default. If not specified, the first tab will be active.
Examples
Basic Tabs
function greet(name) {
return `Hello, ${name}!`;
}
console.log(greet('World'));
function greet(name: string): string {
return `Hello, ${name}!`;
}
console.log(greet('World'));
def greet(name):
return f"Hello, {name}!"
print(greet("World"))
<scalar-tabs nested>
<scalar-tab title="JavaScript">
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
console.log(greet('World'));
```
</scalar-tab javascript-end>
<scalar-tab title="TypeScript">
```typescript
function greet(name: string): string {
return `Hello, ${name}!`;
}
console.log(greet('World'));
```
</scalar-tab typescript-end>
<scalar-tab title="Python">
```python
def greet(name):
return f"Hello, {name}!"
print(greet("World"))
```
</scalar-tab python-end>
</scalar-tabs nested>
fn greet(name: &str) -> String {
format!("Hello, {}!", name)
}
fn main() {
println!("{}", greet("World"));
}
package main
import (
"fmt"
)
func greet(name string) string {
return fmt.Sprintf("Hello, %s!", name)
}
func main() {
fmt.Println(greet("World"))
}
#include <iostream>
#include <string>
std::string greet(const std::string& name) {
return "Hello, " + name + "!";
}
int main() {
std::cout << greet("World") << std::endl;
return 0;
}
::::scalar-tabs
:::scalar-tab{ title="Rust" }
```rust
fn greet(name: &str) -> String {
format!("Hello, {}!", name)
}
fn main() {
println!("{}", greet("World"));
}
```
:::
:::scalar-tab{ title="Go" }
```go
package main
import (
"fmt"
)
func greet(name string) string {
return fmt.Sprintf("Hello, %s!", name)
}
func main() {
fmt.Println(greet("World"))
}
```
:::
:::scalar-tab{ title="C++" }
```cpp
#include <iostream>
#include <string>
std::string greet(const std::string& name) {
return "Hello, " + name + "!";
}
int main() {
std::cout << greet("World") << std::endl;
return 0;
}
```
:::
::::
Tabs with Default Selection
const user = {
name: "John",
age: 30
};
interface User {
name: string;
age: number;
}
const user: User = {
name: "John",
age: 30
};
<scalar-tabs default="TypeScript">
<scalar-tab title="JavaScript">
```javascript const user = { name: "John", age: 30 }; ```
</scalar-tab>
<scalar-tab title="TypeScript">
```typescript interface User { name: string; age: number; } const user: User
= { name: "John", age: 30 }; ```
</scalar-tab>
</scalar-tabs>
const user = {
name: "John",
age: 30
};
interface User {
name: string;
age: number;
}
const user: User = {
name: "John",
age: 30
};
::::scalar-tabs{ default="TypeScript" }
:::scalar-tab{ title="JavaScript" }
```javascript
const user = {
name: "John",
age: 30
};
```
:::
:::scalar-tab{ title="TypeScript" }
```typescript
interface User {
name: string;
age: number;
}
const user: User = {
name: "John",
age: 30
};
```
:::
::::
Tabs with Mixed Content
This is the overview tab with plain text content.
You can include **markdown** formatting and other elements.
npm install @scalar/guide-elements
This tab contains a code example with additional text.
{
"theme": "dark",
"interactive": true,
"features": ["tabs", "steps", "callouts"]
}
<scalar-tabs>
<scalar-tab title="Overview">
This is the overview tab with plain text content. You can include
**markdown** formatting and other elements.
</scalar-tab>
<scalar-tab title="Code Example">
```bash npm install @scalar/guide-elements```
This tab contains a code example with additional text.
</scalar-tab>
<scalar-tab title="Configuration">
```json { "theme": "dark", "interactive": true, "features": ["tabs",
"steps", "callouts"] }
```
</scalar-tab>
</scalar-tabs>
This is the overview tab with plain text content.
You can include markdown formatting and other elements.
npm install @scalar/guide-elements
This tab contains a code example with additional text.
{
"theme": "dark",
"interactive": true,
"features": ["tabs", "steps", "callouts"]
}
::::scalar-tabs
:::scalar-tab{ title="Overview" }
This is the overview tab with plain text content.
You can include **markdown** formatting and other elements.
:::
:::scalar-tab{ title="Code Example" }
```bash
npm install @scalar/guide-elements
```
This tab contains a code example with additional text.
:::
:::scalar-tab{ title="Configuration" }
```json
{
"theme": "dark",
"interactive": true,
"features": ["tabs", "steps", "callouts"]
}
```
:::
::::