@scalar/api-reference 0.1.1 → 0.1.3

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 (36) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/dist/components/ApiReference.vue.d.ts +8 -5
  3. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  4. package/dist/components/Content/MarkdownRenderer.vue.d.ts.map +1 -1
  5. package/dist/components/Content/ReferenceEndpoint/ExampleRequest.vue.d.ts.map +1 -1
  6. package/dist/components/FlowIconButton.vue.d.ts +8 -8
  7. package/dist/components/FlowLoader.vue.d.ts +4 -4
  8. package/dist/components/SidebarElement.vue.d.ts +2 -2
  9. package/dist/index-ad012ba6.js +59729 -0
  10. package/dist/index.js +98910 -6
  11. package/dist/style.css +1499 -3773
  12. package/dist/types.d.ts +2 -2
  13. package/dist/types.d.ts.map +1 -1
  14. package/dist/variables.css +132 -0
  15. package/package.json +7 -7
  16. package/src/assets/css/variables.css +77 -9
  17. package/src/components/ApiClientModal.vue +4 -4
  18. package/src/components/ApiReference.vue +25 -61
  19. package/src/components/Card/Card.vue +2 -2
  20. package/src/components/Card/CardContent.vue +1 -1
  21. package/src/components/Card/CardFooter.vue +1 -1
  22. package/src/components/Content/Content.vue +2 -2
  23. package/src/components/Content/Introduction/BaseUrl.vue +1 -1
  24. package/src/components/Content/Introduction/Introduction.vue +4 -3
  25. package/src/components/Content/Introduction/LanguageSelector.vue +1 -1
  26. package/src/components/Content/MarkdownRenderer.vue +15 -7
  27. package/src/components/Content/ReferenceEndpoint/ExampleRequest.vue +11 -9
  28. package/src/components/Content/ReferenceEndpoint/ExampleResponses.vue +1 -1
  29. package/src/components/Content/ReferenceEndpoint/RequestBody.vue +4 -4
  30. package/src/components/FindAnythingButton.vue +2 -4
  31. package/src/components/FlowButton.vue +2 -2
  32. package/src/components/Sidebar.vue +1 -1
  33. package/src/types.ts +2 -2
  34. package/vite.config.ts +11 -1
  35. package/dist/index-14a526d0.js +0 -61730
  36. package/dist/index-ffa2c382.js +0 -34107
@@ -76,6 +76,14 @@ watch(
76
76
  margin: 12px 0;
77
77
  }
78
78
 
