docusaurus-theme-openapi-docs 0.0.0-1295 → 0.0.0-1310

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.
Files changed (57) hide show
  1. package/lib/theme/ApiExplorer/ApiCodeBlock/Container/index.js +4 -2
  2. package/lib/theme/ApiExplorer/ApiCodeBlock/Content/String.js +9 -6
  3. package/lib/theme/ApiExplorer/ApiCodeBlock/Line/index.d.ts +1 -1
  4. package/lib/theme/ApiExplorer/ApiCodeBlock/index.d.ts +1 -1
  5. package/lib/theme/ApiExplorer/CodeTabs/index.d.ts +1 -1
  6. package/lib/theme/ApiExplorer/CodeTabs/index.js +6 -5
  7. package/lib/theme/ApiTabs/index.d.ts +1 -1
  8. package/lib/theme/ApiTabs/index.js +6 -5
  9. package/lib/theme/DiscriminatorTabs/index.d.ts +1 -1
  10. package/lib/theme/DiscriminatorTabs/index.js +6 -5
  11. package/lib/theme/MimeTabs/index.d.ts +1 -1
  12. package/lib/theme/MimeTabs/index.js +6 -5
  13. package/lib/theme/OperationTabs/index.d.ts +1 -1
  14. package/lib/theme/OperationTabs/index.js +6 -5
  15. package/lib/theme/SchemaTabs/index.d.ts +1 -1
  16. package/lib/theme/SchemaTabs/index.js +6 -5
  17. package/lib/theme/TabItem/index.d.ts +5 -0
  18. package/lib/theme/TabItem/index.js +51 -0
  19. package/lib/theme/TabItem/styles.module.css +3 -0
  20. package/lib/theme/Tabs/index.d.ts +5 -0
  21. package/lib/theme/Tabs/index.js +148 -0
  22. package/lib/theme/Tabs/styles.module.css +7 -0
  23. package/lib/theme/utils/codeBlockUtils.d.ts +28 -0
  24. package/lib/theme/utils/codeBlockUtils.js +223 -0
  25. package/lib/theme/utils/reactUtils.d.ts +1 -0
  26. package/lib/theme/utils/reactUtils.js +23 -0
  27. package/lib/theme/utils/scrollUtils.d.ts +7 -0
  28. package/lib/theme/utils/scrollUtils.js +175 -0
  29. package/lib/theme/utils/tabsUtils.d.ts +47 -0
  30. package/lib/theme/utils/tabsUtils.js +299 -0
  31. package/lib/theme/utils/useCodeWordWrap.d.ts +8 -0
  32. package/lib/theme/utils/useCodeWordWrap.js +84 -0
  33. package/lib/theme/utils/useMutationObserver.d.ts +3 -0
  34. package/lib/theme/utils/useMutationObserver.js +34 -0
  35. package/package.json +4 -4
  36. package/src/theme/ApiExplorer/ApiCodeBlock/Container/index.tsx +2 -1
  37. package/src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx +8 -7
  38. package/src/theme/ApiExplorer/ApiCodeBlock/Line/index.tsx +1 -1
  39. package/src/theme/ApiExplorer/ApiCodeBlock/index.tsx +1 -1
  40. package/src/theme/ApiExplorer/CodeTabs/index.tsx +5 -5
  41. package/src/theme/ApiTabs/index.tsx +7 -6
  42. package/src/theme/DiscriminatorTabs/index.tsx +6 -5
  43. package/src/theme/MimeTabs/index.tsx +9 -8
  44. package/src/theme/OperationTabs/index.tsx +5 -4
  45. package/src/theme/SchemaTabs/index.tsx +6 -5
  46. package/src/theme/TabItem/index.tsx +61 -0
  47. package/src/theme/TabItem/styles.module.css +3 -0
  48. package/src/theme/Tabs/index.tsx +164 -0
  49. package/src/theme/Tabs/styles.module.css +7 -0
  50. package/src/theme/utils/codeBlockUtils.ts +296 -0
  51. package/src/theme/utils/reactUtils.ts +22 -0
  52. package/src/theme/utils/scrollUtils.tsx +153 -0
  53. package/src/theme/utils/tabsUtils.tsx +329 -0
  54. package/src/theme/utils/useCodeWordWrap.ts +110 -0
  55. package/src/theme/utils/useMutationObserver.ts +43 -0
  56. package/src/theme-classic.d.ts +0 -96
  57. package/tsconfig.tsbuildinfo +1 -1
@@ -6,99 +6,3 @@
6
6
  * ========================================================================== */
7
7
 
8
8
  /// <reference types="@docusaurus/theme-classic" />
