@openpkg-ts/doc-generator 0.2.4 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/react-styled.d.ts +15 -41
- package/dist/react-styled.js +1215 -2345
- package/package.json +2 -1
package/dist/react-styled.d.ts
CHANGED
|
@@ -218,6 +218,7 @@ interface TypeTableProps {
|
|
|
218
218
|
* ```
|
|
219
219
|
*/
|
|
220
220
|
declare function TypeTable({ items, showRequired, className, renderRow }: TypeTableProps): React.ReactNode;
|
|
221
|
+
import { CodeTabs, ImportSection, CodeTab, CodeTabsProps, ImportSectionProps } from "@doccov/ui/api";
|
|
221
222
|
import { OpenPkg as OpenPkg7 } from "@openpkg-ts/spec";
|
|
222
223
|
import { OpenPkg as OpenPkg6, SpecExport as SpecExport3, SpecExportKind as SpecExportKind4, SpecType } from "@openpkg-ts/spec";
|
|
223
224
|
interface HTMLOptions {
|
|
@@ -539,31 +540,10 @@ interface ClassPageProps {
|
|
|
539
540
|
renderExample?: (code: string, filename: string) => React.ReactNode;
|
|
540
541
|
}
|
|
541
542
|
/**
|
|
542
|
-
*
|
|
543
|
+
* Stripe-style class page with two-column layout.
|
|
544
|
+
* Left: constructor, methods, properties. Right: sticky code examples.
|
|
543
545
|
*/
|
|
544
546
|
declare function ClassPage({ export: exp, spec, renderExample }: ClassPageProps): React.ReactNode;
|
|
545
|
-
import { ReactNode as ReactNode2 } from "react";
|
|
546
|
-
interface CodeTab {
|
|
547
|
-
/** Tab label */
|
|
548
|
-
label: string;
|
|
549
|
-
/** Tab content (code block) */
|
|
550
|
-
content: ReactNode2;
|
|
551
|
-
/** Raw code for copy button */
|
|
552
|
-
code: string;
|
|
553
|
-
}
|
|
554
|
-
interface CodeTabsProps {
|
|
555
|
-
/** Array of tabs */
|
|
556
|
-
tabs: CodeTab[];
|
|
557
|
-
/** Default selected tab index */
|
|
558
|
-
defaultIndex?: number;
|
|
559
|
-
/** Custom className */
|
|
560
|
-
className?: string;
|
|
561
|
-
}
|
|
562
|
-
/**
|
|
563
|
-
* Tabbed code block wrapper with copy button per tab.
|
|
564
|
-
* Integrates with any code rendering component.
|
|
565
|
-
*/
|
|
566
|
-
declare function CodeTabs({ tabs, defaultIndex, className }: CodeTabsProps): React.ReactNode2;
|
|
567
547
|
import { OpenPkg as OpenPkg9, SpecExport as SpecExport5 } from "@openpkg-ts/spec";
|
|
568
548
|
interface EnumPageProps {
|
|
569
549
|
export: SpecExport5;
|
|
@@ -593,7 +573,7 @@ interface ExportCardProps {
|
|
|
593
573
|
*/
|
|
594
574
|
declare function ExportCard({ name, description, href, kind, className }: ExportCardProps): React.ReactNode;
|
|
595
575
|
import { OpenPkg as OpenPkg10 } from "@openpkg-ts/spec";
|
|
596
|
-
import { ReactNode as
|
|
576
|
+
import { ReactNode as ReactNode2 } from "react";
|
|
597
577
|
interface ExportIndexPageProps {
|
|
598
578
|
/** OpenPkg spec */
|
|
599
579
|
spec: OpenPkg10;
|
|
@@ -603,36 +583,29 @@ interface ExportIndexPageProps {
|
|
|
603
583
|
description?: string;
|
|
604
584
|
/** Custom className */
|
|
605
585
|
className?: string;
|
|
586
|
+
/** Show search input (default: true) */
|
|
587
|
+
showSearch?: boolean;
|
|
588
|
+
/** Show category filter buttons (default: true) */
|
|
589
|
+
showFilters?: boolean;
|
|
606
590
|
}
|
|
607
591
|
/**
|
|
608
592
|
* Index page showing all exports in a grid, grouped by category.
|
|
609
593
|
* AI SDK-style clean layout with responsive 2-column grid.
|
|
610
594
|
*/
|
|
611
|
-
declare function ExportIndexPage({ spec, baseHref, description, className }: ExportIndexPageProps):
|
|
595
|
+
declare function ExportIndexPage({ spec, baseHref, description, className, showSearch, showFilters }: ExportIndexPageProps): ReactNode2;
|
|
612
596
|
import { OpenPkg as OpenPkg11, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
|
|
613
|
-
import { ReactNode as
|
|
597
|
+
import { ReactNode as ReactNode3 } from "react";
|
|
614
598
|
interface FunctionPageProps {
|
|
615
599
|
export: SpecExport6;
|
|
616
600
|
spec: OpenPkg11;
|
|
617
601
|
/** Custom code example renderer */
|
|
618
|
-
renderExample?: (code: string, filename: string) =>
|
|
602
|
+
renderExample?: (code: string, filename: string) => ReactNode3;
|
|
619
603
|
}
|
|
620
604
|
/**
|
|
621
|
-
*
|
|
605
|
+
* Stripe-style function page with two-column layout.
|
|
622
606
|
* Left: parameters, returns. Right: sticky code examples.
|
|
623
607
|
*/
|
|
624
|
-
declare function FunctionPage({ export: exp, spec, renderExample }: FunctionPageProps):
|
|
625
|
-
interface ImportSectionProps {
|
|
626
|
-
/** Import statement text */
|
|
627
|
-
importStatement: string;
|
|
628
|
-
/** Custom className */
|
|
629
|
-
className?: string;
|
|
630
|
-
}
|
|
631
|
-
/**
|
|
632
|
-
* Displays a copyable import statement with one-click copy.
|
|
633
|
-
* Monospace styling with copy button.
|
|
634
|
-
*/
|
|
635
|
-
declare function ImportSection({ importStatement, className }: ImportSectionProps): React.ReactNode;
|
|
608
|
+
declare function FunctionPage({ export: exp, spec, renderExample }: FunctionPageProps): ReactNode3;
|
|
636
609
|
import { OpenPkg as OpenPkg12, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
|
|
637
610
|
interface InterfacePageProps {
|
|
638
611
|
export: SpecExport7;
|
|
@@ -641,7 +614,8 @@ interface InterfacePageProps {
|
|
|
641
614
|
renderExample?: (code: string, filename: string) => React.ReactNode;
|
|
642
615
|
}
|
|
643
616
|
/**
|
|
644
|
-
*
|
|
617
|
+
* Stripe-style interface/type page with two-column layout.
|
|
618
|
+
* Left: properties, methods. Right: sticky code examples.
|
|
645
619
|
*/
|
|
646
620
|
declare function InterfacePage({ export: exp, spec, renderExample }: InterfacePageProps): React.ReactNode;
|
|
647
621
|
import { SpecSchema as SpecSchema2, SpecSignatureParameter as SpecSignatureParameter4 } from "@openpkg-ts/spec";
|