@xyo-network/react-typedoc 6.1.3 → 6.2.0

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.
@@ -1,90 +1,10 @@
1
- import { FlexBoxProps } from '@xylabs/react-flexbox';
2
- import React, { ReactElement } from 'react';
3
- import { Comment, DeclarationReflection, Reflection, ContainerReflection, ProjectReflection, ReflectionGroup, ParameterReflection, SomeType, SourceReference } from 'typedoc';
4
- import { ButtonExProps } from '@xylabs/react-button';
5
- import { JsonViewerExProps } from '@xyo-network/react-payload-raw-info';
6
- import { TypographyVariant, TypographyProps } from '@mui/material';
7
-
8
- interface CommentViewerProps extends FlexBoxProps {
9
- comment: Comment;
10
- }
11
- declare const CommentViewer: React.FC<CommentViewerProps>;
12
-
13
- type JsonViewerButtonProps = ButtonExProps & {
14
- jsonViewProps?: Partial<JsonViewerExProps>;
15
- src: object;
16
- };
17
- declare const JsonViewerButton: React.FC<JsonViewerButtonProps>;
18
-
19
- type ReflectionLookup<T extends DeclarationReflection = DeclarationReflection> = Record<string, T>;
20
-
21
- type FlagFilter = 'isPublic' | 'isPrivate' | 'isProtected';
22
- interface ReflectionViewerProps<T extends Reflection = Reflection> extends FlexBoxProps {
23
- hiddenFlags?: FlagFilter[];
24
- lookup?: ReflectionLookup;
25
- nameViewer?: ReactElement | null;
26
- reflection: T;
27
- sources?: boolean;
28
- variant?: TypographyVariant;
29
- }
30
-
31
- interface ContainerReflectionViewerProps<T extends ContainerReflection = ContainerReflection> extends ReflectionViewerProps<T> {
32
- itemRenderer?: React.FC<ReflectionViewerProps<any>>;
33
- }
34
- declare const ContainerReflectionViewer: React.FC<ContainerReflectionViewerProps>;
35
-
36
- declare const DeclarationReflectionViewer: React.FC<ReflectionViewerProps<DeclarationReflection>>;
37
-
38
- interface DeclarationContainerReflectionViewerProps extends ContainerReflectionViewerProps {
39
- reflection: DeclarationReflection;
40
- }
41
- declare const DeclarationContainerReflectionViewer: React.FC<DeclarationContainerReflectionViewerProps>;
42
-
43
- declare const ProjectReflectionViewer: React.FC<ContainerReflectionViewerProps<ProjectReflection>>;
44
-
45
- interface ReflectionGroupViewerProps extends ReflectionViewerProps<ContainerReflection> {
46
- autoScroll?: boolean;
47
- group: ReflectionGroup;
48
- reflection: ContainerReflection;
49
- renderer?: React.FC<ReflectionViewerProps>;
50
- }
51
- declare const ReflectionGroupViewer: React.FC<ReflectionGroupViewerProps>;
52
-
53
- declare const ReflectionViewer: React.FC<ReflectionViewerProps>;
54
-
55
- type WithSomeType<T> = T & {
56
- type?: SomeType;
57
- };
58
- type WithSomeParameters<T> = T & {
59
- parameters?: ParameterReflection[];
60
- };
61
- type SomeReflection = WithSomeParameters<WithSomeType<Reflection>>;
62
-
63
- interface SomeTypeViewerProps extends TypographyProps {
64
- opacity?: number;
65
- reflection: SomeReflection;
66
- reflectionViewer: React.FC<ReflectionViewerProps>;
67
- }
68
- declare const SomeTypeViewer: React.FC<SomeTypeViewerProps>;
69
-
70
- declare const ProjectTwoPanelReflectionViewer: React.FC<ContainerReflectionViewerProps<ProjectReflection>>;
71
-
72
- interface SourceViewerProps extends FlexBoxProps {
73
- source: SourceReference;
74
- }
75
- declare const SourceViewer: React.FC<SourceViewerProps>;
76
-
77
- interface ReflectionTreeViewerProps<T extends Reflection = ContainerReflection> extends FlexBoxProps {
78
- hiddenFlags?: FlagFilter[];
79
- lookup?: ReflectionLookup;
80
- reflection: T;
81
- searchTerm?: string;
82
- }
83
- declare const ReflectionTreeViewer: React.FC<ReflectionTreeViewerProps>;
84
-
85
- declare const ReflectionGroupTreeViewer: React.FC<ReflectionGroupViewerProps>;
86
-
87
- declare const TwoPanelReflectionViewer: React.FC<ContainerReflectionViewerProps>;
88
-
89
- export { CommentViewer, ContainerReflectionViewer, DeclarationContainerReflectionViewer, DeclarationReflectionViewer, JsonViewerButton, ProjectReflectionViewer, ProjectTwoPanelReflectionViewer, ReflectionGroupTreeViewer, ReflectionGroupViewer, ReflectionTreeViewer, ReflectionViewer, SomeTypeViewer, SourceViewer, TwoPanelReflectionViewer };
90
- export type { CommentViewerProps, ContainerReflectionViewerProps, DeclarationContainerReflectionViewerProps, FlagFilter, JsonViewerButtonProps, ReflectionGroupViewerProps, ReflectionLookup, ReflectionTreeViewerProps, ReflectionViewerProps, SomeReflection, SomeTypeViewerProps, SourceViewerProps, WithSomeParameters, WithSomeType };
1
+ export * from './CommentViewer.tsx';
2
+ export * from './JsonViewerButton.tsx';
3
+ export * from './ProjectTwoPanelReflectionViewer.tsx';
4
+ export * from './ReflectionLookup.ts';
5
+ export * from './ReflectionViewer/index.ts';
6
+ export * from './SomeReflection.ts';
7
+ export * from './SourceViewer.tsx';
8
+ export * from './TreeViewer/index.ts';
9
+ export * from './TwoPanelReflectionViewer.tsx';
10
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/react-typedoc",
3
- "version": "6.1.3",
3
+ "version": "6.2.0",
4
4
  "description": "Common React library for all XYO projects that use React",
