storybook autodocs

next-ui/src/components/BuildCommit.stories.ts

@@ -16,6 +16,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof BuildCommit>

next-ui/src/components/BuildVersion.stories.ts

@@ -17,6 +17,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof BuildVersion>

next-ui/src/components/FormattedMessage.mdx

@@ -1,11 +0,0 @@
-import {Canvas, Meta} from '@storybook/addon-docs/blocks';
-
-import * as Stories from './FormattedMessage.stories';
-
-<Meta of={Stories} />
-
-# FormattedMessage
-
-Component to display formatted `formatjs` messages using dynamic slots.
-
-<Canvas of={Stories.Default} />

next-ui/src/components/FormattedMessage.stories.ts

@@ -6,6 +6,11 @@ const meta = {
   component: FormattedMessage,
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: 'Component to display formatted `formatjs` messages using dynamic slots.',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof FormattedMessage>

next-ui/src/components/LocaleSelector.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof LocaleSelector>

next-ui/src/components/PageSizeSelector.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     modelValue: 20,

next-ui/src/components/PresentationSelector.mdx

@@ -1,11 +0,0 @@
-import { Canvas, Meta } from '@storybook/addon-docs/blocks';
-
-import * as Stories from './PresentationSelector.stories';
-
-<Meta of={Stories} />
-
-# PresentationSelector
-
-A button that will display a list of presentation modes when clicked.
-
-<Canvas of={Stories.Default} />

next-ui/src/components/PresentationSelector.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: 'A button that will display a list of presentation modes when clicked.',
+      },
+    },
   },
   args: {
     modelValue: 'grid',
@@ -30,6 +35,7 @@ export const Default: Story = {
 }
 
 export const Clicked: Story = {
+  tags: ['!autodocs'],
   args: {},
   play: async ({ canvas, userEvent }) => {
     await expect(canvas.getByRole('button')).toBeEnabled()

next-ui/src/components/RemoteFileList.stories.ts

@@ -15,6 +15,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof RemoteFileList>

next-ui/src/components/SnackQueue.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof SnackQueue>

next-ui/src/components/ThemeSelector.mdx

@@ -1,11 +0,0 @@
-import { Canvas, Meta } from '@storybook/addon-docs/blocks';
-
-import * as Stories from './ThemeSelector.stories';
-
-<Meta of={Stories} />
-
-# ThemeSelector
-
-A cycling button to change the theme.
-
-<Canvas of={Stories.Default} />

next-ui/src/components/ThemeSelector.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: 'A cycling button to change the theme.',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof ThemeSelector>

next-ui/src/components/announcement/Card.mdx

@@ -1,11 +0,0 @@
-import { Canvas, Meta } from '@storybook/addon-docs/blocks';
-
-import * as Stories from './Card.stories';
-
-<Meta of={Stories} />
-
-# AnnouncementCard
-
-A card showing the details of a Komga announcement.
-
-<Canvas of={Stories.Unread} />

next-ui/src/components/announcement/Card.stories.ts

@@ -12,12 +12,18 @@ const meta = {
     },
     template: '<Card :item="args.item"/>',
   }),
-  parameters: {
-    // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
-  },
+
   args: {
     onMarkRead: fn(),
   },
+  parameters: {
+    // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: 'A card showing the details of a Komga announcement.',
+      },
+    },
+  },
 } satisfies Meta<typeof Card>
 
 export default meta

next-ui/src/components/apikey/DeletionWarning.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof DeletionWarning>

next-ui/src/components/apikey/ForceSyncWarning.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof ForceSyncWarning>

next-ui/src/components/apikey/GenerateDialog.stories.ts

@@ -15,6 +15,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     dialog: true,

next-ui/src/components/apikey/Table.stories.ts

@@ -15,6 +15,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     onAddApiKey: fn(),

next-ui/src/components/dialog/BookPicker.stories.ts

@@ -15,6 +15,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     dialog: true,

next-ui/src/components/dialog/Confirm.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     dialog: true,

