⬅️ Back to Table of Contents

📄 AlertBlock

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	1
💠 JSX Elements	2
📐 Interfaces	1

📚 Table of Contents

• Imports
• JSX Elements
• Functions
• Interfaces

🛠️ File Location:

📂 packages/website/src/components/layout/AlertBlock.tsx

📦 Imports

Name	Source
React	react

---

JSX Elements

Component	Type	Props	Children
div	element	className={admonition alert alert--${props.type}}
div	element	className="admonition-content"	{props.children}

---

Functions

AlertBlock(props: AlertBlockProps): React.JSX.Element

Parameters:

• props AlertBlockProps

Returns: React.JSX.Element

Code

function AlertBlock(props: AlertBlockProps): React.JSX.Element {
  return (
    <div className={`admonition alert alert--${props.type}`}>
      <div className="admonition-content">{props.children}</div>
    </div>
  );
}

---

Interfaces

AlertBlockProps

Interface Code

export interface AlertBlockProps {
  readonly children: React.ReactNode;
  readonly type: 'danger' | 'info' | 'note' | 'success' | 'warning';
}

Properties

Name	Type	Optional	Description
children	React.ReactNode	✗	not shown
type	'danger' \| 'info' \| 'note' \| 'success' \| 'warning'	✗	not shown

---

Generated by Syntax Scribe