9
-
10
- declare module "@docusaurus/theme-common/internal" {
11
- import { CSSProperties, ReactNode, RefObject } from "react";
12
-
13
- import type { PropDocContent } from "@docusaurus/plugin-content-docs";
14
- import { MagicCommentConfig } from "@docusaurus/theme-common/lib/utils/codeBlockUtils";
15
- import {
16
- TabsProps as ITabsProps,
17
- TabValue,
18
- } from "@docusaurus/theme-common/lib/utils/tabsUtils";
19
- import { Props as ICodeBlockProps } from "@theme/CodeBlock";
20
- import { Props as ICopyButtonProps } from "@theme/CodeBlock/CopyButton";
21
- import { Props as ILineProps } from "@theme/CodeBlock/Line";
22
- import { PrismTheme } from "prism-react-renderer";
23
-
24
- export interface TabItemProps {
25
- readonly children: ReactNode;
26
- readonly value: string;
27
- readonly default?: boolean;
28
- readonly label?: string;
29
- readonly className?: string;
30
- readonly attributes?: { [key: string]: unknown };
31
- }
32
-
33
- export interface TabProps extends ITabsProps {
34
- length?: number;
35
- }
36
-
37
- export interface CopyButtonProps extends ICopyButtonProps {}
38
- export interface LineProps extends ILineProps {}
39
- export interface CodeBlockProps extends ICodeBlockProps {}
40
-
41
- export function usePrismTheme(): PrismTheme;
42
-
43
- export function sanitizeTabsChildren(children: TabProps["children"]);
44
-
45
- export function getPrismCssVariables(prismTheme: PrismTheme): CSSProperties;
46
-
47
- export function parseCodeBlockTitle(metastring?: string): string;
48
-
49
- export function parseLanguage(className: string): string | undefined;
50
-
51
- export function containsLineNumbers(metastring?: string): boolean;
52
-
53
- export function useScrollPositionBlocker(): {
54
- blockElementScrollPositionUntilNextRender: (el: HTMLElement) => void;
55
- };
56
-
57
- export function DocProvider({
58
- children,
59
- content,
60
- }: {
61
- children: ReactNode;
62
- content: PropDocContent;
63
- });
64
-
65
- export function useTabsContextValue(props: TabProps): {
66
- selectedValue: string;
67
- selectValue: (value: string) => void;
68
- tabValues: readonly TabValue[];
69
- lazy: boolean;
70
- block: boolean;
71
- };
72
-
73
- export function useTabs(): {
74
- selectedValue: string;
75
- selectValue: (value: string) => void;
76
- tabValues: readonly TabValue[];
77
- lazy: boolean;
78
- block: boolean;
79
- };
80
-
81
- export function TabsProvider(props: {
82
- children: ReactNode;
83
- value: ReturnType<typeof useTabsContextValue>;
84
- }): ReactNode;
85
-
86
- export function parseLines(
87
- content: string,
88
- options: {
89
- metastring: string | undefined;
90
- language: string | undefined;
91
- magicComments: MagicCommentConfig[];
92
- }
93
- ): {
94
- lineClassNames: { [lineIndex: number]: string[] };
95
- code: string;
96
- };
97
-
98
- export function useCodeWordWrap(): {
99
- readonly codeBlockRef: RefObject<HTMLPreElement>;
100
- readonly isEnabled: boolean;
101
- readonly isCodeScrollable: boolean;
102
- readonly toggle: () => void;
103
- };
104
- }
@@ -1 +1 @@
1
- {"root":["./src/index.ts","./src/plugin-content-docs.d.ts","./src/postman-code-generators.d.ts","./src/react-magic-dropzone.d.ts","./src/theme-classic.d.ts","./src/theme-openapi.d.ts","./src/types.d.ts","./src/markdown/createDescription.ts","./src/markdown/schema.test.ts","./src/markdown/schema.ts","./src/markdown/utils.test.ts","./src/markdown/utils.ts","./src/theme/translationIds.ts","./src/theme/ApiExplorer/buildPostmanRequest.ts","./src/theme/ApiExplorer/index.tsx","./src/theme/ApiExplorer/persistenceMiddleware.ts","./src/theme/ApiExplorer/storage-utils.ts","./src/theme/ApiExplorer/Accept/index.tsx","./src/theme/ApiExplorer/Accept/slice.ts","./src/theme/ApiExplorer/ApiCodeBlock/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Container/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/Element.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx","./src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExitButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Line/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.tsx","./src/theme/ApiExplorer/Authorization/auth-types.ts","./src/theme/ApiExplorer/Authorization/index.tsx","./src/theme/ApiExplorer/Authorization/slice.ts","./src/theme/ApiExplorer/Body/index.tsx","./src/theme/ApiExplorer/Body/json2xml.d.ts","./src/theme/ApiExplorer/Body/resolveSchemaWithSelections.ts","./src/theme/ApiExplorer/Body/slice.ts","./src/theme/ApiExplorer/Body/FileArrayFormBodyItem/index.tsx","./src/theme/ApiExplorer/Body/FormBodyItem/index.tsx","./src/theme/ApiExplorer/CodeSnippets/code-snippets-types.ts","./src/theme/ApiExplorer/CodeSnippets/index.tsx","./src/theme/ApiExplorer/CodeSnippets/languages.test.ts","./src/theme/ApiExplorer/CodeSnippets/languages.ts","./src/theme/ApiExplorer/CodeTabs/index.tsx","./src/theme/ApiExplorer/ContentType/index.tsx","./src/theme/ApiExplorer/ContentType/slice.ts","./src/theme/ApiExplorer/EncodingSelection/slice.ts","./src/theme/ApiExplorer/EncodingSelection/useResolvedEncoding.ts","./src/theme/ApiExplorer/Export/index.tsx","./src/theme/ApiExplorer/FloatingButton/index.tsx","./src/theme/ApiExplorer/FormFileUpload/index.tsx","./src/theme/ApiExplorer/FormItem/index.tsx","./src/theme/ApiExplorer/FormLabel/index.tsx","./src/theme/ApiExplorer/FormMultiSelect/index.tsx","./src/theme/ApiExplorer/FormSelect/index.tsx","./src/theme/ApiExplorer/FormTextInput/index.tsx","./src/theme/ApiExplorer/LiveEditor/index.tsx","./src/theme/ApiExplorer/MethodEndpoint/index.tsx","./src/theme/ApiExplorer/ParamOptions/index.tsx","./src/theme/ApiExplorer/ParamOptions/slice.ts","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx","./src/theme/ApiExplorer/Request/index.tsx","./src/theme/ApiExplorer/Request/makeRequest.ts","./src/theme/ApiExplorer/Response/index.tsx","./src/theme/ApiExplorer/Response/slice.ts","./src/theme/ApiExplorer/SchemaSelection/index.ts","./src/theme/ApiExplorer/SchemaSelection/slice.ts","./src/theme/ApiExplorer/SecuritySchemes/index.tsx","./src/theme/ApiExplorer/Server/index.tsx","./src/theme/ApiExplorer/Server/slice.ts","./src/theme/ApiItem/hooks.ts","./src/theme/ApiItem/index.tsx","./src/theme/ApiItem/store.ts","./src/theme/ApiItem/Layout/index.tsx","./src/theme/ApiLogo/index.tsx","./src/theme/ApiTabs/index.tsx","./src/theme/ArrayBrackets/index.tsx","./src/theme/CodeSamples/index.tsx","./src/theme/DiscriminatorTabs/index.tsx","./src/theme/Example/index.tsx","./src/theme/Markdown/index.d.ts","./src/theme/MimeTabs/index.tsx","./src/theme/OperationTabs/index.tsx","./src/theme/ParamsDetails/index.tsx","./src/theme/ParamsItem/index.tsx","./src/theme/RequestSchema/index.tsx","./src/theme/ResponseExamples/index.tsx","./src/theme/ResponseHeaders/index.tsx","./src/theme/ResponseSchema/index.tsx","./src/theme/Schema/index.tsx","./src/theme/SchemaExpansion/context.tsx","./src/theme/SchemaExpansion/index.tsx","./src/theme/SchemaItem/index.tsx","./src/theme/SchemaTabs/index.tsx","./src/theme/SkeletonLoader/index.tsx","./src/theme/StatusCodes/index.tsx"],"version":"5.9.3"}
1
+ {"root":["./src/index.ts","./src/plugin-content-docs.d.ts","./src/postman-code-generators.d.ts","./src/react-magic-dropzone.d.ts","./src/theme-classic.d.ts","./src/theme-openapi.d.ts","./src/types.d.ts","./src/markdown/createDescription.ts","./src/markdown/schema.test.ts","./src/markdown/schema.ts","./src/markdown/utils.test.ts","./src/markdown/utils.ts","./src/theme/translationIds.ts","./src/theme/ApiExplorer/buildPostmanRequest.ts","./src/theme/ApiExplorer/index.tsx","./src/theme/ApiExplorer/persistenceMiddleware.ts","./src/theme/ApiExplorer/storage-utils.ts","./src/theme/ApiExplorer/Accept/index.tsx","./src/theme/ApiExplorer/Accept/slice.ts","./src/theme/ApiExplorer/ApiCodeBlock/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Container/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/Element.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx","./src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExitButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Line/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.tsx","./src/theme/ApiExplorer/Authorization/auth-types.ts","./src/theme/ApiExplorer/Authorization/index.tsx","./src/theme/ApiExplorer/Authorization/slice.ts","./src/theme/ApiExplorer/Body/index.tsx","./src/theme/ApiExplorer/Body/json2xml.d.ts","./src/theme/ApiExplorer/Body/resolveSchemaWithSelections.ts","./src/theme/ApiExplorer/Body/slice.ts","./src/theme/ApiExplorer/Body/FileArrayFormBodyItem/index.tsx","./src/theme/ApiExplorer/Body/FormBodyItem/index.tsx","./src/theme/ApiExplorer/CodeSnippets/code-snippets-types.ts","./src/theme/ApiExplorer/CodeSnippets/index.tsx","./src/theme/ApiExplorer/CodeSnippets/languages.test.ts","./src/theme/ApiExplorer/CodeSnippets/languages.ts","./src/theme/ApiExplorer/CodeTabs/index.tsx","./src/theme/ApiExplorer/ContentType/index.tsx","./src/theme/ApiExplorer/ContentType/slice.ts","./src/theme/ApiExplorer/EncodingSelection/slice.ts","./src/theme/ApiExplorer/EncodingSelection/useResolvedEncoding.ts","./src/theme/ApiExplorer/Export/index.tsx","./src/theme/ApiExplorer/FloatingButton/index.tsx","./src/theme/ApiExplorer/FormFileUpload/index.tsx","./src/theme/ApiExplorer/FormItem/index.tsx","./src/theme/ApiExplorer/FormLabel/index.tsx","./src/theme/ApiExplorer/FormMultiSelect/index.tsx","./src/theme/ApiExplorer/FormSelect/index.tsx","./src/theme/ApiExplorer/FormTextInput/index.tsx","./src/theme/ApiExplorer/LiveEditor/index.tsx","./src/theme/ApiExplorer/MethodEndpoint/index.tsx","./src/theme/ApiExplorer/ParamOptions/index.tsx","./src/theme/ApiExplorer/ParamOptions/slice.ts","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx","./src/theme/ApiExplorer/Request/index.tsx","./src/theme/ApiExplorer/Request/makeRequest.ts","./src/theme/ApiExplorer/Response/index.tsx","./src/theme/ApiExplorer/Response/slice.ts","./src/theme/ApiExplorer/SchemaSelection/index.ts","./src/theme/ApiExplorer/SchemaSelection/slice.ts","./src/theme/ApiExplorer/SecuritySchemes/index.tsx","./src/theme/ApiExplorer/Server/index.tsx","./src/theme/ApiExplorer/Server/slice.ts","./src/theme/ApiItem/hooks.ts","./src/theme/ApiItem/index.tsx","./src/theme/ApiItem/store.ts","./src/theme/ApiItem/Layout/index.tsx","./src/theme/ApiLogo/index.tsx","./src/theme/ApiTabs/index.tsx","./src/theme/ArrayBrackets/index.tsx","./src/theme/CodeSamples/index.tsx","./src/theme/DiscriminatorTabs/index.tsx","./src/theme/Example/index.tsx","./src/theme/Markdown/index.d.ts","./src/theme/MimeTabs/index.tsx","./src/theme/OperationTabs/index.tsx","./src/theme/ParamsDetails/index.tsx","./src/theme/ParamsItem/index.tsx","./src/theme/RequestSchema/index.tsx","./src/theme/ResponseExamples/index.tsx","./src/theme/ResponseHeaders/index.tsx","./src/theme/ResponseSchema/index.tsx","./src/theme/Schema/index.tsx","./src/theme/SchemaExpansion/context.tsx","./src/theme/SchemaExpansion/index.tsx","./src/theme/SchemaItem/index.tsx","./src/theme/SchemaTabs/index.tsx","./src/theme/SkeletonLoader/index.tsx","./src/theme/StatusCodes/index.tsx","./src/theme/TabItem/index.tsx","./src/theme/Tabs/index.tsx","./src/theme/utils/codeBlockUtils.ts","./src/theme/utils/reactUtils.ts","./src/theme/utils/scrollUtils.tsx","./src/theme/utils/tabsUtils.tsx","./src/theme/utils/useCodeWordWrap.ts","./src/theme/utils/useMutationObserver.ts"],"version":"5.9.3"}