🎨 Write class name to admonition (#314)

jupyter-book · Feb 12, 2024 · 21d6dce · 21d6dce
1 parent 227326a
commit 21d6dce
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.changeset/mean-cycles-push.md b/.changeset/mean-cycles-push.md
@@ -0,0 +1,5 @@
+---
+'myst-to-react': patch
+---
+
+Include user-specified classnames for admonitions
diff --git a/packages/myst-to-react/src/admonitions.tsx b/packages/myst-to-react/src/admonitions.tsx
@@ -150,6 +150,7 @@ export function Admonition({
   dropdown,
   children,
   hideIcon,
+  className,
 }: {
   title?: React.ReactNode;
   color?: Color;
@@ -158,6 +159,7 @@ export function Admonition({
   simple?: boolean;
   dropdown?: boolean;
   hideIcon?: boolean;
+  className?: string;
 }) {
   return (
     <WrapperElement
@@ -174,6 +176,7 @@ export function Admonition({
           'border-amber-600': color === 'yellow',
           'border-red-600': color === 'red',
         },
+        className,
       )}
     >
       {title && (
@@ -247,6 +250,7 @@ export const AdmonitionRenderer: NodeRenderer<AdmonitionSpec> = ({ node }) => {
       dropdown={isDropdown}
       simple={isSimple}
       hideIcon={hideIcon}
+      className={classNames(classes)}
     >
       {useTitle ? <MyST ast={rest} /> : <MyST ast={node.children} />}
     </Admonition>