@scalar/api-reference 0.6.15 → 0.6.16

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scalar/api-reference
 
+## 0.6.16
+
+### Patch Changes
+
+- 0f87c35d: feat: add dark mode toggle 👀
+- 3dd2574d: sidebar toggle not flex aligned + fix folder colors
+- Updated dependencies [30aee7d1]
+- Updated dependencies [99744358]
+- Updated dependencies [24deb723]
+- Updated dependencies [3dd2574d]
+  - @scalar/api-client@0.7.12
+  - @scalar/swagger-editor@0.6.14
+
 ## 0.6.15
 
 ### Patch Changes

package/README.md

@@ -23,28 +23,74 @@ import { ApiReference } from '@scalar/api-reference'
 </template>
 ```
 
+You can even [mount the component in React](https://github.com/scalar/scalar/blob/main/projects/react/src/App.tsx).
+
 ## Props
 
-### isEditable?: boolean
+#### isEditable?: boolean
+
+Whether the Swagger editor should be shown.
 
 ```vue
 <ApiReference :isEditable="true" />
 ```
 
-### spec?: string
+#### spec?: string
+
+Directly pass an OpenAPI/Swagger spec.
 
 ```vue
-<ApiReference spec="{ … }" />
+<ApiReference :spec="{ … }" />
 ```
 
-### specUrl?: string
+#### specUrl?: string
+
+Pass the URL of a spec file (JSON or Yaml).
 
 ```vue
 <ApiReference specUrl="/swagger.json" />
 ```
 
-### theme?: 'alternate' | 'default' | 'moon' | 'purple' | 'solarized'
+#### transformedSpec?: string
+
+You can preprocess specs with `@scalar/swagger-parser` and directly pass the result.
+
+```vue
+<ApiReference :specResult="{ … }" />
+```
+
+#### proxyUrl?: string
+
+Making requests to other domains is restricted in the browser and requires [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS). It’s recommended to use a proxy to send requests to other origins.
+
+```vue
+<ApiReference proxyUrl="https://proxy.example.com" />
+```
+
+ℹ️ You can use [@scalar/api-client-proxy](https://github.com/scalar/scalar/tree/main/packages/api-client-proxy) to host your own proxy.
+
+#### initialTabState?: string
+
+You can decide which tab should be active by default:
+
+```vue
+<ApiReference initialTabState="Getting Started" />
+<!-- or -->
+<ApiReference initialTabState="Swagger Editor" />
+```
+
+#### showSidebar?: boolean
+
+Whether the sidebar should be shown.
+
+```vue
+<ApiReference :showSidebar="true" />
+```
+
+#### footerBelowSidebar?: boolean
+
+Whether the footer should below the content or below the content _and_ the sidebar.
 
 ```vue
-<ApiReference theme="moon" />
+<ApiReference :footerBelowSidebar="true" />
 ```