@openpkg-ts/react 0.2.2 → 0.2.4
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 +20 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @openpkg-ts/react
|
|
2
2
|
|
|
3
|
-
React components for rendering OpenPkg API documentation.
|
|
3
|
+
React components for rendering OpenPkg API documentation. Built on `@openpkg-ts/ui`.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -22,7 +22,10 @@ import {
|
|
|
22
22
|
ExampleBlock,
|
|
23
23
|
ExpandableProperty,
|
|
24
24
|
MembersTable,
|
|
25
|
+
MemberRow,
|
|
26
|
+
NestedProperty,
|
|
25
27
|
ParamTable,
|
|
28
|
+
ParamRow,
|
|
26
29
|
Signature,
|
|
27
30
|
TypeTable,
|
|
28
31
|
} from '@openpkg-ts/react';
|
|
@@ -34,7 +37,10 @@ import {
|
|
|
34
37
|
| `ExampleBlock` | Code example display |
|
|
35
38
|
| `ExpandableProperty` | Property with nested children |
|
|
36
39
|
| `MembersTable` | Class/interface members table |
|
|
40
|
+
| `MemberRow` | Single member row |
|
|
41
|
+
| `NestedProperty` | Nested property display |
|
|
37
42
|
| `ParamTable` | Function parameters table |
|
|
43
|
+
| `ParamRow` | Single parameter row |
|
|
38
44
|
| `Signature` | Type signature renderer |
|
|
39
45
|
| `TypeTable` | Type properties table |
|
|
40
46
|
|
|
@@ -126,9 +132,22 @@ import {
|
|
|
126
132
|
specSchemaToAPISchema,
|
|
127
133
|
specExamplesToCodeExamples,
|
|
128
134
|
buildImportStatement,
|
|
135
|
+
getLanguagesFromExamples,
|
|
129
136
|
} from '@openpkg-ts/react/styled';
|
|
130
137
|
```
|
|
131
138
|
|
|
139
|
+
## Headless Utilities
|
|
140
|
+
|
|
141
|
+
```tsx
|
|
142
|
+
import {
|
|
143
|
+
cleanCode,
|
|
144
|
+
getExampleCode,
|
|
145
|
+
getExampleLanguage,
|
|
146
|
+
getExampleTitle,
|
|
147
|
+
groupMembersByKind,
|
|
148
|
+
} from '@openpkg-ts/react';
|
|
149
|
+
```
|
|
150
|
+
|
|
132
151
|
## License
|
|
133
152
|
|
|
134
153
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openpkg-ts/react",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "React components for OpenPkg specs",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"openpkg",
|
|
@@ -41,8 +41,8 @@
|
|
|
41
41
|
"typecheck": "tsc --noEmit"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@openpkg-ts/spec": "^0.
|
|
45
|
-
"@openpkg-ts/sdk": "^0.
|
|
44
|
+
"@openpkg-ts/spec": "^0.32.0",
|
|
45
|
+
"@openpkg-ts/sdk": "^0.32.0",
|
|
46
46
|
"@openpkg-ts/ui": "^0.1.2",
|
|
47
47
|
"lucide-react": "^0.468.0"
|
|
48
48
|
},
|