Merge branch 'defaultExpandDepth' of https://github.com/jy95/docusaurus-json-schema-plugin into defaultExpandDepth

Author: jy95

src/theme/JSONSchemaViewer/components/SchemaItem/SchemaItem.tsx

@@ -41,8 +41,9 @@ export default function SchemaItem({
   const { defaultExpandDepth } = useJSVOptionsContext()
 
   // Determine if Collapsible should be open or closed by default
-  const isOpenByDefault = level < (defaultExpandDepth ?? 0)
-
+  // Depth is measured from root (root level = 0). Clamp negatives to 0.
+  const expandDepth = defaultExpandDepth ?? 0;
+  const isOpenByDefault = level <= expandDepth
   // Notice : "deprecated" started at 2019-09
   let typedSchema = schema as JSONSchema_Draft_2019_09
   let isDeprecated =

src/theme/JSONSchemaViewer/contexts/jsvOptions.tsx

@@ -39,8 +39,13 @@ export type JSVOptions = {
    */
   UnresolvedRefsComponent?: (params: { schema: JSONSchema }) => JSX.Element
   /**
-   * Defines how deep the schema should be expanded by default.
-   * @default 0 No expansion at all (only root level expanded)
+   * Defines how deep the schema should be expanded by default
+   * Examples:
+   *  - 0: only the root level is expanded
+   *  - 1: root level and its direct children are expanded
+   *  - Infinity: expand all levels
+   * @default 0
+   * @min 0
    */
   defaultExpandDepth?: number
 }

testsite/docs/demo-viewer/custom/defaultExpandDepth.mdx

@@ -0,0 +1,34 @@
+---
+description: Defines how deep the schema should be expanded by default
+title: "📏 Custom defaultExpandDepth"
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import Schema from "@site/static/schemas/examples/custom/defaultExpandDepth.json";
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import ReactMarkdown from 'react-markdown'
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Custom defaultExpandDepth
+
+<Tabs>
+    <TabItem value="Viewer" label="Viewer" default>
+        <JSONSchemaViewer 
+            schema={ Schema } 
+            viewerOptions={{ 
+                defaultExpandDepth: Infinity 
+            }}
+        />
+    </TabItem>
+    <TabItem value="viewerOptions" label='viewerOptions'>
+        ```js
+        {
+            defaultExpandDepth: Infinity
+        }
+        ```
+    </TabItem>
+    <TabItem value="JSON Schema" label='JSON Schema'>
+        <CodeBlock language="json-schema">{JSON.stringify(Schema, null, 2)}</CodeBlock>
+    </TabItem>
+</Tabs>

testsite/static/schemas/examples/custom/defaultExpandDepth.json

@@ -0,0 +1,24 @@
+{
+  "type": "object",
+  "properties": {
+    "level1_prop1": {
+      "type": "string"
+    },
+    "level1_prop2": {
+      "type": "object",
+      "properties": {
+        "level2_prop1": {
+          "type": "integer"
+        },
+        "level2_prop2": {
+          "type": "object",
+          "properties": {
+            "level3_prop1": {
+              "type": "boolean"
+            }
+          }
+        }
+      }
+    }
+  }
+}