@scalar/api-reference 1.2.7 → 1.4.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.
Files changed (46) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +11 -3
  3. package/dist/browser/standalone.js +18 -127785
  4. package/dist/components/ApiReference.vue.d.ts +8 -1
  5. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  6. package/dist/components/ApiReferenceBase.vue.d.ts +1 -1
  7. package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -1
  8. package/dist/components/ApiReferenceLayout.vue.d.ts +5 -5
  9. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  10. package/dist/components/ClassicHeader.vue.d.ts +10 -0
  11. package/dist/components/ClassicHeader.vue.d.ts.map +1 -0
  12. package/dist/components/Content/Content.vue.d.ts +2 -0
  13. package/dist/components/Content/Content.vue.d.ts.map +1 -1
  14. package/dist/components/Content/ReferenceEndpoint/RequestBodyProperties.vue.d.ts.map +1 -1
  15. package/dist/components/DarkModeIconToggle.vue.d.ts +3 -0
  16. package/dist/components/DarkModeIconToggle.vue.d.ts.map +1 -0
  17. package/dist/components/DarkModeToggle.vue.d.ts.map +1 -1
  18. package/dist/components/Icon/icons/index.d.ts +1 -1
  19. package/dist/components/Icon/icons/index.d.ts.map +1 -1
  20. package/dist/components/IntersectionObserver.vue.d.ts.map +1 -1
  21. package/dist/components/Layouts/ClassicLayout.vue.d.ts +18 -0
  22. package/dist/components/Layouts/ClassicLayout.vue.d.ts.map +1 -0
  23. package/dist/components/Layouts/ModernLayout.vue.d.ts +18 -0
  24. package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -0
  25. package/dist/components/Layouts/index.d.ts +7 -0
  26. package/dist/components/Layouts/index.d.ts.map +1 -0
  27. package/dist/components/Sidebar.vue.d.ts.map +1 -1
  28. package/dist/helpers/hasModels.d.ts +1 -1
  29. package/dist/helpers/hasModels.d.ts.map +1 -1
  30. package/dist/helpers/index.d.ts +2 -1
  31. package/dist/helpers/index.d.ts.map +1 -1
  32. package/dist/helpers/showItemInClient.d.ts +3 -0
  33. package/dist/helpers/showItemInClient.d.ts.map +1 -0
  34. package/dist/hooks/index.d.ts +1 -0
  35. package/dist/hooks/index.d.ts.map +1 -1
  36. package/dist/hooks/useDarkModeState.d.ts.map +1 -1
  37. package/dist/hooks/useNavigation.d.ts +28 -0
  38. package/dist/hooks/useNavigation.d.ts.map +1 -0
  39. package/dist/{index-f02991b5.js → index-0f5b8a92.js} +11317 -11138
  40. package/dist/{index-53880029.js → index-1eca3167.js} +3 -3
  41. package/dist/index.js +4 -4
  42. package/dist/stores/template.d.ts +0 -9
  43. package/dist/stores/template.d.ts.map +1 -1
  44. package/dist/types.d.ts +13 -1
  45. package/dist/types.d.ts.map +1 -1
  46. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # @scalar/api-reference
2
2
 
3
+ ## 1.4.0
4
+
5
+ ### Minor Changes
6
+
7
+ - b974eeb: feat: swagger UI style layout
8
+
9
+ ### Patch Changes
10
+
11
+ - b65840b: refactor: keep track of the collapsed sidebar items in @scalar/api-reference
12
+ - 95fbc01: fix: hono middleware fails to read configuration.spec.content
13
+ - b65840b: fix: URL doesn’t match the active sidebar item
14
+ - Updated dependencies [b65840b]
15
+ - @scalar/api-client@0.7.37
16
+
17
+ ## 1.3.0
18
+
19
+ ### Minor Changes
20
+
21
+ - 37b974c: feat: expose footer slot on standalone component
22
+
23
+ ### Patch Changes
24
+
25
+ - b77d087: feat: add a customCss property to the configuration object
26
+
3
27
  ## 1.2.7
4
28
 
5
29
  ### Patch Changes
package/README.md CHANGED
@@ -107,12 +107,20 @@ Whether the sidebar should be shown.
107
107
  <ApiReference :configuration="{ showSidebar: true} />
108
108
  ```
109
109
 
110
- #### footerBelowSidebar?: boolean
110
+ ### customCss?: string
111
111
 
112
- Whether the footer should be below the content or below both the content _and_ the sidebar.
112
+ You can pass custom CSS directly to the component. This is helpful for the integrations for Fastify, Express, Hono and others where you it’s easier to add CSS to the configuration.
113
+
114
+ In Vue or React you’d probably use other ways to add custom CSS.
113
115
 
114
116
  ```vue
115
- <ApiReference :configuration="{ footerBelowSidebar: true} />
117
+ <script setup>
118
+ const customCss = `* { font-family: "Comic Sans MS", cursive, sans-serif; }`
119
+ </script>
120
+
121
+ <template>
122
+ <ApiReference :configuration="{ customCss }" />
123
+ </template>
116
124
  ```
117
125
 
118
126
  #### searchHotKey?: string