api-render-ui 1.0.4 → 1.0.5
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.
- package/Readme.md +8 -19
- package/dist/index.d.mts +13 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +1051 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +1024 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +32 -10
- package/scripts/inline-styles.mjs +34 -0
- package/{api-render-ui.css → src/api-render-ui.css} +2 -1
- package/src/api-render-ui.ts +1001 -0
- package/src/index.ts +1 -0
- package/src/inlined-styles.ts +256 -0
- package/tsconfig.json +18 -0
- package/tsup.config.ts +11 -0
- package/api-render-ui.js +0 -871
- package/test.html +0 -1263
package/Readme.md
CHANGED
|
@@ -16,25 +16,14 @@ api-render-ui is a UI library that pursues simple and efficient data rendering f
|
|
|
16
16
|
[![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
|
|
17
17
|
|
|
18
18
|
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
<script>
|
|
29
|
-
const apiRenderer = new ApiRenderer({
|
|
30
|
-
mountPoint: '#apiContainer',
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
const openapiSpec = {...};
|
|
34
|
-
|
|
35
|
-
apiRenderer.render(openapiSpec);
|
|
36
|
-
</script>
|
|
37
|
-
</body>
|
|
19
|
+
```typescript
|
|
20
|
+
import { ApiRenderer } from "api-render-ui"
|
|
21
|
+
|
|
22
|
+
const apiRenderer = new ApiRenderer({
|
|
23
|
+
mountPoint: '#notebook', // 可以是选择器字符串
|
|
24
|
+
});
|
|
25
|
+
// 执行渲染
|
|
26
|
+
apiRenderer.render(openapiSpec);
|
|
38
27
|
```
|
|
39
28
|
|
|
40
29
|
## Installation
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { OpenAPIV3 } from 'openapi-types';
|
|
2
|
+
|
|
3
|
+
type OpenAPIV3CustomDoc = OpenAPIV3.Document & {
|
|
4
|
+
swagger: string;
|
|
5
|
+
};
|
|
6
|
+
declare class ApiRenderer {
|
|
7
|
+
options: any;
|
|
8
|
+
container: any;
|
|
9
|
+
constructor(options: any);
|
|
10
|
+
render(apiSpec: OpenAPIV3CustomDoc, renderUnit?: boolean): void;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export { ApiRenderer };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { OpenAPIV3 } from 'openapi-types';
|
|
2
|
+
|
|
3
|
+
type OpenAPIV3CustomDoc = OpenAPIV3.Document & {
|
|
4
|
+
swagger: string;
|
|
5
|
+
};
|
|
6
|
+
declare class ApiRenderer {
|
|
7
|
+
options: any;
|
|
8
|
+
container: any;
|
|
9
|
+
constructor(options: any);
|
|
10
|
+
render(apiSpec: OpenAPIV3CustomDoc, renderUnit?: boolean): void;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export { ApiRenderer };
|