@myst-theme/jupyter 0.13.7 → 0.14.0

package/dist/block.d.ts

@@ -0,0 +1,21 @@
+import type { GenericParent } from 'myst-common';
+import type { NodeRenderers, NodeRenderer } from '@myst-theme/providers';
+export declare function NotebookBlock({ id, node, className, }: {
+    id: string;
+    node: GenericParent;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare const NotebookBlockRenderer: NodeRenderer;
+/**
+ * The logic for the selector is complex:
+ *
+ *  - MD files have `notebook-code` and otherwise blocks with no kind.
+ *  - IPyNB files have both `notebook-code` and `notebook-content` blocks.
+ *  - An article may contain `notebook-code` blocks from the `code-cell` directive even though it is not considered a notebook (i.e., no frontmatter kernelspec).
+ *
+ * This component therefore only renders for `code-cells` (both ipynb and .md) and `content-cells` (ipynb).
+ *
+ * The benefit of this is that we can use the block-kind to figure out if e.g. the cell is executable.
+ */
+export declare const NOTEBOOK_BLOCK_RENDERERS: NodeRenderers;
+//# sourceMappingURL=block.d.ts.map

package/dist/block.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block.d.ts","sourceRoot":"","sources":["../src/block.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAQjD,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAEzE,wBAAgB,aAAa,CAAC,EAC5B,EAAE,EACF,IAAI,EACJ,SAAS,GACV,EAAE;IACD,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,2CAuCA;AAED,eAAO,MAAM,qBAAqB,EAAE,YASnC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,wBAAwB,EAAE,aAItC,CAAC"}

package/dist/block.js

@@ -0,0 +1,42 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { Details, MyST } from 'myst-to-react';
+import { SourceFileKind } from 'myst-spec-ext';
+import classNames from 'classnames';
+import { NotebookClearCell, NotebookRunCell, NotebookRunCellSpinnerOnly, } from './controls/index.js';
+import { useGridSystemProvider, usePageKind } from '@myst-theme/providers';
+export function NotebookBlock({ id, node, className, }) {
+    var _a, _b;
+    const pageKind = usePageKind();
+    const grid = useGridSystemProvider();
+    const subGrid = node.visibility === 'hide' ? '' : `${grid} subgrid-gap col-screen`;
+    const dataClassName = typeof ((_a = node.data) === null || _a === void 0 ? void 0 : _a.class) === 'string' ? (_b = node.data) === null || _b === void 0 ? void 0 : _b.class : undefined;
+    // Hide the subgrid if either the dataClass or the className exists and includes `col-`
+    const noSubGrid = (dataClassName && dataClassName.includes('col-')) || (className && className.includes('col-'));
+    const block = (_jsxs("div", { id: id, className: classNames('relative group/block', className, dataClassName, {
+            [subGrid]: !noSubGrid,
+            hidden: node.visibility === 'remove',
+        }), children: [pageKind === SourceFileKind.Notebook && node.kind === 'notebook-code' && (_jsxs(_Fragment, { children: [_jsx("div", { className: "flex sticky top-[80px] z-10 opacity-70 group-hover/block:opacity-100 group-hover/block:hidden", children: _jsx("div", { className: "absolute top-0 -right-[28px] flex md:flex-col", children: _jsx(NotebookRunCellSpinnerOnly, { id: id }) }) }), _jsx("div", { className: "hidden sticky top-[80px] z-10 opacity-70 group-hover/block:opacity-100 group-hover/block:flex", children: _jsxs("div", { className: "absolute top-0 -right-[28px] flex md:flex-col", children: [_jsx(NotebookRunCell, { id: id }), _jsx(NotebookClearCell, { id: id })] }) })] })), _jsx(MyST, { ast: node.children })] }, `block-${id}`));
+    if (node.visibility === 'hide') {
+        return _jsx(Details, { title: "Notebook Cell", children: block });
+    }
+    return block;
+}
+export const NotebookBlockRenderer = ({ node, className }) => {
+    return (_jsx(NotebookBlock, { id: node.key, node: node, className: classNames(node.class, className) }, node.key));
+};
+/**
+ * The logic for the selector is complex:
+ *
+ *  - MD files have `notebook-code` and otherwise blocks with no kind.
+ *  - IPyNB files have both `notebook-code` and `notebook-content` blocks.
+ *  - An article may contain `notebook-code` blocks from the `code-cell` directive even though it is not considered a notebook (i.e., no frontmatter kernelspec).
+ *
+ * This component therefore only renders for `code-cells` (both ipynb and .md) and `content-cells` (ipynb).
+ *
+ * The benefit of this is that we can use the block-kind to figure out if e.g. the cell is executable.
+ */
+export const NOTEBOOK_BLOCK_RENDERERS = {
+    block: {
+        'block[kind=notebook-code],block[kind=notebook-content]': NotebookBlockRenderer,
+    },
+};

package/dist/index.d.ts

@@ -1,11 +1,3 @@
-import { Embed } from './embed.js';
-import { Output } from './output.js';
-import { Figure } from './figure.js';
-declare const OUTPUT_RENDERERS: {
-    output: typeof Output;
-    embed: typeof Embed;
-    container: typeof Figure;
-};
 export * from './BinderBadge.js';
 export * from './ErrorTray.js';
 export * from './ConnectionStatusTray.js';
@@ -14,5 +6,5 @@ export * from './execute/index.js';
 export * from './controls/index.js';
 export * from './utils.js';
 export { useLaunchBinder } from './hooks.js';
-export default OUTPUT_RENDERERS;
+export { JUPYTER_RENDERERS, NOTEBOOK_BLOCK_RENDERERS, OUTPUT_RENDERERS } from './renderers.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,QAAA,MAAM,gBAAgB;;;;CAIrB,CAAC;AAEF,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,11 +1,3 @@
-import { Embed } from './embed.js';
-import { Output } from './output.js';
-import { Figure } from './figure.js';
-const OUTPUT_RENDERERS = {
-    output: Output,
-    embed: Embed,
-    container: Figure,
-};
 export * from './BinderBadge.js';
 export * from './ErrorTray.js';
 export * from './ConnectionStatusTray.js';
@@ -14,4 +6,4 @@ export * from './execute/index.js';
 export * from './controls/index.js';
 export * from './utils.js';
 export { useLaunchBinder } from './hooks.js';
-export default OUTPUT_RENDERERS;
+export { JUPYTER_RENDERERS, NOTEBOOK_BLOCK_RENDERERS, OUTPUT_RENDERERS } from './renderers.js';

package/dist/renderers.d.ts

@@ -0,0 +1,11 @@
+import { Embed } from './embed.js';
+import { Output } from './output.js';
+import { Figure } from './figure.js';
+export { NOTEBOOK_BLOCK_RENDERERS } from './block.js';
+export declare const OUTPUT_RENDERERS: {
+    output: typeof Output;
+    embed: typeof Embed;
+    container: typeof Figure;
+};
+export declare const JUPYTER_RENDERERS: import("@myst-theme/providers").NodeRenderers;
+//# sourceMappingURL=renderers.d.ts.map

package/dist/renderers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderers.d.ts","sourceRoot":"","sources":["../src/renderers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAIrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AACtD,eAAO,MAAM,gBAAgB;;;;CAI5B,CAAC;AACF,eAAO,MAAM,iBAAiB,+CAA+D,CAAC"}

package/dist/renderers.js

@@ -0,0 +1,12 @@
+import { Embed } from './embed.js';
+import { Output } from './output.js';
+import { Figure } from './figure.js';
+import { mergeRenderers } from '@myst-theme/providers';
+import { NOTEBOOK_BLOCK_RENDERERS } from './block.js';
+export { NOTEBOOK_BLOCK_RENDERERS } from './block.js';
+export const OUTPUT_RENDERERS = {
+    output: Output,
+    embed: Embed,
+    container: Figure,
+};
+export const JUPYTER_RENDERERS = mergeRenderers([OUTPUT_RENDERERS, NOTEBOOK_BLOCK_RENDERERS]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myst-theme/jupyter",
-  "version": "0.13.7",
+  "version": "0.14.0",
   "type": "module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,17 +25,17 @@
     "@curvenote/ansi-to-react": "^7.0.0",
     "@headlessui/react": "^1.7.15",
     "@heroicons/react": "^2.0.18",
-    "@myst-theme/providers": "^0.13.7",
+    "@myst-theme/providers": "^0.14.0",
     "@scienceicons/react": "^0.0.11",
     "buffer": "^6.0.3",
     "classnames": "^2.5.1",
     "jupyterlab-plotly": "^5.24.0",
-    "myst-common": "^1.7.8",
-    "myst-config": "^1.7.8",
-    "myst-frontmatter": "^1.7.8",
+    "myst-common": "^1.7.9",
+    "myst-config": "^1.7.9",
+    "myst-frontmatter": "^1.7.9",
     "myst-spec": "^0.0.5",
-    "myst-spec-ext": "^1.7.8",
-    "myst-to-react": "^0.13.7",
+    "myst-spec-ext": "^1.7.9",
+    "myst-to-react": "^0.14.0",
     "nanoid": "^4.0.2",
     "nbtx": "^0.2.3",
     "react-syntax-highlighter": "^15.5.0",