Merge pull request #2027 from OffchainLabs/add-vanilla-admonitions

Add vanilla admonitions
OffchainLabs · Jan 30, 2025 · 373fcaa · 373fcaa
2 parents a763ea1 + c492894
commit 373fcaa
Show file tree

Hide file tree

Showing 3 changed files with 167 additions and 0 deletions.
diff --git a/website/src/components/VanillaAdmonition/Icons/index.tsx b/website/src/components/VanillaAdmonition/Icons/index.tsx
@@ -0,0 +1,46 @@
+import React from 'react';
+
+export const DangerIcon = (props: React.SVGProps<SVGSVGElement>) => (
+  <svg viewBox="0 0 12 16" {...props}>
+    <path
+      fillRule="evenodd"
+      d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"
+    />
+  </svg>
+);
+
+export const InfoIcon = (props: React.SVGProps<SVGSVGElement>) => (
+  <svg viewBox="0 0 14 16" {...props}>
+    <path
+      fillRule="evenodd"
+      d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"
+    />
+  </svg>
+);
+
+export const NoteIcon = (props: React.SVGProps<SVGSVGElement>) => (
+  <svg viewBox="0 0 14 16" {...props}>
+    <path
+      fillRule="evenodd"
+      d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"
+    />
+  </svg>
+);
+
+export const TipIcon = (props: React.SVGProps<SVGSVGElement>) => (
+  <svg viewBox="0 0 12 16" {...props}>
+    <path
+      fillRule="evenodd"
+      d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"
+    />
+  </svg>
+);
+
+export const WarningIcon = (props: React.SVGProps<SVGSVGElement>) => (
+  <svg viewBox="0 0 16 16" {...props}>
+    <path
+      fillRule="evenodd"
+      d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"
+    />
+  </svg>
+);
diff --git a/website/src/components/VanillaAdmonition/index.tsx b/website/src/components/VanillaAdmonition/index.tsx
@@ -0,0 +1,39 @@
+import React, { ReactNode } from 'react';
+import { DangerIcon, InfoIcon, NoteIcon, TipIcon, WarningIcon } from './Icons';
+import styles from './styles.module.css';
+
+type AdmonitionType = 'note' | 'tip' | 'info' | 'warning' | 'danger';
+
+interface AdmonitionProps {
+  type: AdmonitionType;
+  title?: string;
+  children: ReactNode;
+}
+
+const defaultTitles: Record<AdmonitionType, string> = {
+  note: 'Note',
+  tip: 'Tip',
+  info: 'Info',
+  warning: 'Warning',
+  danger: 'Danger',
+};
+
+const icons: Record<AdmonitionType, React.ReactNode> = {
+  note: <NoteIcon className={styles.icon} />,
+  tip: <TipIcon className={styles.icon} />,
+  info: <InfoIcon className={styles.icon} />,
+  warning: <WarningIcon className={styles.icon} />,
+  danger: <DangerIcon className={styles.icon} />,
+};
+
+export function VanillaAdmonition({ type, title, children }: AdmonitionProps) {
+  return (
+    <div className={`${styles.admonition} ${styles[type]}`}>
+      <div className={styles.admonitionHeader}>
+        <span className={styles.admonitionIcon}>{icons[type]}</span>
+        <span className={styles.admonitionTitle}>{title || defaultTitles[type]}</span>
+      </div>
+      <div className={styles.admonitionContent}>{children}</div>
+    </div>
+  );
+}
diff --git a/website/src/components/VanillaAdmonition/styles.module.css b/website/src/components/VanillaAdmonition/styles.module.css
@@ -0,0 +1,82 @@
+.admonition {
+  margin-bottom: 16px;
+  padding: 8px 10px 3px 10px;
+  border-radius: 4px;
+  border-left: 6px solid;
+  font-family: system-ui, -apple-system, sans-serif;
+}
+
+.admonitionHeader {
+  display: flex;
+  align-items: center;
+  margin-bottom: 1px;
+}
+
+.admonitionIcon {
+  margin-right: 8px;
+  display: flex;
+  align-items: center;
+}
+
+.admonitionTitle {
+  font-weight: 600;
+  font-size: 14px;
+  color: #ffffff;
+}
+
+.admonitionContent {
+  font-size: 14px;
+  color: rgba(255, 255, 255, 0.8);
+  line-height: 1.5;
+  padding: 0px;
+}
+
+/* Type-specific styles with literal colors */
+.note {
+  border-left-color: #5c6370;
+  background: rgba(92, 99, 112, 0.1);
+}
+
+.tip {
+  border-left-color: #28a745;
+  background: rgba(40, 167, 69, 0.1);
+}
+
+.info {
+  border-left-color: #0366d6;
+  background: rgba(3, 102, 214, 0.1);
+}
+
+.warning {
+  border-left-color: #f0b400;
+  background: rgba(240, 180, 0, 0.1);
+}
+
+.danger {
+  border-left-color: #d73a49;
+  background: rgba(215, 58, 73, 0.1);
+}
+
+/* Light theme overrides */
+[data-theme='light'] .admonitionTitle {
+  color: #1f2328;
+}
+
+[data-theme='light'] .admonitionContent {
+  color: rgba(31, 35, 40, 0.8);
+}
+/* Light theme overrides */
+[data-theme='dark'] .admonitionTitle {
+    color: #b5c2d3;
+  }
+
+  [data-theme='dark'] .admonitionContent {
+    color: rgba(184, 194, 205, 0.8);
+  }
+
+/* Add these styles */
+.icon {
+  width: 16px;
+  height: 16px;
+  fill: currentColor;
+}