79
+ .markdown :deep(ul) {
80
+ list-style: disc;
81
+ }
82
+
83
+ .markdown :deep(ol) {
84
+ list-style: decimal;
85
+ }
86
+
79
87
  .markdown :deep(ul.contains-task-list) {
80
88
  list-style: none;
81
89
  padding-left: 0;
@@ -86,9 +94,9 @@ watch(
86
94
  }
87
95
 
88
96
  .markdown :deep(code) {
89
- font-family: var(--scalar-api-reference-theme-font-code);
97
+ font-family: var(--scalar-api-reference-font-mono);
90
98
  background-color: var(--scalar-api-reference-theme-background-2);
91
- box-shadow: 0 0 0 1px var(--scalar-api-reference-theme-border-color);
99
+ box-shadow: 0 0 0 1px var(--scalar-api-reference-border-color);
92
100
  font-size: var(--scalar-api-reference-theme-mini);
93
101
  border-radius: 2px;
94
102
  padding: 0 3px;
@@ -106,7 +114,7 @@ watch(
106
114
  }
107
115
 
108
116
  .markdown :deep(blockquote) {
109
- border-left: 3px solid var(--scalar-api-reference-theme-border-color);
117
+ border-left: 3px solid var(--scalar-api-reference-border-color);
110
118
  padding-left: 12px;
111
119
  }
112
120
 
@@ -117,8 +125,8 @@ watch(
117
125
  width: 100%;
118
126
  margin: 0;
119
127
  overflow: hidden;
120
- box-shadow: 0 0 0 1px var(--scalar-api-reference-theme-border-color);
121
- border-radius: var(--scalar-api-reference-theme-radius);
128
+ box-shadow: 0 0 0 1px var(--scalar-api-reference-border-color);
129
+ border-radius: var(--scalar-api-reference-rounded);
122
130
  }
123
131
 
124
132
  .markdown :deep(td),
@@ -129,8 +137,8 @@ watch(
129
137
  box-sizing: border-box;
130
138
  position: relative;
131
139
  word-break: break-all;
132
- border-right: var(--scalar-api-reference-theme-border);
133
- border-bottom: var(--scalar-api-reference-theme-border);
140
+ border-right: var(--scalar-api-reference-border);
141
+ border-bottom: var(--scalar-api-reference-border);
134
142
  }
135
143
 
136
144
  .markdown :deep(td > *),
@@ -268,7 +268,7 @@ const availableLanguages = computed(() => {
268
268
  .language-select {
269
269
  position: relative;
270
270
  padding-right: 9px;
271
- border-right: 1px solid var(--scalar-api-reference-theme-border-color);
271
+ border-right: 1px solid var(--scalar-api-reference-border-color);
272
272
  }
273
273
  .language-select select {
274
274
  border: none;
@@ -317,13 +317,15 @@ const availableLanguages = computed(() => {
317
317
  margin-left: 6px;
318
318
  border: none;
319
319
  border-radius: 3px;
320
- &:hover {
321
- color: var(--scalar-api-reference-theme-color-1);
322
- }
323
- svg {
324
- width: 13px;
325
- height: 13px;
326
- }
320
+ }
321
+
322
+ .copy-button:hover {
323
+ color: var(--scalar-api-reference-theme-color-1);
324
+ }
325
+
326
+ .copy-button svg {
327
+ width: 13px;
328
+ height: 13px;
327
329
  }
328
330
 
329
331
  .show-api-client-button {
@@ -332,7 +334,7 @@ const availableLanguages = computed(() => {
332
334
  appearance: none;
333
335
  outline: none;
334
336
  border: none;
335
- border-radius: var(--scalar-api-reference-theme-radius-lg);
337
+ border-radius: var(--scalar-api-reference-rounded-lg);
336
338
  height: 35px;
337
339
  display: flex;
338
340
  justify-content: center;
@@ -124,7 +124,7 @@ watch(selectedResponseIndex, () => {
124
124
  font-size: var(--scalar-api-reference-theme-mini);
125
125
  }
126
126
  .scalar-api-reference__empty-state {
127
- border: 1px dashed var(--scalar-api-reference-theme-border-color);
127
+ border: 1px dashed var(--scalar-api-reference-border-color);
128
128
  width: 100%;
129
129
  text-align: center;
130
130
  font-size: var(--scalar-api-reference-theme-mini);
@@ -30,7 +30,7 @@ defineProps<{ requestBody?: RequestBody }>()
30
30
  margin-top: 6px;
31
31
  }
32
32
  .parameter .parameter-child {
33
- border: var(--scalar-api-reference-theme-border);
33
+ border: var(--scalar-api-reference-border);
34
34
  border-radius: 20px;
35
35
  margin-top: 12px;
36
36
  width: fit-content;
@@ -85,7 +85,7 @@ defineProps<{ requestBody?: RequestBody }>()
85
85
  transform: rotate(45deg);
86
86
  }
87
87
  .parameter-child__open > .parameter-child-trigger {
88
- border-bottom: var(--scalar-api-reference-theme-border);
88
+ border-bottom: var(--scalar-api-reference-border);
89
89
  }
90
90
 
91
91
  .parameter {
@@ -93,13 +93,13 @@ defineProps<{ requestBody?: RequestBody }>()
93
93
  font-size: var(--scalar-api-reference-theme-small);
94
94
  }
95
95
  .parameter li {
96
- border-top: var(--scalar-api-reference-theme-border);
96
+ border-top: var(--scalar-api-reference-border);
97
97
  padding: 12px 0;
98
98
  }
99
99
  .parameter-name {
100
100
  font-weight: 500;
101
101
  margin-right: 6px;
102
- font-family: var(--scalar-api-reference-theme-font-code);
102
+ font-family: var(--scalar-api-reference-font-mono);
103
103
  font-size: 13px;
104
104
  color: var(--scalar-api-reference-theme-color-1);
105
105
  }
@@ -27,11 +27,9 @@ import FlowIcon from './Icon/FlowIcon.vue'
27
27
  padding: 0 12px;
28
28
 
29
29
  color: var(--scalar-api-reference-theme-color-3);
30
- border: none;
31
30
  outline: none;
32
- border-radius: var(--scalar-api-reference-theme-radius);
33
- /* prettier-ignore */
34
- box-shadow: 0 0 0 1px var(--scalar-api-reference-sidebar-border-color, var(--scalar-api-reference-theme-border-color));
31
+ border-radius: var(--scalar-api-reference-rounded);
32
+ border: var(--scalar-api-reference-border);
35
33
  /* prettier-ignore */
36
34
  background: var(--scalar-api-reference-sidebar-search-background, var(--scalar-api-reference-theme-background-1));
37
35
  cursor: pointer;
@@ -53,7 +53,7 @@ export { useLoadButtonState }
53
53
  -webkit-appearance: none;
54
54
  height: 40px;
55
55
  padding: 0px 24px;
56
- border-radius: var(--scalar-api-reference-theme-radius);
56
+ border-radius: var(--scalar-api-reference-rounded);
57
57
  color: var(--scalar-api-reference-theme-button-1-color);
58
58
  font-size: var(--scalar-api-reference-theme-font-size-4);
59
59
  font-weight: 500;
@@ -90,7 +90,7 @@ export { useLoadButtonState }
90
90
  background: var(--scalar-api-reference-theme-background-1);
91
91
  color: var(--scalar-api-reference-theme-color-1);
92
92
  padding: 11px 23px;
93
- border: var(--scalar-api-reference-theme-border);
93
+ border: var(--scalar-api-reference-border);
94
94
  box-shadow: rgba(0, 0, 0, 0.09) 0px 1px 4px;
95
95
  }
96
96
  .flow-button-outlined:hover,
@@ -134,7 +134,7 @@ const {
134
134
  position: relative;
135
135
  cursor: pointer;
136
136
  /* prettier-ignore */
137
- border-radius: 0 var(--scalar-api-reference-theme-radius) var(--scalar-api-reference-theme-radius) 0;
137
+ border-radius: 0 var(--scalar-api-reference-rounded) var(--scalar-api-reference-rounded) 0;
138
138
  flex: 1;
139
139
  padding-right: 12px;
140
140
  user-select: none;
package/src/types.ts CHANGED
@@ -2,8 +2,8 @@ export type ReferenceProps = {
2
2
  documentName?: string
3
3
  token?: string
4
4
  username?: string
5
- isEditable: boolean
6
- showSidebar: boolean
5
+ isEditable?: boolean
6
+ showSidebar?: boolean
7
7
  footerBelowSidebar?: boolean
8
8
  }
9
9
 
package/vite.config.ts CHANGED
@@ -4,15 +4,25 @@ import { defineConfig } from 'vite'
4
4
  export default defineConfig({
5
5
  plugins: [vue()],
6
6
  build: {
7
+ cssCodeSplit: true,
7
8
  minify: false,
8
9
  lib: {
9
- entry: 'src/index.ts',
10
+ entry: ['src/index.ts', 'src/assets/css/variables.css'],
10
11
  name: '@scalar/api-reference',
11
12
  fileName: 'index',
12
13
  formats: ['es'],
13
14
  },
14
15
  rollupOptions: {
15
16
  external: ['vue'],
17
+ output: {
18
+ assetFileNames: (assetInfo) => {
19
+ if (assetInfo.name === 'index.css') {
20
+ return 'style.css'
21
+ }
22
+
23
+ return assetInfo.name ?? 'default'
24
+ },
25
+ },
16
26
  },
17
27
  },
18
28
  })