5
5
  "keywords": [
6
6
  "xyo",
@@ -40,12 +40,12 @@
40
40
  "types": "dist/browser/index.d.ts",
41
41
  "dependencies": {
42
42
  "@mui/x-tree-view": "^8.9.0",
43
- "@xylabs/assert": "^4.13.21",
44
- "@xylabs/react-button": "^6.3.13",
45
- "@xylabs/react-flexbox": "^6.3.13",
46
- "@xyo-network/react-payload-raw-info": "^6.1.3",
47
- "react-router-dom": "^7.7.0",
48
- "typedoc": "^0.28.7"
43
+ "@xylabs/assert": "^4.15.0",
44
+ "@xylabs/react-button": "^6.4.0",
45
+ "@xylabs/react-flexbox": "^6.4.0",
46
+ "@xyo-network/react-payload-raw-info": "^6.2.0",
47
+ "react-router-dom": "^7.7.1",
48
+ "typedoc": "^0.28.8"
49
49
  },
50
50
  "devDependencies": {
51
51
  "@emotion/react": "^11.14.0",
@@ -53,13 +53,13 @@
53
53
  "@mui/icons-material": "^7.2.0",
54
54
  "@mui/material": "^7.2.0",
55
55
  "@mui/system": "^7.2.0",
56
- "@storybook/react-vite": "^9.0.17",
56
+ "@storybook/react-vite": "^9.0.18",
57
57
  "@types/react": "^19.1.8",
58
- "@xylabs/ts-scripts-yarn3": "next",
59
- "@xylabs/tsconfig-react": "next",
60
- "react": "^19.1.0",
61
- "react-dom": "^19.1.0",
62
- "storybook": "^9.0.17",
58
+ "@xylabs/ts-scripts-yarn3": "^7.0.1",
59
+ "@xylabs/tsconfig-react": "^7.0.1",
60
+ "react": "^19.1.1",
61
+ "react-dom": "^19.1.1",
62
+ "storybook": "^9.0.18",
63
63
  "typescript": "^5.8.3"
64
64
  },
65
65
  "peerDependencies": {
package/src/global.d.ts CHANGED
@@ -1 +1 @@
1
- import type {} from '@mui/material/themeCssVarsAugmentation'
1
+ import '@mui/material/themeCssVarsAugmentation'