next-ui/src/components/dialog/FileNamePicker.stories.ts

@@ -15,6 +15,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     dialog: true,

next-ui/src/components/dialog/SeriesPicker.stories.ts

@@ -16,6 +16,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     dialog: true,

next-ui/src/components/history/HistoryTable.stories.ts

@@ -18,6 +18,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof HistoryTable>

next-ui/src/components/history/expand/BookConverted.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof BookConverted>

next-ui/src/components/history/expand/BookFileDeleted.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof BookFileDeleted>

next-ui/src/components/history/expand/BookImported.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof BookImported>

next-ui/src/components/history/expand/DuplicatePageDeleted.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof DuplicatePageDeleted>

next-ui/src/components/history/expand/SeriesDirectoryDeleted.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof SeriesDirectoryDeleted>

next-ui/src/components/import/books/DirectorySelection.stories.ts

@@ -16,6 +16,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     onScan: fn(),

next-ui/src/components/import/books/TransientBooksTable.stories.ts

@@ -18,6 +18,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof TransientBooksTable>

next-ui/src/components/import/readlist/Table.stories.ts

@@ -19,6 +19,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof Table>

next-ui/src/components/layout/app/drawer/Drawer.stories.ts

@@ -17,6 +17,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof Drawer>

next-ui/src/components/layout/app/drawer/ReorderLibraries.stories.ts

@@ -17,6 +17,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof ReorderLibraries>

next-ui/src/components/layout/app/drawer/menu/Libraries.stories.ts

@@ -25,6 +25,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof Libraries>

next-ui/src/components/library/BottomNavigation.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof BottomNavigation>

next-ui/src/components/library/DeletionWarning.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof DeletionWarning>

next-ui/src/components/library/TabNavigation.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof TabNavigation>

next-ui/src/components/library/form/CreateEdit.stories.ts

@@ -16,6 +16,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof CreateEdit>

next-ui/src/components/library/form/StepGeneral.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof StepGeneral>

next-ui/src/components/library/form/StepMetadata.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof StepMetadata>

next-ui/src/components/library/form/StepOptions.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof StepOptions>

next-ui/src/components/library/form/StepScanner.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof StepScanner>

next-ui/src/components/pageHash/KnownTable.stories.ts

@@ -21,6 +21,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof KnownTable>

next-ui/src/components/pageHash/MatchTable.stories.ts

@@ -18,6 +18,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     modelValue: 'hash1',

next-ui/src/components/pageHash/UnknownTable.stories.ts

@@ -21,6 +21,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof UnknownTable>

next-ui/src/components/release/Card.mdx

@@ -1,11 +0,0 @@
-import { Canvas, Meta } from '@storybook/addon-docs/blocks';
-
-import * as Stories from './Card.stories';
-
-<Meta of={Stories} />
-
-# ReleaseCard
-
-A card showing the details of a Komga release.
-
-<Canvas of={Stories.LatestAndCurrent} />

next-ui/src/components/release/Card.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: 'A card showing the details of a Komga release.',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof Card>

next-ui/src/components/server/Settings.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     settings: {

next-ui/src/components/user/AuthenticationActivityTable.stories.ts

@@ -18,6 +18,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof AuthenticationActivityTable>

next-ui/src/components/user/DeletionWarning.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof DeletionWarning>

next-ui/src/components/user/Details.stories.ts

@@ -13,6 +13,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     user: {

next-ui/src/components/user/Table.stories.ts

@@ -15,6 +15,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {
     onAddUser: fn(),

next-ui/src/components/user/form/ChangePassword.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof ChangePassword>

next-ui/src/components/user/form/CreateEdit.stories.ts

@@ -14,6 +14,11 @@ const meta = {
   }),
   parameters: {
     // More on how to position stories at: https://storybook.js.org/docs/configure/story-layout
+    docs: {
+      description: {
+        component: '',
+      },
+    },
   },
   args: {},
 } satisfies Meta<typeof CreateEdit>