refactor: use 'class' exclusively for buttons

jupyter-book · Jan 23, 2025 · f30bb66 · f30bb66
1 parent 3b0795e
commit f30bb66
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/packages/myst-ext-button/src/index.ts b/packages/myst-ext-button/src/index.ts
@@ -18,9 +18,9 @@ export const buttonRole: RoleSpec = {
     const url = rawLabel ?? body;
     const node: Link = {
       type: 'link',
-      kind: 'button',
       url,
       children: [],
+      class: 'button', // TODO: allow users to extend this
     };
     if (modified) node.children = [{ type: 'text', value: modified.trim() }];
     return [node];

diff --git a/packages/myst-ext-button/tests/button.spec.ts b/packages/myst-ext-button/tests/button.spec.ts
@@ -1,28 +1,30 @@
 import { describe, expect, it } from 'vitest';
 import { buttonRole } from '../src';
-import type { RoleData } from 'myst-common';
+import { VFile } from 'vfile';
 
 describe('Button component', () => {
   it('should process button role correctly', () => {
-    const data: RoleData = { body: 'Click me<http://example.com>' };
-    const result = buttonRole.run(data);
+    const result = buttonRole.run(
+      { name: 'button', body: 'Click me<http://example.com>' },
+      new VFile(),
+    );
+
     expect(result).toEqual([
       {
         type: 'link',
-        kind: 'button',
+        class: 'button',
         url: 'http://example.com',
         children: [{ type: 'text', value: 'Click me' }],
       },
     ]);
   });
 
   it('should process button role without label correctly', () => {
-    const data: RoleData = { body: 'http://example.com' };
-    const result = buttonRole.run(data);
+    const result = buttonRole.run({ name: 'button', body: 'http://example.com' }, new VFile());
     expect(result).toEqual([
       {
         type: 'link',
-        kind: 'button',
+        class: 'button',
         url: 'http://example.com',
         children: [],
       },

diff --git a/packages/myst-spec-ext/src/types.ts b/packages/myst-spec-ext/src/types.ts
@@ -275,6 +275,7 @@ export type CrossReference = SpecCrossReference & {
   dataUrl?: string;
   remoteBaseUrl?: string;
   html_id?: string;
+  class?: Image['class'];
 };
 
 export type Link = SpecLink & {
@@ -284,7 +285,6 @@ export type Link = SpecLink & {
   static?: true;
   protocol?: string;
   error?: true;
-  kind?: 'button';
   class?: Image['class'];
 };